Nichts gefunden

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
Hinweis

Erreicht die Anfrage ihr Ziel nicht, wiederholen Sie sie auf dem Backup-Server backup1.bulkgate.com.

Unterstützte HTTP-Methoden

  • POST - application/json
POST /api/1.0/eshop/order/new HTTP/1.1 Host: portal.bulkgate.com Content-Type: 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.

POST /api/1.0/eshop/order/new HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "language": "de", "shop_id": "0", "variables": { "order_id": "10045", "order_total_paid": "49,90", "order_currency": "EUR", "order_payment": "Nachnahme", "customer_firstname": "Max", "customer_lastname": "Mustermann", "customer_email": "max.mustermann@example.com", "customer_mobile": "777777777", "customer_country_id": "cz" } }

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.

POST /api/1.0/eshop/order/change-status HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "language": "de", "variables": { "order_id": "10045", "order_status_id": "completed", "order_status": "Abgeschlossen", "customer_mobile": "777777777", "customer_country_id": "cz" } }

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.

POST /api/1.0/eshop/order/tracking-number HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "language": "de", "variables": { "order_id": "10045", "order_carrier_name": "DHL", "order_carrier_tracking_number": "JD014600006281230704", "customer_mobile": "777777777", "customer_country_id": "cz" } }

Stornierung eines Produkts und Gutschrift

  • eshop/order/product-cancel löst die Benachrichtigung order_product_cancel aus — ein Produkt wurde aus der Bestellung storniert.
  • eshop/order/slip-add löst die Benachrichtigung order_slip_add aus — zur Bestellung wurde eine Gutschrift ausgestellt.

Antwort

{ "data": { "customer": [ { "status": "accepted", "message_id": "tmpde1bcd4b1d1", "part_id": ["tmpde1bcd4b1d1"], "number": "420777777777", "channel": "sms" } ] } }

Die Bedeutung der Schlüssel customer und admin, Fehler beim Senden und die Fehlertypen finden Sie in der Übersicht der E-shop API.

War diese Seite hilfreich?