Endpoint
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
Solicitação HTTPS
| Campo↕ | Notas↕ |
|---|---|
| Método HTTP | POST |
| URL do endpoint | https://api.iglobalstores.com/v1/updateMerchantOrderId |
| Protocolo | HTTPS |
| Formato da mensagem | JSON |
| Cabeçalho HTTP Accept | Accept: application/json |
| Cabeçalho HTTP Content-Type | Content-Type: application/json |
Pares chave/valor JSON no corpo da solicitação
1
{2
"store": "999",3
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",4
"orderId": "999-9999",5
"merchantOrderId": "12-34567"6
}Definições JSON da solicitação
| Campo↕ | Notas↕ |
|---|---|
merchantOrderId OBRIGATÓRIO | Este parâmetro é usado para passar o ID de pedido interno da sua loja ao pedido no sistema da Zonos. Isso é recomendado para melhor reconciliação, comunicação e auditoria.string |
orderId OBRIGATÓRIO | O ID de pedido da Zonos — pode ser enviado com ou sem o ID da sua loja e o hífen (Exemplo: 123-45678 ou 45678). Nota: Depois de concluir o pedido e o pagamento, o cliente será redirecionado para uma página de conclusão / agradecimento hospedada no seu domínio. A URL conterá um parâmetro de query string “orderId” com este valor.integer / string |
secret OBRIGATÓRIO | GUID secreto da API fornecido pela Zonos.string |
store OBRIGATÓRIO | ID da loja fornecido pela Zonosinteger |
Resposta HTTPS
1
{2
"success": "Updated Order: 99999 with new merchantOrderId: 12-34567"3
}Respostas HTTP de erro
| Código de erro↕ | Definição↕ |
|---|---|
| 406 - Not Acceptable | Entidade HTML. O cabeçalho HTTP “Accept” é inválido. |
| 415 - Unsupported media type | Entidade HTML. O cabeçalho HTTP “Content-Type” é inválido. |
| 200 | “error”:”could not parse input” |
| 200 | “error”:”Parameter orderId is required to processUpdateMerchantOrderId” |
| 200 | “error”:”Parameter merchantOrderId is required to updateMerchantOrderId.” |
| 200 | “error”:”orderId: 999-99999 is not a valid orderId” |
| 200 | “error”:”Could not retrieve order to updateMerchantOrderId for orderId: 999-99999” |
| 200 | “error”:”Could not process update merchant order id.” |
| 200 | “error”:”Invalid security credentials” |
Definições JSON da resposta
| Mensagem↕ | Definição↕ |
|---|---|
error | Este parâmetro só estará presente na resposta quando tiver ocorrido um erro e conterá uma descrição da causa.string |
success | Este parâmetro conterá um resumo da atualização.string |
Atualizar número do pedido
Saiba como o endpoint para atualizar um número de pedido funciona.
O endpoint
updateMerchantOrderIdé usado para atualizar um pedido no sistema da Zonos com o ID de pedido da sua loja para melhor reconciliação, comunicação e auditoria.