CTNeat API ES_rel_1.0

REST API CTNEAT

Introducción a la API

En esta documentación se detalla el uso de la REST API para acceder y manipular los datos del sistema de CTIncoming y CTShelf. La API proporciona una forma programática de interactuar con el sistema y automatizar tareas comunes.

Se describen todas las funciones disponibles en la API, junto con sus parámetros y ejemplos de uso. Cada función de la API está diseñada para realizar una tarea específica, como la creación de un nuevo componente, la modificación de un pedido existente o la lectura de un BOM.

La API se basa en la arquitectura REST, lo que significa que utiliza solicitudes HTTP estándar para comunicarse con el sistema. Los datos se transmiten en formato JSON, lo que permite una fácil integración con otras herramientas y sistemas.

En resumen, la API proporciona una interfaz programática para acceder y manipular los datos del sistema. En esta documentación se detallan todas las funciones disponibles, junto con ejemplos de uso, para ayudar a los desarrolladores a integrar la API en sus aplicaciones y automatizar tareas.

Autenticación

Autenticación

LOG IN

Para autenticar a un usuario, la API generará un token de autenticación que será necesario para acceder a cada una de sus funciones. Este token tendrá una duración máxima de 60 segundos sin uso, tras lo cual será necesario generar uno nuevo para continuar utilizando la API.

URL

https://[server]/CTNEAT/LOGIN/{user}/{psw}

Método HTTP

GET

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio
user cadena nombre del usuario con el que se quiere hacer el log in Sí
psw cadena contraseña del usuario Sí

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio

Cuerpo de la solicitud

No se requiere un cuerpo de solicitud para este método HTTP.

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro
tkn.val cadena Token de autenticación

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/CTNEAT/LOGIN/CTNEAT/1234

Ejemplo de respuesta

{ "val":"F7C9403161C67E8675AC1CE8C583CCA4BDF4C5A76408C433AA9284625FF5207D" }
Autenticación

LOG OUT

Esta función permite dar de baja el token de autenticación asociado al usuario, lo que impide que se utilice para acceder a las funciones de la API y garantiza la seguridad de la información. De este modo, se evita el acceso no autorizado a la API y se asegura la protección de los datos del usuario

URL

https://[server]/CTNEAT/LOGOUT/{tkn}

Método HTTP

PUT

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio
tkn cadena Token de autenticación Sí

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio

Cuerpo de la solicitud

No se requiere un cuerpo de solicitud para este método HTTP.

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro Formato
ErrorContent JSON Json con la descripción del resultado de la operación Formato ErrorContent

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/CTNEAT/LOGOUT/F7C9403161C67E8675AC1CE8C583CCA4BDF4C5A76408C433AA9284625FF5207D

Ejemplo de respuesta

{ "Success":{ "faultcode":"none", "faultstring":"user logged out", "detail":"" } }

Artículos

Artículos

Añadir artículos

Con esta función, es posible llevar a cabo la creación de códigos internos, los cuales se utilizan como referencias de componente dentro del sistema.

URL

/CTNEAT/ITEM/ADD/{tkn}

Método HTTP

POST

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Posibles valores
ITEMCODE cadena Código interno del artículo Sí Cualquiera
DESCRIPTION cadena Descripción del artículo No Cualquiera
CODETYPE cadena Código del formato del artículo Sí Ver posibles valores

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio
Content-Type Tipo de contenido de la solicitud Sí

Cuerpo de la solicitud

Formato del cuerpo de la solicitud: application/json

Descripción del cuerpo de la solicitud:

{ 
  "ITEMCODE":"CODIGO_PN",
  "DESCRIPTION":"DESCRIPCION_CODIGO_PN",
  "CODETYPE":"CODETYPE"
}

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro Formato
ErrorContent JSON Json con la descripción del resultado de la operación Formato ErrorContent

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/CTNEAT/ITEM/ADD/6A201F1F5147079FF9CA80DCDBB032AB386905091BC973B53F50E6493EC53868

{ 
  "ITEMCODE":"CODIGO_PN",
  "DESCRIPTION":"DESCRIPCION_CODIGO_PN",
  "CODETYPE":2
}

Ejemplo de respuesta

{ "Success":true, "fault":{ "faultcode":"none", "faultstring":"Item code added", "detail":"Item code: CODIGO_PN successfully added" } }
Artículos

Modificar artículos

