Endpunkte
Bestellnummern
Ruft eine Liste von Bestellnummern ab.
Bestelldetails
Ruft detaillierte Informationen zu einer Bestellung ab.
Verwendung des API-Endpunkts „Retrieve an Order“
Es gibt zwei gängige Möglichkeiten, diese Endpunkte zu verwenden.
- (Teil 1 + Teil 2) – Verwenden Sie eine benutzerdefinierte Bestellbestätigungs-/Erfolgsseite auf Ihrer Domain, um Ihr System dazu zu veranlassen, den
orderDetail-Endpunkt aufzurufen und eine abgeschlossene Bestellung zu importieren. Rufen Sie zusätzlich regelmäßig denorderNumbers-Endpunkt auf, um Bestellungen im Zonos-System abzugleichen, die noch nicht in Ihr System importiert wurden. - (Nur Teil 2) – Verwenden Sie die einfache Bestellbestätigungs-/Erfolgsseite von Zonos oder eine statische Seite auf Ihrer Domain, um dem Kunden den Abschluss der Bestellung anzuzeigen. Planen Sie, dass Ihr System regelmäßig den
orderNumbers-Endpunkt aufruft, um festzustellen, wann eine neue Bestellung zum Import in Ihr System bereit ist. Wenn eine ausstehende Bestellung gefunden wird, rufen Sie denorderDetail-Endpunkt für die Daten dieser Bestellungen auf.
Teil 1: Erfolgsseite auf Ihrer Domain
Jedes Mal, wenn ein Käufer eine Bestellung im Zonos Checkout abschließt, wird er sofort auf eine URL der Bestellerfolgsseite weitergeleitet. Die ID der abgeschlossenen Bestellung wird der Weiterleitungs-URL als Query-String angehängt. Die URL der Bestellerfolgsseite sollte Zonos mitgeteilt werden. Die URL kann auch als Parameter im createTempCart-Endpunkt übergeben werden, wenn der temporäre Warenkorb im Zonos-System erstellt wird.
Example: http://www.examplestore.com/internationalThankYou?orderId=999-99999
Wenn ein Kunde auf diese Seite weitergeleitet wird, muss Ihr System den Wert für orderId aus der URL auslesen. Anschließend verwenden Sie die orderId, um den orderDetail-Endpunkt aufzurufen und die Bestelldaten abzurufen.
Teil 2: Geplanten Job verwenden
Zusätzlich zum Abrufen von Bestelldetails, wenn die Erfolgsseite ausgelöst wird, empfehlen wir, einen geplanten Aufruf für alle Bestellungen und deren Details als Sicherheitsnetz einzurichten. So können Sie alle abgeschlossenen Bestellungen im Zonos-System abrufen, die noch nicht in Ihr System importiert wurden.
Dieser Prozess sollte ein geplanter Job bzw. ein Skript sein, z. B. ein Cron-Job, der einmal pro Stunde/Schicht/Tag usw. ausgeführt wird (planen Sie so häufig, wie Ihre Geschäftsprozesse es erfordern). Das Skript sollte alle Bestellungen und deren Details abrufen, die seit dem letzten Abruf von Bestellungen aufgetreten sind. Mit dem orderNumbers-Endpunkt können Sie Bestellungen sinceOrderId oder sinceDate abrufen, wie in der API-Test-GUI hier gezeigt. Alle über diesen geplanten Aufruf abgerufenen Bestellungen sollten dann mit den Bestellungen abgeglichen werden, die jedes Mal eingefügt wurden, wenn die Erfolgsseite ausgelöst wurde. Bestellungen, die noch nicht in Ihrem System vorhanden sind, sollten eingefügt und als gültige Bestellungen behandelt werden.
Anfänglicher Bestellstatus
IGLOBAL_ORDER_IN_PROCESS oder IGLOBAL_FRAUD_REVIEW
Beim Aufruf des orderDetail-Endpunkts empfehlen wir, dass Ihr System zunächst die Eigenschaft orderStatus der Bestelldaten prüft.
Bestellungen, die keine Betrugsprüfung erfordern, werden mit orderStatus : IGLOBAL_ORDER_IN_PROCESS initialisiert. Eine Bestellung in diesem Status ist bereit zur Bearbeitung und zum Versand.
Bestellungen, die eine Betrugsprüfung erfordern, werden mit orderStatus : IGLOBAL_FRAUD_REVIEW initialisiert. Eine Bestellung in diesem Status wird derzeit auf mutmaßlichen Betrug geprüft und überprüft. Wir empfehlen, diese Bestellung in Ihrem System auf einen Prüf- oder Haltestatus zu setzen und den orderDetail-Endpunkt weiterhin aufzurufen, bis die Bestellung den Betrugsprüfungsprozess von Zonos durchlaufen hat.
Sobald der Betrugsprüfungsprozess von Zonos abgeschlossen ist, wechselt die Bestellung in einen der folgenden Zustände:
-
Bestellung besteht die Betrugsprüfung
- Die Bestellung wechselt zu
orderStatus:IGLOBAL_ORDER_IN_PROCESSund kann zum Versand weiterverarbeitet werden.
- Die Bestellung wechselt zu
-
Bestellung besteht die Betrugsprüfung nicht
- Die Bestellung wechselt zu
orderStatus:IGLOBAL_ORDER_CANCELLEDund sollte in Ihrem System storniert werden.
- Die Bestellung wechselt zu
API-Test-GUI
Bitte kontaktieren Sie den Support für Ihre Kontozugangsdaten.
Bestellung abrufen
Rufen Sie eine Liste von Bestellnummern oder detaillierte Informationen zu einer Bestellung ab.
Dieser API-Endpunkt „Retrieve an Order“ wird verwendet, um Daten für eine abgeschlossene Bestellung im Zonos-System abzurufen. Die Antwort enthält ein JSON-Objekt mit allen verfügbaren Informationen zur Bestellung, einschließlich Rechnungs- und Lieferadressen, Versandmethode, Bestellsummen und Status.