Hämta en order

Denna API-endpoint ”Retrieve an Order” används för att hämta data för en slutförd order i Zonos-systemet. Svaret innehåller ett JSON-objekt som representerar all tillgänglig information för ordern, inklusive fakturerings- och leveransadresser, fraktmetod, ordertotaler och status.

Endpoints 

Ordernummer

Hämtar en lista med ordernummer.

Orderdetaljer

Hämtar detaljerad information för en order.

Användning av API-endpointen Retrieve an order

Det finns två vanliga sätt att använda dessa endpoints.

1. (Del 1 + Del 2) – Använd en anpassad orderbekräftelse-/success-sida på er domän för att få ert system att anropa endpointen orderDetail och importera en slutförd order. Anropa dessutom regelbundet endpointen orderNumbers för att stämma av eventuella ordrar i Zonos-systemet som inte importerats till ert system.
2. (Endast Del 2) – Använd Zonos grundläggande orderbekräftelse-/success-sida eller en statisk sida på er domän för att meddela kunden att ordern är slutförd. Schemalägg ert system att regelbundet anropa endpointen orderNumbers för att avgöra när en ny order är redo att importeras till ert system. När en utestående order hittas, anropa endpointen orderDetail för data om dessa ordrar.

Del 1: Success-sida på er domän

Varje gång en köpare slutför en order i Zonos Checkout omdirigeras de omedelbart till en URL för orderns success-sida. Det slutförda order-ID:t läggs till i omdirigerings-URL:en som en querystring. URL:en till orderns success-sida ska anges till Zonos. URL:en kan också skickas som en parameter i endpointen createTempCart när den tillfälliga varukorgen skapas i Zonos-systemet.

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

När en kund omdirigeras till denna sida behöver ert system tolka värdet för orderId från URL:en. Ni använder sedan orderId för att anropa endpointen orderDetail och hämta orderdata.

Del 2: Använd ett schemalagt jobb

Utöver att anropa orderdetaljer när success-sidan utlöses rekommenderar vi att ni sätter upp ett schemalagt anrop för alla ordrar och deras detaljer som en säkerhetsåtgärd. På så sätt kan ni hämta eventuella slutförda ordrar i Zonos-systemet som ännu inte har importerats till ert system.

Denna process bör vara ett schemalagt jobb/skript, till exempel ett Cron-jobb, som körs en gång i timmen/per skift/per dag/etc. (schemalägg så ofta som era affärsprocesser kräver). Skriptet bör anropa alla ordrar och deras detaljer som har inträffat sedan det senaste anropet efter ordrar. Endpointen orderNumbers låter er hämta ordrar sinceOrderId eller sinceDate som visas i API-test-GUI:et här. Alla ordrar som hämtas via detta schemalagda anrop bör sedan stämmas av mot de ordrar som infogades i ert system varje gång success-sidan utlöstes. Eventuella ordrar som inte redan finns i ert system bör infogas i ert system och behandlas som giltiga ordrar.

Initial orderstatus

IGLOBAL_ORDER_IN_PROCESS eller IGLOBAL_FRAUD_REVIEW

När ni anropar endpointen orderDetail rekommenderar vi att ert system först kontrollerar egenskapen orderStatus i orderdata.

Ordrar som inte kräver bedrägerigranskning initieras med orderStatus : IGLOBAL_ORDER_IN_PROCESS. En order i denna status är redo att bearbetas och skickas.

Ordrar som kräver bedrägerigranskning initieras med orderStatus : IGLOBAL_FRAUD_REVIEW. En order i denna status granskas för närvarande för misstänkt bedrägeri. Vi rekommenderar att ni sätter denna order i gransknings- eller väntestatus i ert system och fortsätter att anropa endpointen orderDetail tills ordern har passerat Zonos bedrägerigranskningsprocess.

När Zonos bedrägerikontroll är klar går ordern till ett av följande tillstånd:

• Ordern klarar bedrägerikontrollen

  • Ordern går till orderStatus : IGLOBAL_ORDER_IN_PROCESS och kan fortsätta mot leverans.

• Ordern klarar inte bedrägerikontrollen

  • Ordern går till orderStatus : IGLOBAL_ORDER_CANCELLED och bör avbokas i ert system.

API-test-GUI

Kontakta support för era kontouppgifter.