Mediante esta función, se puede llevar a cabo la modificación de un componente en el sistema. Es importante tener en cuenta que únicamente se pueden modificar la descripción y el formato del código de artículo, pero no el código del componente en sí.

URL

/CTNEAT/ITEM/MODIF/{tkn}

Método HTTP

PUT

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Posibles valores
ITEMCODE cadena Código interno del artículo Sí Cualquiera
DESCRIPTION cadena Descripción del artículo No Cualquiera
CODETYPE numérico Código del formato del artículo Sí Ver posibles valores

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio
Content-Type Tipo de contenido de la solicitud Sí

Cuerpo de la solicitud

Formato del cuerpo de la solicitud: application/json

Descripción del cuerpo de la solicitud:

{ 
  "ITEMCODE":"CODIGO_PN",
  "DESCRIPTION":"DESCRIPCION_CODIGO_PN",
  "CODETYPE":"CODETYPE"
}

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro Formato
ErrorContent JSON Json con la descripción del resultado de la operación Formato ErrorContent

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/CTNEAT/ITEM/MODIF/6A201F1F5147079FF9CA80DCDBB032AB386905091BC973B53F50E6493EC53868

{ 
  "ITEMCODE":"CODIGO_PN",
  "DESCRIPTION":"MODIF_DESCRIPCION_CODIGO_PN",
  "CODETYPE":2
}

Ejemplo de respuesta

{ "Success":true, "fault":{ "faultcode":"none", "faultstring":"Item code modified", "detail":"Item code: CODIGO_PN successfully modified" } }
Artículos

Leer artículos

Con esta función, se tiene la capacidad de leer los componentes que han sido registrados en el sistema. Es importante destacar que se puede proporcionar el código del artículo que se desea leer a través de un argumento de URL query. En caso de no especificar este código, se llevará a cabo la lectura de todos los componentes del sistema.

URL

/CTNEAT/ITEM/READ/{tkn}

Método HTTP

GET

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Posibles valores
ITEMCODE cadena Código interno del artículo No (Si el código de artículo no se especifica, la API devolverá todos los artículos del sistema) Cualquiera

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio

Cuerpo de la solicitud

No se requiere un cuerpo de solicitud para este método HTTP.

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro
Result JSON Json con la descripción del resultado de la operación
Elementos de Result

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/ITEM/READ/693DDFEC2F4BFDDEAF04DD2724984C9B3CA89D553DD8E5B9BB233AD6BB6075F1?ITEMCODE=CODIGO_PN

Ejemplo de respuesta

{ 
  "NRecords":1, 
  "Data":[ 
    { 
      "ItemCode":"CODIGO_PN", 
      "Description":"MODIF_DESCRIPCION_CODIGO_PN", 
      "Type":"REEL", 
      "Format":"H08S", 
      "QTY":0, 
      "ActCont":0 
    } 
  ] 
}

Part number fabricante y part number proveedor

Part number fabricante y part number proveedor

Añadir part number fabricante

Con esta función es posible agregar una relación entre el Part Number del fabricante y el código interno del componente en el sistema.

URL

/CTNEAT/PN/ADD/{tkn}

Método HTTP

POST

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Posibles valores
ITEMCODE cadena Código interno del artículo Sí Cualquiera
PNCODE cadena Código part number del fabricante Sí Cualquiera
CODETYPE numérico Código del formato del artículo relacionado con este fabricante Sí Ver posibles valores

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio
Content-Type Tipo de contenido de la solicitud Sí

Cuerpo de la solicitud

Formato del cuerpo de la solicitud: application/json

Descripción del cuerpo de la solicitud:

{ 
  "ITEMCODE":"CODIGO_PN_INTERNO",
  "PNCODE":"CODIGO_PN_FABRICANTE",
  "CODETYPE":"CODETYPE"
}

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro Formato
ErrorContent JSON Json con la descripción del resultado de la operación Formato ErrorContent

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/CTNEAT/PN/ADD/6A201F1F5147079FF9CA80DCDBB032AB386905091BC973B53F50E6493EC53868

{ 
  "ITEMCODE":"CODIGO_PN",
  "PNCODE":"CODIGO_PN_FABRICANTE",
  "CODETYPE":2
}

Ejemplo de respuesta

{ "Success":true, "fault":{ "faultcode":"none", "faultstring":"Relation added", "detail":"Relation successfully added" } }
Part number fabricante y part number proveedor

Añadir part number proveedor

Con esta función es posible agregar una relación entre el Part Number del proveedor y el código interno del componente en el sistema.

URL

