E-shop API – Bestellungen
Bestellereignisse: neue Bestellung, Statusänderung, Zahlung, Sendungsnummer, Stornierung eines Produkts und Gutschrift. Anfrageparameter, Auswahl der Benachrichtigung und Form der Antwort sind für alle gleich und werden in der Übersicht der E-shop API beschrieben.
API-URL
| ENDPOINT | EREIGNIS DER BENACHRICHTIGUNG |
|---|---|
https://portal.bulkgate.com/api/1.0/eshop/order/new |
order_new |
https://portal.bulkgate.com/api/1.0/eshop/order/change-status |
order_status_change_<order_status_id> |
https://portal.bulkgate.com/api/1.0/eshop/order/payment |
order_payment_complete, order_payment_confirmation |
https://portal.bulkgate.com/api/1.0/eshop/order/tracking-number |
order_tracking_number |
https://portal.bulkgate.com/api/1.0/eshop/order/product-cancel |
order_product_cancel |
https://portal.bulkgate.com/api/1.0/eshop/order/slip-add |
order_slip_add |
Erreicht die Anfrage ihr Ziel nicht, wiederholen Sie sie auf dem Backup-Server backup1.bulkgate.com.
Unterstützte HTTP-Methoden
POST-application/json
Neue Bestellung
eshop/order/new löst die Benachrichtigung des Ereignisses order_new aus. Senden Sie sie in dem Moment, in dem der Kunde die Bestellung abschließt.
Statusänderung der Bestellung
eshop/order/change-status sucht die Benachrichtigung für einen bestimmten Status. Den Namen des Ereignisses setzt es aus order_status_change_ und dem Wert der Variable order_status_id zusammen. Senden Sie order_status_id deshalb immer — ohne sie ordnet das Portal die Benachrichtigung keinem Status zu. Die Status, für die sich eine Benachrichtigung einrichten lässt, lädt Ihr Shop über die Einrichtung hoch.
Die obige Anfrage verwendet die Benachrichtigung, die für das Ereignis order_status_change_completed eingerichtet ist.
Bezahlung der Bestellung
eshop/order/payment sucht zuerst die Benachrichtigung order_payment_complete und verwendet, falls diese nicht eingerichtet ist, order_payment_confirmation. Kunden- und Administratorbenachrichtigung wählt es jeweils separat aus — der Kunde kann also order_payment_complete erhalten und die Administratoren order_payment_confirmation.
Sendungsnummer
eshop/order/tracking-number löst die Benachrichtigung order_tracking_number aus. Sendungsnummer und Versanddienstleister übergeben Sie in Variablen, z. B. order_carrier_tracking_number, order_carrier_name und order_carrier_url.
Stornierung eines Produkts und Gutschrift
eshop/order/product-cancellöst die Benachrichtigungorder_product_cancelaus — ein Produkt wurde aus der Bestellung storniert.eshop/order/slip-addlöst die Benachrichtigungorder_slip_addaus — zur Bestellung wurde eine Gutschrift ausgestellt.
Antwort
Die Bedeutung der Schlüssel customer und admin, Fehler beim Senden und die Fehlertypen finden Sie in der Übersicht der E-shop API.
Vielen Dank für Ihr Feedback.