Een order ophalen

Dit "Retrieve an Order" API-endpoint wordt gebruikt om gegevens op te halen voor een voltooide order in het Zonos-systeem. De response bevat een JSON-object met alle beschikbare informatie voor de order, inclusief facturatie- en verzendadressen, verzendmethode, ordertotalen en status.

Endpoints 

Ordernummers

Haalt een lijst met ordernummers op.

Orderdetails

Haalt gedetailleerde informatie op voor een order.

Gebruik van het Retrieve an Order API-endpoint

Er zijn twee veelgebruikte manieren om deze endpoints te gebruiken.

1. (Deel 1 + Deel 2) – Gebruik een aangepaste orderbevestigings-/succespagina op uw domein om uw systeem te activeren het orderDetail-endpoint aan te roepen en een voltooide order te importeren. Roep daarnaast regelmatig het orderNumbers-endpoint aan om orders in het Zonos-systeem te reconciliëren die nog niet in uw systeem zijn geïmporteerd.
2. (Alleen Deel 2) – Gebruik de basis orderbevestigings-/succespagina van Zonos of een statische pagina op uw domein om orderafronding aan de klant te tonen. Plan uw systeem om regelmatig het orderNumbers-endpoint aan te roepen om te bepalen wanneer een nieuwe order klaar is om in uw systeem te worden geïmporteerd. Wanneer een openstaande order wordt gevonden, roept u het orderDetail-endpoint aan voor de gegevens van die orders.

Deel 1: Succespagina op uw domein

Elke keer dat een koper een order voltooit in Zonos Checkout, wordt deze onmiddellijk doorgestuurd naar een order-succespagina-URL. Het voltooide order-ID wordt als querystring aan de redirect-URL toegevoegd. De URL van de order-succespagina moet aan Zonos worden doorgegeven. De URL kan ook als parameter worden doorgegeven in het createTempCart-endpoint bij het aanmaken van de tijdelijke winkelwagen in het Zonos-systeem.

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

Wanneer een klant naar deze pagina wordt doorgestuurd, moet uw systeem de waarde voor orderId uit de URL parseren. Vervolgens gebruikt u het orderId om het orderDetail-endpoint aan te roepen en de ordergegevens op te halen.

Deel 2: Gebruik een geplande taak

Naast het opvragen van orderdetails wanneer de succespagina wordt geactiveerd, raden wij aan een geplande aanroep in te stellen voor alle orders en hun details als vangnet. Zo kunt u voltooide orders in het Zonos-systeem ophalen die nog niet in uw systeem zijn geïmporteerd.

Dit proces moet een geplande taak/script zijn, zoals een Cron-job, die één keer per uur/dienst/dag/etc. wordt uitgevoerd (plan zo vaak als uw bedrijfsprocessen nodig achten). Het script moet alle orders en hun details ophalen die zijn plaatsgevonden sinds de laatste aanroep voor orders. Met het orderNumbers-endpoint kunt u orders ophalen sinceOrderId of sinceDate, zoals gedemonstreerd op de API-test-GUI. Alle orders die via deze geplande aanroep worden opgehaald, moeten worden gereconcilieerd met de orders die telkens zijn ingevoerd wanneer de succespagina werd geactiveerd. Orders die nog niet in uw systeem staan, moeten worden ingevoerd en als legitieme orders worden behandeld.

Initiële orderstatus

IGLOBAL_ORDER_IN_PROCESS of IGLOBAL_FRAUD_REVIEW

Bij het aanroepen van het orderDetail-endpoint raden wij aan dat uw systeem eerst de eigenschap orderStatus van de ordergegevens controleert.

Orders die geen fraudecontrole vereisen, initialiseren met orderStatus: IGLOBAL_ORDER_IN_PROCESS. Een order in deze status is klaar om te worden verwerkt en verzonden.

Orders die wel fraudecontrole vereisen, initialiseren in orderStatus: IGLOBAL_FRAUD_REVIEW. Een order in deze status wordt momenteel gescreend en beoordeeld op vermoedelijke fraude. Wij raden aan deze order op een review- of holdstatus in uw systeem te plaatsen en het orderDetail-endpoint te blijven aanroepen totdat de order voorbij het fraudecontroleproces van Zonos is gekomen.

Zodra het fraudecontroleproces van Zonos is voltooid, gaat de order over naar een van de volgende statussen:

• Order slaagt voor fraudecontrole

  • De order gaat over naar orderStatus: IGLOBAL_ORDER_IN_PROCESS en kan doorgaan naar verzending.

• Order faalt fraudecontrole

  • De order gaat over naar orderStatus: IGLOBAL_ORDER_CANCELLED en moet in uw systeem worden geannuleerd.

API-test-GUI

Neem contact op met support voor uw accountreferenties.