/CTNEAT/SPN/ADD/{tkn}

Método HTTP

POST

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Posibles valores
ITEMCODE cadena Código interno del artículo Sí Cualquiera
SPNCODE cadena Código part number del proveedor Sí Cualquiera
CODETYPE numérico Código del formato del artículo relacionado con este fabricante Sí Ver posibles valores

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio
Content-Type Tipo de contenido de la solicitud Sí

Cuerpo de la solicitud

Formato del cuerpo de la solicitud: application/json

Descripción del cuerpo de la solicitud:

{ 
  "ITEMCODE":"CODIGO_PN_INTERNO",
  "SPNCODE":"CODIGO_PN_PROVEEDOR",
  "CODETYPE":"CODETYPE"
}

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro Formato
ErrorContent JSON Json con la descripción del resultado de la operación Formato ErrorContent

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/CTNEAT/SPN/ADD/6A201F1F5147079FF9CA80DCDBB032AB386905091BC973B53F50E6493EC53868

{ 
  "ITEMCODE":"CODIGO_PN",
  "SPNCODE":"CODIGO_PN_PROVEEDOR",
  "CODETYPE":2
}

Ejemplo de respuesta

{ "Success":true, "fault":{ "faultcode":"none", "faultstring":"Relation added", "detail":"Relation successfully added" } }

Pedidos

Pedidos

Añadir pedidos

Esta función permite añadir un pedido en el sistema.

URL

/CTNEAT/ORDER/ADD/{tkn}

Método HTTP

POST

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Formato del valor
ORDERNUM cadena Número de pedido Sí -
LINE numérico Línea del pedido No -
ITEMCODE cadena Código interno del artículo Sí -
QTY numérico Cantidad pedida del artículo Sí -
RECQTY numérico Cantidad ya recibida del artículo No -
RECDATE fecha Descripción del artículo Sí YYYYMMDD
CONF booleano Especifica si la línea del pedido está confirmada No 0 o 1
SUPPLIER cadena Proveedor del pedido Sí -
ORDERCREATIONDATE fecha Fecha de la creación del pedido Sí YYYYMMDD
CANCELED booleano Especifica si la línea del pedido se ha cancelado No 0 o 1

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio
Content-Type Tipo de contenido de la solicitud Sí

Cuerpo de la solicitud

Formato del cuerpo de la solicitud: application/json

Descripción del cuerpo de la solicitud:

{
    "ORDERNUM": "ORDER_NUMBER",
    "LINE": LINE_NUMBER,
    "ITEMCODE": "CODIGO_PN_INTERNO",
    "QTY": CANTIDAD_PEDIDA,
    "RECQTY": CANTIDAD_YA_RECIBIDA,
    "RECDATE": "FECHA_DE_RECEPCION",
    "CONF": CONFIRMADO,
    "SUPPLIER": "PROVEEDOR",
    "ORDERCREATIONDATE": "FECHA_DE_CREACION_DEL_PEDIDO",
    "CANCELED": CANCELADO
}

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro Formato
ErrorContent JSON Json con la descripción del resultado de la operación Formato ErrorContent

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/CTNEAT/ORDER/ADD/6A201F1F5147079FF9CA80DCDBB032AB386905091BC973B53F50E6493EC53868

{
    "ORDERNUM": "ORDER_1_API",
    "LINE": 1,
    "ITEMCODE": "CODIGO_PN",
    "QTY": 1000,
    "RECQTY": 0,
    "RECDATE": "20230610",
    "CONF": 1,
    "SUPPLIER": "CTNEAT",
    "ORDERCREATIONDATE": "20230509",
    "CANCELED": 0
}

Ejemplo de respuesta

{ "Success":true, "fault":{ "faultcode":"none", "faultstring":"Order added", "detail":"Order: CODIGO_PN-1 successfully added" } }
Pedidos

Modificar pedidos

Con esta función, es posible llevar a cabo la modificación de los pedidos ya existentes en el sistema.

URL

/CTNEAT/ORDER/MODIF/{tkn}

Método HTTP

PUT

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Formato del valor
ORDERNUM cadena Número de pedido Sí -
LINE numérico Línea del pedido No -
ITEMCODE cadena Código interno del artículo No -
QTY numérico Cantidad pedida del artículo No -
RECQTY numérico Cantidad ya recibida del artículo No -
RECDATE fecha Descripción del artículo No YYYYMMDD
CONF booleano Especifica si la línea del pedido está confirmada No 0 o 1
SUPPLIER cadena Proveedor del pedido No -
ORDERCREATIONDATE fecha Fecha de la creación del pedido No YYYYMMDD
CANCELED booleano Especifica si la línea del pedido se ha cancelado No 0 o 1

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio
Content-Type Tipo de contenido de la solicitud Sí

