Obter uma encomenda

Este endpoint da API “Retrieve an Order” é utilizado para obter os dados de uma encomenda concluída no sistema da Zonos. A resposta contém um objeto JSON que representa todas as informações disponíveis da encomenda, incluindo os endereços de faturação e de envio, o método de envio, os totais da encomenda e o estado.

Endpoints 

Números de encomenda

Obtém uma lista de números de encomenda.

Detalhes da encomenda

Obtém informações detalhadas de uma encomenda.

Utilização do endpoint da API Retrieve an Order

Existem duas formas comuns de utilizar estes endpoints.

1. (Parte 1 + Parte 2) – Utilize uma página personalizada de confirmação / sucesso da encomenda no seu domínio para fazer com que o seu sistema chame o endpoint orderDetail e importe uma encomenda concluída. Além disso, chame regularmente o endpoint orderNumbers para reconciliar as encomendas do sistema da Zonos que não tenham sido importadas para o seu sistema.
2. (Apenas Parte 2) – Utilize a página básica de confirmação / sucesso da encomenda da Zonos ou uma página estática no seu domínio para indicar ao cliente que a encomenda foi concluída. Programe o seu sistema para chamar regularmente o endpoint orderNumbers e determinar quando uma nova encomenda está pronta para ser importada para o seu sistema. Quando for encontrada uma encomenda pendente, chame o endpoint orderDetail para obter os dados dessas encomendas.

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

Sempre que um comprador conclui uma encomenda no Zonos Checkout, é imediatamente redirecionado para o URL de uma página de sucesso da encomenda. O ID da encomenda concluída é acrescentado ao URL de redirecionamento como uma query string. O URL da página de sucesso da encomenda deve ser fornecido à Zonos. O URL também pode ser passado como 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, o seu sistema tem de extrair o valor de orderId do URL. Em seguida, utiliza o orderId para chamar o endpoint orderDetail e obter os dados da encomenda.

Parte 2: Utilizar uma tarefa programada

Além de pedir os detalhes da encomenda quando a página de sucesso é acionada, recomendamos que configure uma chamada programada para todas as encomendas e respetivos detalhes, como medida de segurança abrangente. Desta forma, pode obter quaisquer encomendas concluídas no sistema da Zonos que ainda não tenham sido importadas para o seu sistema.

Este processo deve ser uma tarefa/script programado, como um Cron job, executado uma vez por hora/turno/dia/etc. (programe-o com a frequência que os seus processos de negócio considerarem necessária). O script deve pedir todas as encomendas e respetivos detalhes ocorridos desde o último pedido de encomendas. O endpoint orderNumbers permite obter encomendas por sinceOrderId ou sinceDate, como demonstrado na GUI de teste da API aqui indicada. Todas as encomendas obtidas através desta chamada programada devem depois ser reconciliadas com as encomendas inseridas no seu sistema sempre que a página de sucesso foi acionada. Quaisquer encomendas que ainda não estejam no seu sistema devem ser inseridas no mesmo e tratadas como encomendas legítimas.

Estado inicial da encomenda

IGLOBAL_ORDER_IN_PROCESS ou IGLOBAL_FRAUD_REVIEW

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

As encomendas que não requerem revisão de fraude são inicializadas com orderStatus: IGLOBAL_ORDER_IN_PROCESS. Uma encomenda neste estado está pronta para ser processada e enviada.

As encomendas que requerem revisão de fraude são inicializadas com orderStatus: IGLOBAL_FRAUD_REVIEW. Uma encomenda neste estado está a ser analisada e revista por suspeita de fraude. Recomendamos que coloque esta encomenda num estado de revisão ou de retenção no seu sistema e continue a chamar o endpoint orderDetail até que a encomenda ultrapasse o processo de revisão de fraude da Zonos.

Depois de concluído o processo de análise de fraude da Zonos, a encomenda passa para um dos seguintes estados:

• A encomenda passa na análise de fraude

  • A encomenda passa para orderStatus: IGLOBAL_ORDER_IN_PROCESS e pode avançar para o envio.

• A encomenda falha na análise de fraude

  • A encomenda passa para orderStatus: IGLOBAL_ORDER_CANCELLED e deve ser cancelada no seu sistema.

GUI de teste da API

Contacte o apoio ao cliente para obter as credenciais da sua conta.