Endpoint
POST | https://api.iglobalstores.com/v1/orderNumbers
Solicitação HTTPS
| Campo | Notas |
|---|---|
| Método HTTP | POST |
| Endpoint | https://api.iglobalstores.com/v1/orderNumbers |
| Protocolo | HTTPS |
| Formato da mensagem | JSON |
| Cabeçalho HTTP Accept | Accept: application/json |
| Cabeçalho HTTP Content-Type | Content-Type: application/json |
Chave/valor JSON no corpo da solicitação
Formato da mensagem: JSON
EXEMPLO DE SOLICITAÇÃO: sinceOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceOrderId": "999-99999"
}
EXEMPLO DE SOLICITAÇÃO: sinceDate
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101"
}
EXEMPLO DE SOLICITAÇÃO: sinceDate, throughDate
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"throughDate": "20150601"
}
EXEMPLO DE SOLICITAÇÃO: missingMerchantOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"missingMerchantOrderId": true
}
EXEMPLO DE SOLICITAÇÃO: status
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"statuses": true
}
Definições JSON da solicitação
| campo | notas |
|---|---|
missingMerchantOrderId OPCIONAL, se passar outra opção de parâmetro | Este parâmetro é usado para consultar um conjunto de pedidos nas últimas duas semanas que estão sem o merchantOrderId. Quando o merchantOrderId é enviado através do ponto de extremidade da API updateMerchantOrderID, os pedidos não aparecerão mais nesta consulta. boolean: true/false |
secret OBRIGATÓRIO | GUID secreto da API fornecido pela Zonos. string |
sinceDate OPCIONAL, se passar o parâmetro sinceOrderId | Este parâmetro é usado para consultar um conjunto de pedidos após uma data específica. sinceDate e sinceOrderId não podem ser enviados juntos. string - data UTC/GMT; formato: yyyymmdd |
sinceOrderId OPCIONAL, se passar o parâmetro sinceDate / throughDate | O ID do pedido da Zonos, pode ser enviado com ou sem o ID da sua loja e hífen (Exemplo: 123-45678 ou 45678). Observação: Este parâmetro será usado para consultar um conjunto de pedidos após um pedido específico da Zonos. sinceDate e sinceOrderId não podem ser enviados juntos. integer / string |
statuses OPCIONAL | Este parâmetro é usado para incluir o status atual do pedido e o merchantOrderId na resposta. Se estiver presente na solicitação, independentemente do valor, incluirá os status. boolean: true |
store OBRIGATÓRIO | ID da loja fornecido pela Zonos. integer |
throughDate OPCIONAL | Este parâmetro é usado para consultar um conjunto de pedidos entre um intervalo de datas específico. Deve ser enviado juntamente com o parâmetro sinceDate. string - data UTC/GMT; formato: yyyymmdd |
Resposta HTTPS
Formato da mensagem: JSON
EXEMPLO DE RESPOSTA DE SUCESSO
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"
}
]
}
Exemplo de resposta de sucesso com 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"
}
]
}
Exemplo de resposta de erro
1
2
3
{
"error": "Couldn't find order for sinceOrderId: 999999"
}
Respostas de erro HTTP
| Erro | Significado |
|---|---|
| 406 - Não Aceitável | Entidade HTML. O cabeçalho HTTP "Accept" é inválido. |
| 415 - Tipo de mídia não suportado | Entidade HTML. O cabeçalho HTTP "Content-Type" é inválido. |
| 200 | "erro": "não foi possível analisar a entrada" |
| 200 | "erro": "orderId: 999-99999 não é um orderId válido" |
| 200 | "erro": "O parâmetro orderId ou referenceId é obrigatório." |
| 200 | "erro": "Não é possível especificar ambos os parâmetros orderId e referenceId." |
| 200 | "erro": "Não foi possível processar os detalhes do pedido." |
| 200 | "erro": "Credenciais de segurança inválidas" |
Definições JSON de resposta
| campo | notas |
|---|---|
erro | Este parâmetro só estará presente na resposta quando ocorrer um erro e conterá uma descrição da causa.string |
orderCount | O total de pedidos ativos recuperados.integer |
order.testOrderCount | O total de pedidos de teste recuperados.integer |
pedidos | Uma lista de mapas de pedidos.string |
pedidos[indíce].id | O Id completo do Pedido Zonos incluindo o Id da loja e traço.string |
pedidos[indíce].merchantOrderId | MerchantOrderId associado ao pedido através do ponto de extremidade do serviço da API updateMerchantOrderId.string |
pedidos[indíce].orderStatus | O status atual do pedido para possíveis valores.string |
pedidos[indíce].orderStatusDate | O epoch representando quando o status foi atualizado pela última vez.integer |
pedidos[indíce].orderStatusDateString | O timestamp representando quando o status foi atualizado pela última vez em UTC/GMT.timestamp |
pedidos[indíce].testOrder | Indica se o pedido era um "pedido de teste" ou "pedido ativo".boolean |
pedidos[indíce].timestamp | O timestamp representando quando o pedido foi feito em UTC/GMT.timestamp |
totalCount | O total de pedidos ativos e de teste recuperados.integer |
Números de pedido
Saiba como funciona o endpoint de Números de pedido.O endpoint
orderNumbersé usado para recuperar com segurança uma lista de números de pedido concluídos via o Zonos Checkout. Normalmente é usado para reconciliação de pedidos para garantir que todos os pedidos tenham sido importados a partir de uma data ou orderID, bem como pedidos entre um intervalo de datas.