Cuerpo de la solicitud

Formato del cuerpo de la solicitud: application/json

Descripción del cuerpo de la solicitud:

{
    "ORDERNUM": "ORDER_NUMBER",
    "LINE": LINE_NUMBER,
    "ITEMCODE": "CODIGO_PN_INTERNO",
    "QTY": CANTIDAD_PEDIDA,
    "RECQTY": CANTIDAD_YA_RECIBIDA,
    "RECDATE": "FECHA_DE_RECEPCION",
    "CONF": CONFIRMADO,
    "SUPPLIER": "PROVEEDOR",
    "ORDERCREATIONDATE": "FECHA_DE_CREACION_DEL_PEDIDO",
    "CANCELED": CANCELADO
}

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro Formato
ErrorContent JSON Json con la descripción del resultado de la operación Formato ErrorContent

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/CTNEAT/ORDER/MODIF/6A201F1F5147079FF9CA80DCDBB032AB386905091BC973B53F50E6493EC53868

{
    "ORDERNUM": "ORDER_1_API",
    "LINE": 1,
    "ITEMCODE": "CODIGO_PN",
    "QTY": 2000,
}

Ejemplo de respuesta

{ "Success":true, "fault":{ "faultcode":"none", "faultstring":"Order modified", "detail":"Order: CODIGO_PN-1 successfully modified" } }

UID

UID

Añadir UID

Con esta función se puede agregar un nuevo contenedor al sistema. Si no se especifica un número de identificación única del contenedor (UID), el sistema automáticamente asignará el siguiente UID disponible.

URL

/CTNEAT/UID/ADD/{tkn}

Método HTTP

POST

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Formato del valor
ITEMCODE cadena Código interno del artículo Sí -
CODETYPE numérico Código del formato del artículo Sí Ver posibles valores
UID cadena Código único del contenedor No -
REMQTY numérico Cantidad restante del contenedor No -
INITQTY numérico Cantidad inicial del contenedor No -
DATECODE numérico DATECODE del contenedor No YYWW
LOTNUMBER cadena Número de lote del contenedor No -
MPARTNUMBER cadena Part Number del fabricante No -
SPARTNUMBER cadena Part Number del proveedor No -
ORDERNUMBER cadena Número del pedido del contenedor No -
ORDERLINE numérico Número de línea del pedido del contenedor No -
DELIVERYNOTE cadena Número de albarán del contenedor No -
SUPPLIER cadena Proveedor No -

(si no se especifica el numero único del contenedor (UID) se definirá automaticametne con el siguiente número disponible)

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio
Content-Type Tipo de contenido de la solicitud Sí

Cuerpo de la solicitud

Formato del cuerpo de la solicitud: application/json

Descripción del cuerpo de la solicitud:

{
    "ITEMCODE": "ITEM_CODE",
    "CODETYPE": CODIGO_FORMATO,
    "UID": "CODIGO_DEL_CONTENEDOR",
    "REMQTY": CANTIDAD_RESTANTE_DEL_CONTENEDOR,
    "INITQTY": CANTIDAD_INICIAL_DEL_CONTENEDOR,
    "DATECODE": "DATECODE_CONTENEDOR",
    "LOTNUMBER": "LOTE_CONTENEDOR",
    "MPARTNUMBER": "PART_NUMBER_FABRICANTE",
    "SPARTNUMBER": "PART NUMBER PROVEEDOR",
    "ORDERNUMBER": "NUMERO_PEDIDO_DEL_CONTENEDOR",
    "ORDERLINE": LINEA_PEDIDO,
    "DELIVERYNOTE": "NUM_ALBARAN_CONTENEDOR",
    "SUPPLIER": "PROVEEDOR"
}

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro Formato
ErrorContent JSON Json con la descripción del resultado de la operación Formato ErrorContent

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/CTNEAT/UID/ADD/6A201F1F5147079FF9CA80DCDBB032AB386905091BC973B53F50E6493EC53868

