Hent en liste med ordrenumre eller detaljert informasjon om en ordre.
Dette "Hent en ordre"-API-endepunktet brukes til å hente data for en fullført ordre i Zonos System. Responsen vil inneholde et JSON-objekt som representerer all tilgjengelig informasjon for ordren, inkludert fakturerings- og forsendelsesadresser, forsendelsesmetode, ordretotaler og status.
Det er to vanlige måter å bruke disse endepunktene på.
(Del 1 + Del 2) – Bruk en tilpasset ordrebekreftelse / suksessside på domenet ditt for å utløse systemet ditt til å kalle orderDetail-endepunktet og importere en fullført ordre. I tillegg kaller du regelmessig orderNumbers-endepunktet for å forene eventuelle ordrer i Zonos System som ikke er importert i systemet ditt.
(Bare del 2) – Bruk den grunnleggende Zonos ordrebekreftelse / suksessside eller en statisk side på domenet ditt for å indikere ordrefullføring for kunden. Planlegg systemet ditt til å kalle orderNumbers-endepunktet regelmessig for å avgjøre når en ny ordre er klar til å importeres i systemet ditt. Når en utestående ordre blir funnet, kaller du orderDetail-endepunktet for dataene på disse ordrene.
Del 1: Suksessside på domenet ditt
Hver gang en kjøper fullfører en ordre i Zonos Checkout, blir de umiddelbart omdirigert til en ordrebekreftelsesside-URL. Den fullførte ordre-ID-en vil bli lagt til i omdirigerings-URL-en som en spørringsstreng. URL-en på ordrebekreftelsessiden skal gis til Zonos. URL-en kan også sendes som en parameter i createTempCart-endepunktet når du oppretter den midlertidige kurven i Zonos System.
Når en kunde blir omdirigert til denne siden, må systemet ditt analysere verdien for orderId fra URL-en. Du vil deretter bruke orderId til å kalle orderDetail-endepunktet for å hente ordredata.
Del 2: Bruk en planlagt jobb
I tillegg til å hente ordredetaljer når suksessiden blir utløst, anbefaler vi at du setter opp et planlagt kall som henter alle ordrer og detaljene deres som et sikkerhetsnett. På denne måten kan du hente eventuelle fullførte ordrer i Zonos System som ennå ikke har blitt importert i systemet ditt.
Denne prosessen bør være en planlagt jobb/skript, for eksempel en Cron-jobb, kjørt én gang i timen/skiftet/dagen/osv. (planlegg så ofte som dine forretningsprosesser finner det nødvendig). Skriptet skal hente alle ordrer og detaljene deres som har kommet inn siden forrige henting av ordrer. orderNumbers-endepunktet lar deg hente ordrer sinceOrderId eller sinceDate som demonstrert på API-test-GUI-en som ligger her. Alle ordrene som hentes gjennom dette planlagte kallet skal deretter forenes mot ordrene som ble satt inn i systemet ditt hver gang suksessiden ble utløst. Eventuelle ordrer som ikke allerede er i systemet ditt, skal settes inn i systemet ditt og behandles som legitime ordrer.
Innledende ordrestatus
IGLOBAL_ORDER_IN_PROCESS eller IGLOBAL_FRAUD_REVIEW
Når du kaller orderDetail-endepunktet, anbefaler vi at systemet ditt først sjekker orderStatus-egenskapen til ordredata.
Ordrer som ikke krever svindelgjennomgang, vil initialiseres med orderStatus: IGLOBAL_ORDER_IN_PROCESS. En ordre i denne statusen er klar til å bli behandlet og sendt.
Ordrer som krever svindelgjennomgang, vil initialiseres med orderStatus: IGLOBAL_FRAUD_REVIEW. En ordre i denne statusen blir for øyeblikket screenet og gjennomgått for mistenkt svindel. Vi anbefaler at du setter denne ordren i vurderings- eller ventestatus i systemet ditt og fortsetter å kalle orderDetail-endepunktet til ordren går forbi Zonos' svindelgjennomgangsprosess.
Når Zonos svindelscreening-prosessen er fullført, vil ordren flyttes til en av følgende tilstander:
Ordre godkjent gjennom svindelscreening
Ordren vil flytte til orderStatus: IGLOBAL_ORDER_IN_PROCESS og kan fortsette mot forsendelse.
Ordre mislykkes i svindelscreening
Ordren vil flytte til orderStatus: IGLOBAL_ORDER_CANCELLED og skal kanselleres i systemet ditt.
Hent en ordre
Hent en ordre
Hent en liste med ordrenumre eller detaljert informasjon om en ordre.
Dette "Hent en ordre"-API-endepunktet brukes til å hente data for en fullført ordre i Zonos System. Responsen vil inneholde et JSON-objekt som representerer all tilgjengelig informasjon for ordren, inkludert fakturerings- og forsendelsesadresser, forsendelsesmetode, ordretotaler og status.
Endepunkter
Ordrenumre
Henter en liste med ordrenumre.
Ordredetaljer
Henter detaljert informasjon for en ordre.
Bruk av API-endepunktet for å hente en ordre
Det er to vanlige måter å bruke disse endepunktene på.
orderDetail-endepunktet og importere en fullført ordre. I tillegg kaller du regelmessigorderNumbers-endepunktet for å forene eventuelle ordrer i Zonos System som ikke er importert i systemet ditt.orderNumbers-endepunktet regelmessig for å avgjøre når en ny ordre er klar til å importeres i systemet ditt. Når en utestående ordre blir funnet, kaller duorderDetail-endepunktet for dataene på disse ordrene.Del 1: Suksessside på domenet ditt
Hver gang en kjøper fullfører en ordre i Zonos Checkout, blir de umiddelbart omdirigert til en ordrebekreftelsesside-URL. Den fullførte ordre-ID-en vil bli lagt til i omdirigerings-URL-en som en spørringsstreng. URL-en på ordrebekreftelsessiden skal gis til Zonos. URL-en kan også sendes som en parameter i
createTempCart-endepunktet når du oppretter den midlertidige kurven i Zonos System.Example: http://www.examplestore.com/internationalThankYou?orderId=999-99999Når en kunde blir omdirigert til denne siden, må systemet ditt analysere verdien for
orderIdfra URL-en. Du vil deretter brukeorderIdtil å kalleorderDetail-endepunktet for å hente ordredata.Del 2: Bruk en planlagt jobb
I tillegg til å hente ordredetaljer når suksessiden blir utløst, anbefaler vi at du setter opp et planlagt kall som henter alle ordrer og detaljene deres som et sikkerhetsnett. På denne måten kan du hente eventuelle fullførte ordrer i Zonos System som ennå ikke har blitt importert i systemet ditt.
Denne prosessen bør være en planlagt jobb/skript, for eksempel en Cron-jobb, kjørt én gang i timen/skiftet/dagen/osv. (planlegg så ofte som dine forretningsprosesser finner det nødvendig). Skriptet skal hente alle ordrer og detaljene deres som har kommet inn siden forrige henting av ordrer.
orderNumbers-endepunktet lar deg hente ordrersinceOrderIdellersinceDatesom demonstrert på API-test-GUI-en som ligger her. Alle ordrene som hentes gjennom dette planlagte kallet skal deretter forenes mot ordrene som ble satt inn i systemet ditt hver gang suksessiden ble utløst. Eventuelle ordrer som ikke allerede er i systemet ditt, skal settes inn i systemet ditt og behandles som legitime ordrer.Innledende ordrestatus
IGLOBAL_ORDER_IN_PROCESSellerIGLOBAL_FRAUD_REVIEWNår du kaller
orderDetail-endepunktet, anbefaler vi at systemet ditt først sjekkerorderStatus-egenskapen til ordredata.Ordrer som ikke krever svindelgjennomgang, vil initialiseres med
orderStatus:IGLOBAL_ORDER_IN_PROCESS. En ordre i denne statusen er klar til å bli behandlet og sendt.Ordrer som krever svindelgjennomgang, vil initialiseres med
orderStatus:IGLOBAL_FRAUD_REVIEW. En ordre i denne statusen blir for øyeblikket screenet og gjennomgått for mistenkt svindel. Vi anbefaler at du setter denne ordren i vurderings- eller ventestatus i systemet ditt og fortsetter å kalleorderDetail-endepunktet til ordren går forbi Zonos' svindelgjennomgangsprosess.Når Zonos svindelscreening-prosessen er fullført, vil ordren flyttes til en av følgende tilstander:
Ordre godkjent gjennom svindelscreening
orderStatus:IGLOBAL_ORDER_IN_PROCESSog kan fortsette mot forsendelse.Ordre mislykkes i svindelscreening
orderStatus:IGLOBAL_ORDER_CANCELLEDog skal kanselleres i systemet ditt.API test GUI
Kontakt kundestøtte for å få påloggingsinformasjonen til kontoen din.
Var denne siden nyttig?