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 | Fecha de recepción | 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 |
| PRICE | numérico | Precio del artículo | No | - |
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,
"PRICE": PRICE
}
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,
"PRICE": 10
}
Ejemplo de respuesta
{ "Success":true, "fault":{ "faultcode":"none", "faultstring":"Order added", "detail":"Order: CODIGO_PN-1 successfully added" } }
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 | Fecha de recepción | 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" } }
Buscar pedidos
Con esta función, se tiene la capacidad de leer los pedidos que han sido registrados en el sistema. Es importante destacar que se puede proporcionar el nombre de un pedido en concreto a través de un parámetro de URL query así como una fecha de creación de este. En caso de no especificar estos parámetro, se llevará a cabo la lectura de todos los pedidos del sistema. Si la fecha se introduce en el formato no deseado, se mostrarán todas las fechas.
URL
/CTNEAT/ORDER/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 |
|---|---|---|---|---|
| ORDERNAME | cadena | Nombre del pedido | No | Cualquiera |
| CREATIONDATE | cadena | Fecha de creación o lanzamiento del pedido | No | Fechas en formato YYYYMMDDHHmmSS |
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
- Result.NRecords: Valor numérico que indica el número de registros en la matriz Result.Data.
- Result.Data: Matriz que contiene uno o más objetos (Cantidad de registrios leídos).
- Result.Data[x].ORDERNUM: Nombre del pedido.
- Result.Data[x].SUPPLIER: Nombre del proveedor.
- Result.Data[x].ORDERCREATIONDATE: Fecha de creación del pedido.
- Result.Data[x].ORDER_LINES: Líneas del pedido
- Result.Data[x].ORDER_LINES[y].ITEM_CODE: Código de artículo de la línea del pedido.
- Result.Data[x].ORDER_LINES[y].CONFIRMED: Indica si la línea del pedido ha sido confirmada.
- Result.Data[x].ORDER_LINES[y].RECDATE: Fecha de recepción de los materiales de la línea del pedido.
- Result.Data[x].ORDER_LINES[y].RECQTY: Unidades recibidas.
- Result.Data[x].ORDER_LINES[y].QTY: Cantidad específica de la línea del pedido.
- Result.Data[x].ORDER_LINES[y].PRICE: Precio total de la línea del pedido.
- Result.Data[x].ORDER_LINES[y].LINE: Número de la línea del artículo del pedido.
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/ORDER/READ/693DDFEC2F4BFDDEAF04DD2724984C9B3CA89D553DD8E5B9BB233AD6BB6075F1?ORDERNAME=PEDIDO&CREATIONDATE=20250302112358
Ejemplo de respuesta
{
"NRecords":1,
"Data":[
{
"ORDERNUM":"NOMBRE_PEDIDO",
"SUPPLIER":"NOMBRE_PROVEEDOR",
"ORDERCREATIONDATE":"FECHA CREACIÓN PEDIDO",
"ORDER_LINES": [
{
"ITEM_CODE": "CÓDIGO ARTÍCULO",
"CONFIRMED": True,
"RECDATE": "2025/11/23",
"RECQTY": 100,
"QTY":1000,
"PRICE": 230.65,
"LINE": 1
}
]
}
]
}