{
    "ITEMCODE": "CODIGO_PN",
    "CODETYPE": 2,
    "UID": "UID0001",
    "REMQTY": 1000,
    "INITQTY": 1000,
    "DATECODE": "2302",
    "LOTNUMBER": "LOT_1",
    "MPARTNUMBER": "PN_1",
    "SPARTNUMBER": "SPN_1",
    "ORDERNUMBER": "ORDER_NUMBER_0001",
    "ORDERLINE": 1,
    "DELIVERYNOTE": "DELNOTE01",
    "SUPPLIER": "SUPPLIER_1"
}

Ejemplo de respuesta

{ "Success":true, "fault":{ "faultcode":"none", "faultstring":"UID added", "detail":"UID: UID0001 successfully added" } }
UID

Modificar cantidad remanente

Esta función permite la modificación de la cantidad remanente de un contenedor específico identificado por su número de identificación única (UID).

URL

/CTNEAT/UID/MODIF/REMQTY/{tkn}

Método HTTP

PUT

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Posibles valores
UID cadena Código único del contenedor Sí Cualquiera
REMQTY numérico Cantidad restante del contenedor Sí Cualquiera

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio
Content-Type Tipo de contenido de la solicitud Sí

Cuerpo de la solicitud

Formato del cuerpo de la solicitud: application/json

Descripción del cuerpo de la solicitud:

{ 
  "UID": "CODIGO_DEL_CONTENEDOR",
  "REMQTY": CANTIDAD_RESTANTE_DEL_CONTENEDOR
}

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro Formato
ErrorContent JSON Json con la descripción del resultado de la operación Formato ErrorContent

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/CTNEAT/UID/MODIF/REMQTY/8281A4D634729B979BD2070BFB21DB5C54C1E840078F0825C45337C5E383FEE6

{ 
  "UID":"UID0001",
  "REMQTY":500
}

Ejemplo de respuesta

{ "Success":true, "fault":{ "faultcode":"none", "faultstring":"UID Modified", "detail":"Remaining quantity of the UID: UID0001 successfully changed to 500" } }
UID

Leer UID

Con esta función es posible llevar a cabo la lectura de los datos asociados a un contenedor específico identificado por su número de identificación única (UID).

URL

/CTNEAT/UID/READ/{tkn}

Método HTTP

GET

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Posibles valores
UID cadena Código único del contenedor No (Si el UID no se especifica, la API devolverá todos los UID del sistema) Cualquiera

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio

Cuerpo de la solicitud

No se requiere un cuerpo de solicitud para este método HTTP.

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro
Result JSON Json con la descripción del resultado de la operación
Elementos de Result

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/UID/READ/82567D1EEEA399427154D52F98DB1D95FFAAA6440D535B8B50C8BF7088ACE84E?UID=UID0001

Ejemplo de respuesta

{
  "NRecords": 1,
  "Data": [
    {
      "UID": "UID0001",
      "ItemCode": "CODIGO_PN",
      "InitialQTY": 1000,
      "RemainingQTY": 500,
      "DateCode": "2302",
      "LotNumber": "LOT_1",
      "MPartNumber": "PN_1",
      "SPartNumber": "SPN_1",
      "OrderNumber": "ORDER_NUMBER_0001",
      "LineOrderNumber": 1,
      "DeliveryNoteNumber": "DELNOTE01",
      "Type": "REEL",
      "Format": "H08S",
      "IDDelivNoteLine": 0,
      "User": "API-CTNEAT",
      "Date": "2023-05-10T11:09:35.465",
      "Supplier": "SUPPLIER_1",
    }
  ]
}
UID

Leer nuevos UID

Con esta función se puede realizar la lectura de los nuevos contenedores creados en el sistema y que aún no han sido exportados. Su propósito es obtener los datos de los nuevos contenedores que se acaban de crear.

URL

/CTNEAT/UID/READ/NEWUIDS/{tkn}

Método HTTP

GET

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Posibles valores

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio

Cuerpo de la solicitud

No se requiere un cuerpo de solicitud para este método HTTP.

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro
Result JSON Json con la descripción del resultado de la operación
Elementos de Result

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/UID/READ/NEWUIDS/82567D1EEEA399427154D52F98DB1D95FFAAA6440D535B8B50C8BF7088ACE84E

Ejemplo de respuesta

