Recuperar um pedido

Este endpoint da API “Retrieve an Order” é usado para recuperar dados de um pedido concluído no sistema da Zonos. A resposta conterá um objeto JSON, representando todas as informações disponíveis do pedido, incluindo endereços de cobrança e envio, método de frete, 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 Retrieve an Order

Há duas formas comuns de usar esses endpoints.

1. (Parte 1 + Parte 2) – Use uma página personalizada de confirmação / sucesso do pedido no 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 reconciliar quaisquer pedidos no sistema da Zonos que não tenham sido importados para o seu sistema.
2. (Somente Parte 2) – Use a página básica de confirmação / sucesso do pedido da Zonos ou uma página estática no 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 no seu sistema. Quando um pedido pendente for encontrado, chame o endpoint orderDetail para obter os dados desses pedidos.

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

Toda vez que um comprador conclui 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 query string. A URL da página de sucesso do pedido deve ser fornecida à Zonos. A URL também pode ser passada como um parâmetro no endpoint createTempCart ao criar o carrinho temporário no sistema da Zonos.

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

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

Parte 2: Usar um job 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 uma proteção. Dessa forma, você pode recuperar quaisquer pedidos concluídos no sistema da Zonos que ainda não tenham sido importados para o seu sistema.

Esse processo deve ser um job/script agendado, como um Cron job, executado uma vez por hora/turno/dia/etc. (agende com a frequência que seus processos de negócios considerarem necessária). O script deve solicitar todos os pedidos e seus detalhes ocorridos desde a última chamada de pedidos. O endpoint orderNumbers permite recuperar 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 reconciliados com os pedidos inseridos no seu sistema cada vez que a página de sucesso foi acionada. Quaisquer pedidos que ainda não estejam no seu sistema devem ser inseridos 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 exigem revisão de fraude serão inicializados com orderStatus : IGLOBAL_ORDER_IN_PROCESS. Um pedido neste status está pronto para ser processado e enviado.

Pedidos que exigem revisão de fraude serão inicializados com orderStatus : IGLOBAL_FRAUD_REVIEW. Um pedido neste status está atualmente sendo analisado e revisado por suspeita de fraude. Recomendamos que você coloque este pedido em um status de revisão ou espera no seu sistema e continue a chamar o endpoint orderDetail até que o pedido avance além do processo de revisão de fraude da Zonos.

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

• O pedido passa na análise de fraude

  • O pedido passará para orderStatus : IGLOBAL_ORDER_IN_PROCESS e poderá seguir para o envio.

• O pedido falha na análise de fraude

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

GUI de teste da API

Entre em contato com o suporte para obter as credenciais da sua conta.