Endpoint
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
Requisiçã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 requisição
Exemplo
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"orderId": "999-9999",
"merchantOrderId": "12-34567"
}
Definições JSON da solicitação
| Campo | Notas |
|---|---|
merchantOrderId OBRIGATÓRIO | Este parâmetro é usado para passar o ID do pedido interno da sua loja para o pedido no sistema da Zonos. Isso é recomendado para uma melhor conciliação, comunicação e auditoria. string |
orderId OBRIGATÓRIO | O ID do pedido da Zonos - pode ser passado com ou sem o ID da sua loja e hífen (Exemplo: 123-45678 ou 45678).Nota: Após a conclusão do pedido e pagamento, o cliente será redirecionado para uma página de Conclusão do Pedido / Agradecimento pelo Pedido hospedada em seu domínio. A URL conterá um parâmetro de string de consulta "orderId" que conterá esse valor. inteiro / string |
secret OBRIGATÓRIO | GUID secreto da API fornecido pela Zonos. string |
store OBRIGATÓRIO | ID da loja fornecido pela Zonos. inteiro |
Resposta HTTPS
Exemplo de resposta de sucesso
1
2
3
{
"success": "Updated Order: 99999 with new merchantOrderId: 12-34567"
}
Exemplo de resposta de erro
1
2
3
{
"error": "Could not retrieve order to updateMerchantOrderId for orderId: 99999"
}
Respostas de erro HTTP
| Código de erro | Definição |
|---|---|
| 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 | "error": "não foi possível analisar a entrada" |
| 200 | "error": "O parâmetro orderId é necessário para processar o updateMerchantOrderId" |
| 200 | "error": "O parâmetro merchantOrderId é necessário para atualizar o merchantOrderId." |
| 200 | "error": "orderId: 999-99999 não é um orderId válido" |
| 200 | "error": "Não foi possível recuperar o pedido para atualizar o merchantOrderId para orderId: 999-99999" |
| 200 | "error": "Não foi possível processar a atualização do ID do pedido do comerciante." |
| 200 | "error": "Credenciais de segurança inválidas" |
Definições JSON de resposta
| Mensagem | Definição |
|---|---|
error | Este parâmetro estará presente na resposta apenas quando ocorrer 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 funciona o endpoint para atualizar um número de pedido.
O endpoint
updateMerchantOrderIdé usado para atualizar um pedido no sistema Zonos com o ID do pedido da sua loja para uma melhor conciliação, comunicação e auditoria.