Descubra cómo funciona el endpoint de números de pedido.
El endpoint orderNumbers se utiliza para recuperar de forma segura una lista de números de pedido completados a través de Zonos Checkout. Normalmente se utiliza para la conciliación de pedidos para garantizar que todos los pedidos se importaron a partir de una fecha o orderID, así como pedidos dentro de un rango de fechas.
POST | https://api.iglobalstores.com/v1/orderNumbers
Solicitud HTTPS
Campo↕
Notas↕
Método HTTP
POST
Endpoint
https://api.iglobalstores.com/v1/orderNumbers
Protocolo
HTTPS
Formato del mensaje
JSON
Encabezado HTTP Accept
Accept: application/json
Encabezado HTTP Content-Type
Content-Type: application/json
Clave/valor JSON en el cuerpo de la solicitud
Formato del mensaje: JSON
1{
2"store":"999",
3"secret":"f5bde245-f55e-414d-b722-80b25161c12c",
4"sinceOrderId":"999-99999"
5}
Definiciones JSON de la solicitud
campo↕
notas↕
missingMerchantOrderId OPCIONAL, si se pasa otra opción de parámetro
Este parámetro se utiliza para consultar un conjunto de pedidos dentro de las últimas dos semanas a los que les falta el merchantOrderId. Cuando el merchantOrderId se envía a través del endpoint API updateMerchantOrderID, los pedidos ya no aparecerán en esta consulta.boolean: true/false
secret REQUERIDO
GUID secreto de la API proporcionado por Zonos. string
sinceDate OPCIONAL, si se pasa el parámetro sinceOrderId.
Este parámetro se utiliza para consultar un conjunto de pedidos después de una fecha particular. sinceDate y sinceOrderId no pueden enviarse ambos.string - fecha UTC/GMT; formato: yyyymmdd
sinceOrderId OPCIONAL, si se pasa el parámetro sinceDate / throughDate
El ID de pedido de Zonos puede enviarse con o sin el ID de su tienda y el guion (Ejemplo: 123-45678 o 45678). Nota: Este parámetro se utilizará para consultar un conjunto de pedidos después de un pedido Zonos particular. sinceDate y sinceOrderId no pueden enviarse ambos.integer / string
statuses OPCIONAL
Este parámetro se utiliza para incluir el estado actual del pedido y el merchantOrderId en la respuesta. Si está presente en la solicitud, independientemente del valor, incluirá los estados.boolean: true
store REQUERIDO
ID de tienda proporcionado por Zonos.integer
throughDate OPCIONAL
Este parámetro se utiliza para consultar un conjunto de pedidos dentro de un rango de fechas particular. Debe enviarse junto con el parámetro sinceDate.string - fecha UTC/GMT; formato: yyyymmdd
Respuesta HTTPS
Formato del mensaje: JSON
1{
2"totalCount":6,
3"orderCount":5,
4"testOrderCount":1,
5"orders":[
6{
7"testOrder":false,
8"id":"999-99991",
9"timestamp":"2015-01-01 00:33:14.0"
10},
11{
12"testOrder":true,
13"id":"999-99992",
14"timestamp":"2015-01-01 05:12:46.0"
15},
16{
17"testOrder":false,
18"id":"999-99993",
19"timestamp":"2015-01-01 14:50:54.0"
20},
21{
22"testOrder":false,
23"id":"999-99994",
24"timestamp":"2015-01-02 20:14:01.0"
25},
26{
27"testOrder":false,
28"id":"999-99995",
29"timestamp":"2015-01-02 20:57:47.0"
30},
31{
32"testOrder":false,
33"id":"999-99996",
34"timestamp":"2015-01-02 22:11:40.0"
35}
36]
37}
Respuestas HTTP de error
Error↕
Significado↕
406 - Not Acceptable
Entidad HTML. El encabezado HTTP "Accept" no es válido.
415 - Unsupported media type
Entidad HTML. El encabezado HTTP "Content-Type" no es válido.
200
"error":"could not parse input"
200
"error":"orderId: 999-99999 is not a valid orderId"
200
"error":"Parameter orderId or referenceId is required."
200
"error":"Cannot specify both Parameters orderId and referenceId."
200
"error":"Could not process order details."
200
"error":"Invalid security credentials"
Definiciones JSON de la respuesta
campo↕
notas↕
error
Este parámetro solo estará presente en la respuesta cuando haya ocurrido un error y contendrá una descripción de la causa.string
orderCount
El recuento total de pedidos en vivo recuperados.integer
order.testOrderCount
El recuento total de pedidos de prueba recuperados.integer
orders
Una lista de mapas de pedidos.string
orders[index].id
El ID de pedido Zonos completo, incluido el ID de tienda y el guion.string
orders[index].merchantOrderId
MerchantOrderId asociado con el pedido a través del endpoint de servicio API updateMerchantOrderId.string
orders[index].orderStatus
El estado actual del pedido para posibles valores.string
orders[index].orderStatusDate
La época que representa cuándo se actualizó el estado por última vez.integer
orders[index].orderStatusDateString
La marca de tiempo que representa cuándo se actualizó el estado por última vez en UTC/GMT.timestamp
orders[index].testOrder
Indica si el pedido fue un "pedido de prueba" o un "pedido en vivo".boolean
orders[index].timestamp
La marca de tiempo que representa cuándo se realizó el pedido en UTC/GMT.timestamp
totalCount
El recuento total de pedidos en vivo y de prueba recuperados.integer
Números de pedido
Números de pedido
Descubra cómo funciona el endpoint de números de pedido.El endpoint
orderNumbersse utiliza para recuperar de forma segura una lista de números de pedido completados a través de Zonos Checkout. Normalmente se utiliza para la conciliación de pedidos para garantizar que todos los pedidos se importaron a partir de una fecha o orderID, así como pedidos dentro de un rango de fechas.Endpoint
POST |
https://api.iglobalstores.com/v1/orderNumbersSolicitud HTTPS
https://api.iglobalstores.com/v1/orderNumbersClave/valor JSON en el cuerpo de la solicitud
Formato del mensaje: JSON
{"store": "999","secret": "f5bde245-f55e-414d-b722-80b25161c12c","sinceOrderId": "999-99999"}Definiciones JSON de la solicitud
missingMerchantOrderIdOPCIONAL, si se pasa otra opción de parámetromerchantOrderId. Cuando elmerchantOrderIdse envía a través del endpoint APIupdateMerchantOrderID, los pedidos ya no aparecerán en esta consulta.boolean: true/falsesecretREQUERIDOstringsinceDateOPCIONAL, si se pasa el parámetrosinceOrderId.sinceDateysinceOrderIdno pueden enviarse ambos.string- fecha UTC/GMT; formato:yyyymmddsinceOrderIdOPCIONAL, si se pasa el parámetrosinceDate/throughDatesinceDateysinceOrderIdno pueden enviarse ambos.integer / stringstatusesOPCIONALmerchantOrderIden la respuesta. Si está presente en la solicitud, independientemente del valor, incluirá los estados.boolean: truestoreREQUERIDOintegerthroughDateOPCIONALsinceDate.string- fecha UTC/GMT; formato:yyyymmddRespuesta HTTPS
Formato del mensaje: JSON
{"totalCount": 6,"orderCount": 5,"testOrderCount": 1,"orders": [{"testOrder": false,"id": "999-99991","timestamp": "2015-01-01 00:33:14.0"},{"testOrder": true,"id": "999-99992","timestamp": "2015-01-01 05:12:46.0"},{"testOrder": false,"id": "999-99993","timestamp": "2015-01-01 14:50:54.0"},{"testOrder": false,"id": "999-99994","timestamp": "2015-01-02 20:14:01.0"},{"testOrder": false,"id": "999-99995","timestamp": "2015-01-02 20:57:47.0"},{"testOrder": false,"id": "999-99996","timestamp": "2015-01-02 22:11:40.0"}]}Respuestas HTTP de error
Definiciones JSON de la respuesta
errorstringorderCountintegerorder.testOrderCountintegerordersstringorders[index].idstringorders[index].merchantOrderIdMerchantOrderIdasociado con el pedido a través del endpoint de servicio APIupdateMerchantOrderId.stringorders[index].orderStatusstringorders[index].orderStatusDateintegerorders[index].orderStatusDateStringtimestamporders[index].testOrderbooleanorders[index].timestamptimestamptotalCountinteger¿Fue útil esta página?