{
  "NRecords": 1,
  "Data": [
    {
      "UID": "UID0001",
      "ItemCode": "CODIGO_PN",
      "InitialQTY": 1000,
      "RemainingQTY": 1000,
      "DateCode": "2302",
      "LotNumber": "LOT_1",
      "MPartNumber": "PN_1",
      "SPartNumber": "SPN_1",
      "OrderNumber": "ORDER_NUMBER_0001",
      "LineOrderNumber": 1,
      "DeliveryNoteNumber": "DELNOTE01",
      "Type": "REEL",
      "Format": "H08S",
      "IDDelivNoteLine": 0,
      "User": "API-CTNEAT",
      "Date": "2023-05-10T11:09:35.465",
      "Supplier": "SUPPLIER_1",
    }
  ]
}

BOM

BOM

Añadir BOM

Esta función permite la inclusión de un listado de materiales de un producto, también conocido como "BOM" (Bill of Materials, por sus siglas en inglés), en el sistema.

URL

/CTNEAT/BOM/ADD/{tkn}

Método HTTP

POST

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Formato del valor
BOMCode cadena Código de la BOM Sí -
Description cadena Descripción de la BOM No -
Disabled booleano Estado de la BOM No 0 o 1
CUSTOMERNAME cadena Nombre del cliente de la BOM No -
BOM JSON JSON con el contenido de la BOM Sí especificado a continuación
Elementos BOM
Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Formato del valor
ItemCode cadena Código interno del artículo Sí -
Units numérico Unidades del artículo en la BOM Sí -

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio
Content-Type Tipo de contenido de la solicitud Sí

Cuerpo de la solicitud

Formato del cuerpo de la solicitud: application/json

Descripción del cuerpo de la solicitud:

{
  "BOMCode": "CODIGO_BOM",
  "Description": "DESCRIPCION_BOM",
  "Disabled": BOM_DESHABILITADA,
  "CUSTOMERNAME": "CLIENTE",
  "BOM": [
    {
      "ItemCode": "CODIGO_PN_INTERNO",
      "Units": UNIDADES
    },
    {
      "ItemCode": "CODIGO_PN_INTERNO",
      "Units": UNIDADES
    }
  ]
}

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro Formato
ErrorContent JSON Json con la descripción del resultado de la operación Formato ErrorContent

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/CTNEAT/BOM/ADD/6A201F1F5147079FF9CA80DCDBB032AB386905091BC973B53F50E6493EC53868

{
  "BOMCode": "BOM_API_1",
  "Description": "BOM IMPORTED FROM API",
  "Disabled": 0,
  "CUSTOMERNAME": "CTNEAT",
  "BOM": [
    {
      "ItemCode": "CODIGO_PN",
      "Units": 2
    },
    {
      "ItemCode": "CODIGO_PN_2",
      "Units": 1
    }
  ]
}

Ejemplo de respuesta

{ "Success":true, "fault":{ "faultcode":"none", "faultstring":"BOM added", "detail":"BOM: BOM_API_1 successfully added" } }
BOM

Modificar BOM

Con esta función es posible realizar modificaciones en un listado de materiales de un producto, o BOM, previamente agregado al sistema.

URL

/CTNEAT/BOM/MODIF/{tkn}

Método HTTP

PUT

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Formato del valor
BOMCode cadena Código de la BOM Sí -
Description cadena Descripción de la BOM No -
Disabled booleano Estado de la BOM No 0 o 1
CUSTOMERNAME cadena Nombre del cliente de la BOM No -
BOM JSON JSON con el contenido de la BOM No especificado a continuación
Elementos BOM
Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Formato del valor
ItemCode cadena Código interno del artículo Sí -
Units numérico Unidades del artículo en la BOM Sí -

Cuerpo de la solicitud

Formato del cuerpo de la solicitud: application/json

Descripción del cuerpo de la solicitud:

{
  "BOMCode": "CODIGO_BOM",
  "Description": "DESCRIPCION_BOM",
  "Disabled": BOM_DESHABILITADA,
  "CUSTOMERNAME": "CLIENTE",
  "BOM": [
    {
      "ItemCode": "CODIGO_PN_INTERNO",
      "Units": UNIDADES
    },
    {
      "ItemCode": "CODIGO_PN_INTERNO",
      "Units": UNIDADES
    }
  ]
}

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro Formato
ErrorContent JSON Json con la descripción del resultado de la operación Formato ErrorContent

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/CTNEAT/BOM/MODIF/6A201F1F5147079FF9CA80DCDBB032AB386905091BC973B53F50E6493EC53868

{
  "BOMCode": "BOM_API_1",
  "Description": "BOM MODIFIED FROM API",
  "Disabled": 0,
  "CUSTOMERNAME": "CTNEAT",
  "BOM": [
    {
      "ItemCode": "CODIGO_PN",
      "Units": 0
    },
    {
      "ItemCode": "CODIGO_PN_2",
      "Units": 3
    }
  ]
}

