Recuperar um pedido

Este endpoint de API "Recuperar um Pedido" é usado para recuperar dados de um pedido concluído dentro do Sistema Zonos. A resposta conterá um objeto JSON, representando todas as informações disponíveis para o pedido, incluindo endereços de faturamento e entrega, método de entrega, totais do pedido e status.

Endpoints 

Números de pedido

Recupera uma lista de números de pedido.

Detalhes do pedido

Recupera informações detalhadas de um pedido.

Uso do endpoint da API de Recuperação de Pedido

Existem duas maneiras comuns de usar esses endpoints.

1. (Parte 1 + Parte 2) – Use uma página de confirmação de pedido personalizada/sucesso em seu domínio para acionar seu sistema a chamar o endpoint orderDetail e importar um pedido concluído. Além disso, chame regularmente o endpoint orderNumbers para conciliar quaisquer pedidos no Sistema Zonos não importados para o seu sistema.
2. (Apenas Parte 2) – Use a página básica de confirmação de pedido/sucesso da Zonos ou uma página estática em seu domínio para indicar a conclusão do pedido ao cliente. Agende seu sistema para chamar regularmente o endpoint orderNumbers para determinar quando um novo pedido está pronto para ser importado em seu sistema. Quando um pedido pendente for encontrado, chame o endpoint orderDetail para os dados desses pedidos.

Parte 1: Página de sucesso em seu domínio

Toda vez que um comprador completa um pedido no Zonos Checkout, ele é imediatamente redirecionado para uma URL de página de sucesso do pedido. O ID do pedido concluído será anexado à URL de redirecionamento como uma string de consulta. A URL da página de sucesso do pedido deve ser fornecida à Zonos. A URL também pode ser passada como parâmetro no endpoint createTempCart ao criar o carrinho temporário no Sistema Zonos.

Exemplo: http://www.examplestore.com/internationalThankYou?orderId=999-99999

Quando um cliente é redirecionado para esta página, seu sistema precisará analisar o valor para orderId da URL. Em seguida, você usará o orderId para chamar o endpoint orderDetail e recuperar os dados do pedido.

Parte 2: Use um trabalho agendado

Além de chamar os detalhes do pedido quando a página de sucesso é acionada, recomendamos que você configure uma chamada agendada para todos os pedidos e seus detalhes como um catch-all. Dessa forma, você pode recuperar quaisquer pedidos concluídos no Sistema Zonos que ainda não foram importados para o seu sistema.

Esse processo deve ser um trabalho/script agendado, como um trabalho Cron, executado uma vez por hora/turno/dia/etc. (agende com a frequência que seus processos comerciais considerarem necessário). O script deve chamar todos os pedidos e seus detalhes que ocorreram desde a última chamada para pedidos. O endpoint orderNumbers permite que você recupere pedidos sinceOrderId ou sinceDate, conforme demonstrado na GUI de teste da API localizada aqui. Todos os pedidos recuperados por essa chamada agendada devem então ser conciliados com os pedidos inseridos em seu sistema cada vez que a página de sucesso foi acionada. Quaisquer pedidos ainda não em seu sistema devem ser inseridos em seu sistema e tratados como pedidos legítimos.

Status inicial do pedido

IGLOBAL_ORDER_IN_PROCESS ou IGLOBAL_FRAUD_REVIEW

Ao chamar o endpoint orderDetail, recomendamos que seu sistema primeiro verifique a propriedade orderStatus dos dados do pedido.

Pedidos que não requerem revisão de fraude iniciarão com orderStatus : IGLOBAL_ORDER_IN_PROCESS. Um pedido nesse status está pronto para ser processado e enviado.

Pedidos que requerem revisão de fraude iniciarão em orderStatus : IGLOBAL_FRAUD_REVIEW. Um pedido nesse status está sendo examinado e revisado por suspeita de fraude. Recomendamos que você coloque este pedido em um status de revisão ou espera em seu sistema e continue a chamar o endpoint orderDetail até que o pedido avance no processo de revisão de fraude da Zonos.

Assim que o processo de triagem de fraude da Zonos for concluído, o pedido passará para um dos seguintes estados:

• Pedido passa na triagem de fraude

  • O pedido passará para orderStatus : IGLOBAL_ORDER_IN_PROCESS e poderá continuar em direção ao envio.

• Pedido falha na triagem de fraude

  • O pedido passará para orderStatus : IGLOBAL_ORDER_CANCELLED e deve ser cancelado em seu sistema.

GUI de teste da API

Por favor, entre em contato com o suporte para obter suas credenciais de conta.