Slutpunkter
Beställningsnummer
Hämtar en lista över beställningsnummer.
Beställningsdetaljer
Hämtar detaljerad information för en beställning.
Användning av API-slutpunkten för att hämta en beställning
Det finns två vanliga sätt att använda dessa slutpunkter.
- (Del 1 + Del 2) – Använd en anpassad bekräftelse-/framgångssida på din domän för att trigga ditt system att anropa
orderDetail
-slutpunkten och importera en slutförd beställning. Dessutom, anropa regelbundetorderNumbers
-slutpunkten för att stämma av eventuella beställningar i Zonos-systemet som inte har importerats till ditt system. - (Endast Del 2) – Använd Zonos grundläggande bekräftelse-/framgångssida eller en statisk sida på din domän för att indikera beställningens slutförande för kunden. Schemalägg ditt system att regelbundet anropa
orderNumbers
-slutpunkten för att avgöra när en ny beställning är redo att importeras till ditt system. När en utestående beställning hittas, anropaorderDetail
-slutpunkten för att hämta data om dessa beställningar.
Del 1: Framgångssida på din domän
Varje gång en köpare slutför en beställning i Zonos Checkout, omdirigeras de omedelbart till en URL för en framgångssida för beställningen. Den slutförda beställnings-ID:n kommer att läggas till i omdirigerings-URL:en som en frågesträng. URL:en för framgångssidan för beställningen bör tillhandahållas till Zonos. URL:en kan också skickas som en parameter i createTempCart
-slutpunkten när den temporära kundvagnen skapas i Zonos-systemet.
Exempel: http://www.examplestore.com/internationalThankYou?orderId=999-99999
När en kund omdirigeras till denna sida, kommer ditt system att behöva analysera värdet för orderId
från URL:en. Du kommer sedan att använda orderId
för att anropa orderDetail
-slutpunkten för att hämta beställningsdata.
Del 2: Använd ett schemalagt jobb
Förutom att anropa beställningsdetaljer när framgångssidan triggas, rekommenderar vi att du ställer in ett schemalagt anrop för alla beställningar och deras detaljer som en fångst. På så sätt kan du hämta eventuella slutförda beställningar i Zonos-systemet som ännu inte har importerats till ditt system.
Denna process bör vara ett schemalagt jobb/script, som ett Cron-jobb, som körs en gång i timmen/skift/dag/etc. (schemalägg så ofta som dina affärsprocesser anser nödvändigt). Skriptet bör anropa alla beställningar och deras detaljer som har inträffat sedan det senaste anropet för beställningar. orderNumbers
-slutpunkten gör att du kan hämta beställningar sinceOrderId
eller sinceDate
som demonstrerat på API-test-GUI:n som finns här. Alla beställningar som hämtas genom detta schemalagda anrop bör sedan stämmas av mot de beställningar som har lagts in i ditt system varje gång framgångssidan triggas. Eventuella beställningar som inte redan finns i ditt system bör läggas in i ditt system och behandlas som legitima beställningar.
Inledande beställningsstatus
IGLOBAL_ORDER_IN_PROCESS
eller IGLOBAL_FRAUD_REVIEW
När du anropar orderDetail
-slutpunkten rekommenderar vi att ditt system först kontrollerar orderStatus
-egenskapen för beställningsdatan.
Beställningar som inte kräver bedrägerigranskning kommer att initieras med orderStatus
: IGLOBAL_ORDER_IN_PROCESS
. En beställning i denna status är redo att behandlas och skickas.
Beställningar som kräver bedrägerigranskning kommer att initieras i orderStatus
: IGLOBAL_FRAUD_REVIEW
. En beställning i denna status granskas för misstänkt bedrägeri. Vi rekommenderar att du placerar denna beställning i en granskning eller hållstatus i ditt system och fortsätter att anropa orderDetail
-slutpunkten tills beställningen går vidare i Zonos’ bedrägerigranskningsprocess.
När Zonos bedrägerigranskningsprocess är slutförd kommer beställningen att gå till ett av följande tillstånd:
-
Beställning passerar bedrägerigranskning
- Beställningen kommer att gå till
orderStatus
:IGLOBAL_ORDER_IN_PROCESS
och kan fortsätta mot leverans.
- Beställningen kommer att gå till
-
Beställning misslyckas med bedrägerigranskning
- Beställningen kommer att gå till
orderStatus
:IGLOBAL_ORDER_CANCELLED
och bör avbrytas i ditt system.
- Beställningen kommer att gå till
API-test GUI
Vänligen kontakta supporten för dina kontouppgifter.
Hämta en beställning
Hämta en lista över beställningsnummer eller detaljerad information om en beställning.
Denna “Hämta en beställning” API-slutpunkt används för att hämta data för en slutförd beställning inom Zonos-systemet. Svaret kommer att innehålla ett JSON-objekt som representerar all tillgänglig information för beställningen, inklusive fakturerings- och leveransadresser, fraktmetod, beställningens totalsummor och status.