Ejemplo de respuesta

{ "Success":true, "fault":{ "faultcode":"none", "faultstring":"BOM modified", "detail":"BOM: BOM_API_1 successfully modified" } }
BOM

Leer BOM

Esta función permite la lectura de un listado de materiales de un producto, o BOM, previamente agregado al sistema. Si no se especifica el código del BOM mediante un parámetro en la URL, se leerán todos los BOM del sistema.

URL

/CTNEAT/BOM/READ/{tkn}

Método HTTP

GET

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Posibles valores
BOMCode cadena Código de la BOM No (Si el código de BOM no se especifica, la API devolverá todas las BOM del sistema) Cualquiera

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio

Cuerpo de la solicitud

No se requiere un cuerpo de solicitud para este método HTTP.

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro
Result JSON Json con la descripción del resultado de la operación
Elementos de Result

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/BOM/READ/2CB5C9AE031E4E0B2A98143637EBCAEF77B2E606F03975C67C3B30584BBEEFAF?BOMCode=BOM_API_1

Ejemplo de respuesta

{
  "NRecords": 1,
  "Data": [
    {
      "BOMCode": "BOM_API_1",
      "Description": "BOM MODIFIED FROM API",
      "CreationDate": "20230510",
      "Disabled": false,
      "NOfItems": 2,
      "BOM": [
        {
          "ItemCode": "CODIGO_PN",
          "Units": 0
        },
        {
          "ItemCode": "CODIGO_PN_2",
          "Units": 3
        }
      ]
    }
  ]
}

Ordenes de trabajo

Ordenes de trabajo

Añadir orden de trabajo

Con esta función es posible agregar una nueva orden de trabajo al sistema. Es posible crear la orden a partir de un listado de materiales de un producto (BOM) ya existente o bien, mediante la inclusión directa de los códigos de componente necesarios.

URL

/CTNEAT/WO/ADD/{tkn}

Método HTTP

POST

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Formato del valor
WOCode cadena Código de la orden Sí -
Product cadena Producto a producir Sí -
Units cadena Unidades a producir Sí Númerico
FinalProduct cadena Producto final a producir Sí -
UnitsFinalProduct cadena Unidades producto final a producir Sí Númerico
ProdCode cadena Código de la producción Sí -
Order cadena Orden de la fabricación dentro de la producción Sí Númerico
Description cadena Descripción de la orden No -
productionLine cadena Línea de producción de la orden No -
LaunchDate fecha Fecha de lanzamiento de la orden No YYYYMMDD
BOM JSON JSON con el contenido de la orden Sí especificado a continuación
Elementos BOM
Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Formato del valor
ItemCode cadena Código interno del artículo o código de la BOM Sí -
Units numérico Unidades del artículo o de la BOM Sí -

(Se puede lanzar una orden de trabajo uniendo BOM con códigos de artículos sueltos tal y como se muestra en el ejemplo)

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio
Content-Type Tipo de contenido de la solicitud Sí

Cuerpo de la solicitud

Formato del cuerpo de la solicitud: application/json

Descripción del cuerpo de la solicitud:

{
  "WOCode": "CODIGO_ORDENTRABAJO",
  "Product":"PRODUCTO_A_PRODUCIR",
  "Units":"UNIDADES_DEL_PRODUCTO",
  "FinalProduct":"PRODUCTO_FINAL_A_PRODUCIR",
  "UnitsFinalProduct":"UNIDADES_PRODUCTO_FINAL",
  "ProdCode":"ORDEN_PRODUCCION",
  "Order":"ORDEN_INTERNO_DE_LA_ORDEN
  "Description": "DESCRIPCION_DE_LA_OT",
  "productionLine": "LINEA_DE_PRODUCCION",
  "LaunchDate": "FECHA_DE_LANZAMIENTO",
  "BOM": [
    {
      "ItemCode": "CODIGO_PN_INTERNO_O_CODIGO_BOM",
      "Units": UNIDADES
    },
    {
      "ItemCode": "CODIGO_PN_INTERNO_O_CODIGO_BOM",
      "Units": UNIDADES
    }
  ]
}

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro Formato
ErrorContent JSON Json con la descripción del resultado de la operación Formato ErrorContent

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/CTNEAT/WO/ADD/6A201F1F5147079FF9CA80DCDBB032AB386905091BC973B53F50E6493EC53868

