Endpoint
POST | https://api.iglobalstores.com/v1/orderNumbers
solicitação HTTPS
| Campo↕ | Notas↕ |
|---|---|
| Método HTTP | POSTR |
| Endpoint | https://api.iglobalstores.com/v1/orderNumbers |
| Protocolo | HTTPS |
| Formato da mensagem | JSON |
| Cabeçalho de aceitação HTTP | Aceitar: aplicativo/json |
| Tipo de conteúdo do cabeçalho HTTP | Tipo de conteúdo: aplicativo/json |
Chave/valor JSON no corpo da solicitação
Formato da mensagem: JSON
1
{2
"store": "999",3
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",4
"sinceOrderId": "999-99999"5
}Solicitar definições JSON
| campo↕ | notas↕ |
|---|---|
missingMerchantOrderId OPCIONAL, se for passada outra opção de parâmetro | Este parâmetro é usado para consultar um conjunto de pedidos nas últimas duas semanas que não possuem merchantOrderId. Quando merchantOrderId for enviado por meio do endpoint da API updateMerchantOrderID, os pedidos não aparecerão mais nesta consulta.boolean: true/false |
secret NECESSÁRIO | GUID secreto da API fornecido por Zonos. string |
sinceDate OPCIONAL, se for passado o parâmetro sinceOrderId. | Este parâmetro é utilizado para consultar um conjunto de pedidos após uma determinada data. sinceDate e sinceOrderId não podem ser enviados.string - data UTC/GMT; formato: yyyymmdd |
sinceOrderId OPCIONAL, se for passado o parâmetro sinceDate / throughDate | O ID do pedido Zonos pode ser enviado com ou sem o ID da loja e hífen (exemplo: 123-45678 ou 45678). Nota: Este parâmetro será usado para consultar um conjunto de pedidos após um determinado pedido Zonos. sinceDate e sinceOrderId não podem ser enviados.integer / string |
statuses OPCIONAL | Este parâmetro é utilizado para incluir o status atual do pedido e merchantOrderId na resposta. Se estiver presente na solicitação, independente do valor, incluirá os estados.boolean: true |
store NECESSÁRIO | ID da loja fornecida por Zonos.integer |
throughDate OPCIONAL | Este parâmetro é usado para consultar um conjunto de pedidos dentro de um determinado intervalo de datas. Deve ser enviado junto com o parâmetro sinceDate.string - data UTC/GMT; formato: yyyymmdd |
Resposta HTTPS
Formato da mensagem: 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
}Respostas de erro HTTP
| Erro↕ | Significado↕ |
|---|---|
| 406 - Não aceitável | Entidade HTML. O cabeçalho HTTP "Aceitar" é inválido. |
| 415 - Tipo de mídia não suportado | Entidade HTML. O cabeçalho HTTP "Content-Type" é inválido. |
| 200 | "error":"não foi possível analisar a entrada" |
| 200 | "error":"orderId: 999-99999 não é um orderId válido" |
| 200 | "error":"O parâmetro orderId ou referenceId é obrigatório." |
| 200 | "error":"Não é possível especificar os parâmetros orderId e referenceId." |
| 200 | "error":"Não foi possível processar os detalhes do pedido." |
| 200 | "error":"Credenciais de segurança inválidas" |
Definições de resposta JSON
| campo↕ | notas↕ |
|---|---|
error | Este parâmetro só estará presente na resposta quando ocorrer um erro e conterá uma descrição da causa.string |
orderCount | A contagem total de pedidos ativos recuperados.integer |
order.testOrderCount | A contagem total de pedidos de teste recuperados.integer |
orders | Uma lista de mapas de pedidos.string |
orders[index].id | O ID completo do pedido Zonos, incluindo o ID da loja e o hífen.string |
orders[index].merchantOrderId | MerchantOrderId associado ao pedido por meio do terminal de serviço da API updateMerchantOrderId.string |
orders[index].orderStatus | O status atual do pedido para valores possíveis.string |
orders[index].orderStatusDate | A época que representa quando o status foi atualizado pela última vez.integer |
orders[index].orderStatusDateString | O carimbo de data/hora que representa quando o status foi atualizado pela última vez em UTC/GMT.timestamp |
orders[index].testOrder | Indica se o pedido era um "pedido de teste" ou um "pedido ativo".boolean |
orders[index].timestamp | O carimbo de data/hora que representa quando o pedido foi feito em UTC/GMT.timestamp |
totalCount | A contagem total de pedidos ativos e de teste recuperados.integer |
Números de pedido
Descubra como funciona o endpoint do número do pedido.O endpoint
orderNumbersé usado para recuperar com segurança uma lista de números de pedidos concluídos por meio de Zonos Checkout. Normalmente usado para correspondência de pedidos para garantir que todos os pedidos foram importados de uma data ou orderID, bem como pedidos dentro de um intervalo de datas.