Endpoint
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
EJEMPLO DE SOLICITUD: sinceOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceOrderId": "999-99999"
}
EJEMPLO DE SOLICITUD: sinceDate
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101"
}
EJEMPLO DE SOLICITUD: sinceDate, throughDate
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"throughDate": "20150601"
}
EJEMPLO DE SOLICITUD: missingMerchantOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"missingMerchantOrderId": true
}
EJEMPLO DE SOLICITUD: estados
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"statuses": true
}
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 en las últimas dos semanas que no tienen el merchantOrderId. Cuando el merchantOrderId se envía a través del punto final de la 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 en particular. sinceDate y sinceOrderId no pueden enviarse juntos. string - fecha UTC/GMT; formato: yyyymmdd |
sinceOrderId OPCIONAL, si se pasa el parámetro sinceDate / throughDate | El ID de pedido de Zonos, se puede enviar con o sin el ID de tu tienda y guion (Ejemplo: 123-45678 o 45678).Nota: Este parámetro se utilizará para consultar un conjunto de pedidos después de un pedido específico de Zonos. sinceDate y sinceOrderId no pueden enviarse juntos. 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 entre un rango de fechas específico. Debe enviarse junto con el parámetro sinceDate. string - fecha UTC/GMT; formato: yyyymmdd |
Respuesta HTTPS
Formato del mensaje: JSON
EJEMPLO DE RESPUESTA EXITOSA
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
"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"
}
]
}
Respuesta de ejemplo exitosa con el parámetro 'statuses'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
"totalCount": 2,
"orderCount": 1,
"testOrderCount": 1,
"orders": [
{
"testOrder": false,
"id": "999-99991",
"timestamp": "2015-01-01 00:33:14.0",
"merchantOrderId": null,
"orderStatus": "IGLOBAL_FRAUD_REVIEW",
"orderStatusDate": 1420097594000,
"orderStatusDateString": "2015-01-01 14:16:17.0"
},
{
"testOrder": true,
"id": "999-99992",
"timestamp": "2015-01-01 05:12:46.0",
"merchantOrderId": "abc123",
"orderStatus": "IGLOBAL_ORDER_IN_PROCESS",
"orderStatusDate": 1420097594000,
"orderStatusDateString": "2015-01-01 14:16:17.0"
}
]
}
Respuesta de error de ejemplo
1
2
3
{
"error": "Couldn't find order for sinceOrderId: 999999"
}
Respuestas de error HTTP
| Error | Significado |
|---|---|
| 406 - No aceptable | Entidad HTML. La cabecera HTTP "Accept" no es válida. |
| 415 - Tipo de medio no soportado | Entidad HTML. La cabecera HTTP "Content-Type" no es válida. |
| 200 | "error": "no se pudo analizar la entrada" |
| 200 | "error": "orderId: 999-99999 no es un orderId válido" |
| 200 | "error": "Se requiere el parámetro orderId o referenceId." |
| 200 | "error": "No se pueden especificar ambos parámetros orderId y referenceId." |
| 200 | "error": "No se pudieron procesar los detalles del pedido." |
| 200 | "error": "Credenciales de seguridad inválidas" |
Definiciones JSON de respuesta
| campo | notas |
|---|---|
error | Este parámetro solo estará presente en la respuesta cuando se haya producido 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 completo del pedido de Zonos incluyendo el Id de la tienda y el guion. string |
orders[index].merchantOrderId | MerchantOrderId asociado con el pedido a través del punto final del servicio de 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ó por última vez el estado. integer |
orders[index].orderStatusDateString | La marca de tiempo que representa cuándo se actualizó por última vez el estado en UTC/GMT. timestamp |
orders[index].testOrder | Indica si el pedido era 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 tanto en vivo como de prueba recuperados. integer |
Números de pedido
Aprende 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 del Zonos Checkout. Normalmente se utiliza para la conciliación de pedidos para asegurar que todos los pedidos se importaron a partir de una fecha o ID de pedido, así como los pedidos entre un rango de fechas.