{
  "WOCode": "WO_API_1",
  "Product":"PERODUCT_API",
  "ProdCode":"PR_API_1",
  "FinalProduct":"BIG_PRODUCT",
  "UnitsFinalProduct":"UNITS_BIG_PRODUCT",
  "Units":"1000",
  "Order":"1",
  "Description": "WO DESCRIPTION",
  "productionLine": "L-1",
  "LaunchDate": "20230510",
  "BOM": [
    {
      "ItemCode": "BOM_API_1",
      "Units": 3
    },
    {
      "ItemCode": "CODIGO_PN",
      "Units": 2
    }
  ]
}

Ejemplo de respuesta

{ "Success":true, "fault":{ "faultcode":"none", "faultstring":"Work order added", "detail":"Work order: WO_API_1 successfully added" } }

Albaranes

Albaranes

Leer albaranes

Esta función permite la lectura de los albaranes registrados en el sistema. Si no se especifica el número de albarán mediante un parámetro en la URL, se leerán todos los albaranes del sistema.

URL

/CTNEAT/DELYNOTE/READ/{tkn}

Método HTTP

GET

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Posibles valores
DELYNOTENUMBER cadena Número de albarán No (Si no se especifica, se leerán todos los albaranes) Cualquiera

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio

Cuerpo de la solicitud

No se requiere un cuerpo de solicitud para este método HTTP.

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro
Result JSON Json con la descripción del resultado de la operación
Elementos de Result

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/DELYNOTE/READ/E994D8C3B99915A68CB9CC502B6CD5300857BA04D3E696BDFE70C02BBFE6A537?DELYNOTENUMBER=001259

Ejemplo de respuesta

{
    "NRecords": 1,
    "Data": [
        {
            "DelivNoteNumber": "001259",
            "Supplier": "CTNEAT_SUPP",
            "DelivNoteCreationDate": "2023-05-10T10:17:40.362",
            "DelivNoteCreationUser": "admin",
            "NOfLines": 2,
            "currentDeliveryNoteNumber": [
                {
                    "ItemCode": "CODIGO_PN",
                    "QTYRecived": 3,
                    "DelivNoteLineCreationDate": "2023-05-10T10:17:40.367",
                    "DelivNoteLineCreationUser": "",
                    "IDDelivNoteLine": 2219,
                },
                {
                    "ItemCode": "CODIGO_PN_2",
                    "QTYRecived": 5,
                    "DelivNoteLineCreationDate": "2023-05-10T10:19:23.153",
                    "DelivNoteLineCreationUser": "",
                    "IDDelivNoteLine": 2220,
                }
            ]
        }
    ]
}
Albaranes

Leer los nuevos albaranes

Con esta función es posible obtener la lectura de los nuevos albaranes que han sido creados recientemente en el sistema y que aún no han sido exportados. Esta función ha sido diseñada para facilitar la obtención de los nuevos albaranes que acaban de ser recepcionados por el sistema.

URL

/CTNEAT/DELYNOTE/READ/NEWDELYNOTE/{tkn}

Método HTTP

GET

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Posibles valores

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio

Cuerpo de la solicitud

No se requiere un cuerpo de solicitud para este método HTTP.

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro
Result JSON Json con la descripción del resultado de la operación
Elementos de Result

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/DELYNOTE/READ/NEWDELYNOTE/E994D8C3B99915A68CB9CC502B6CD5300857BA04D3E696BDFE70C02BBFE6A537

Ejemplo de respuesta

{
    "NRecords": 1,
    "Data": [
        {
            "DelivNoteNumber": "001259",
            "Supplier": "CTNEAT_SUPP",
            "DelivNoteCreationDate": "2023-05-10T10:17:40.362",
            "DelivNoteCreationUser": "admin",
            "NOfLines": 2,
            "currentDeliveryNoteNumber": [
                {
                    "ItemCode": "CODIGO_PN",
                    "QTYRecived": 3,
                    "DelivNoteLineCreationDate": "2023-05-10T10:17:40.367",
                    "DelivNoteLineCreationUser": "",
                    "IDDelivNoteLine": 2219,
                },
                {
                    "ItemCode": "CODIGO_PN_2",
                    "QTYRecived": 5,
                    "DelivNoteLineCreationDate": "2023-05-10T10:19:23.153",
                    "DelivNoteLineCreationUser": "",
                    "IDDelivNoteLine": 2220,
                }
            ]
        }
    ]
}