Webhooks -- Payload-Referenz
Envelope-Struktur
Jeder Webhook hat die gleiche äußere Struktur. Nur der Inhalt von data variiert je nach Event und Detailgrad.
Feld | Typ | Beschreibung |
|---|---|---|
| string | Name des Events (z.B. |
| string | Payload-Version (aktuell |
| string | ISO-8601 Zeitstempel des Events |
| string | Eindeutiger Key zur Vermeidung doppelter Verarbeitung |
| integer | ID des Shops der das Event ausgelöst hat |
| boolean | Nur bei manuellen Test-Dispatches vorhanden ( |
| object | Event-spezifische Daten (abhängig vom Detailgrad) |
Data-Struktur je nach Event-Typ
Order-Events
Events: order.created, order.cancelled, order.packed, order.shipped, draft_order.created
LineItem-Events
Events: order.line_item.created, order.line_item.shipped, order.line_item.cancelled
Notification-Events
Events: notification.webhook_disabled
Detailgrad: Minimal
Nur IDs und Status. Das Zielsystem muss alle weiteren Daten selbst abrufen.
Order (minimal)
jsonwide760LineItem (minimal)
jsonwide760Detailgrad: Standard
Kernfelder inklusive Preise, Adressen, Versand und Zahlungsinformationen. Ohne schwere Daten wie Personalisierung, Downloads oder Druckdateien.
Order-Felder (standard)
Feld | Typ | Beschreibung |
|---|---|---|
| integer | Bestell-ID |
| string | Bestellcode |
| string | Standard-Bestellcode |
| string | Externer Bestellcode |
| string | Individueller Bestellcode |
| integer | Bestellnummer |
| integer | Bestellstatus (siehe Statustabelle) |
| Money | Gesamtbetrag |
| float | Nettobetrag |
| float | Bruttobetrag |
| float | Mehrwertsteuer |
| string | Zahlungsart |
| string | Kostenstelle |
| string | Bestellbemerkung |
| string (ISO-8601) | Bestelldatum |
| string (ISO-8601) | Lieferdatum |
| Address | Lieferadresse |
| Address | Rechnungsadresse |
| Shipping | Versanddetails |
| Payment | Zahlungsdetails |
OrderItem-Felder (standard)
Feld | Typ | Beschreibung |
|---|---|---|
| integer | Positions-ID |
| integer | Übergeordnete Position |
| integer | Bestell-ID |
| integer | Positionstyp (25=Artikel, 26=Print-on-Demand, ...) |
| integer | Menge |
| integer | Mengenwert |
| string | Positionsname |
| Money | Gesamtpreis |
| Money | Stückpreis |
| Money | Brutto |
| Money | Netto |
| string | Positionsstatus (siehe Statustabelle) |
| integer | Artikel-ID |
| integer | Artikeltyp |
| string | Kostenstelle |
| string | SAP-Nummer |
| string | Interner Name |
| string | Bemerkung |
| string (ISO-8601) | Liefertag |
| string (ISO-8601) | Wunschtermin |
Beispiel (standard)
jsonwide760Datentypen
Money
jsonwide760amount ist in der kleinsten Währungseinheit (Cent). 11900 = 119,00 EUR.
Address
jsonwide760Shipping
jsonwide760Payment
jsonwide760Bestellstatus-Werte (order.status)
Wert | Bedeutung |
|---|---|
61 | In Produktion |
62 | Im Versand |
63 | Zugestellt |
69 | Storniert |
73 | Wartet auf Freigabe |
74 | Freigabe abgelehnt |
88 | Freigabe erteilt |
117 | Erledigt |
137 | Bezahlt |
140 | Wartet auf Zahlungsanbieter |
144 | Wartet auf Kostenfreigabe |
155 | Wartet auf Zahlung |
156 | Zahlungserinnerung |
157 | Teilweise zugestellt |
158 | In Bearbeitung |
200 | Unvollständig |
Positionsstatus-Werte (orderItem.status)
Wert | Bedeutung |
|---|---|
OK | Freigegeben |
AUF FREIGABE WARTEN | Wartet auf Freigabe |
DRUCKFREIGABE ANFORDERN | Druckfreigabe angefordert |
AUF ZAHLUNG WARTEN | Wartet auf Zahlung |
WARTE AUF UPLOAD VON DATEN | Wartet auf Datenupload |
PACKED | Gepackt |
SHIPPED | Versendet |
STORNO | Storniert |
FREIGABE ABGELEHNT | Freigabe abgelehnt |
DRUCKFREIGABE ABGELEHNT | Druckfreigabe abgelehnt |
Test-Ping Payload
Der Test-Ping sendet das Event webhook.test:
HTTP-Header Referenz
Header | Immer vorhanden | Beschreibung |
|---|---|---|
| Ja |
|
| Ja | Event-Name (z.B. |
| Ja | HMAC-SHA256 Signatur: |
| Ja | Eindeutiger Key pro Event-Versand |
| Nein | Nur wenn Basic Auth oder Bearer Token konfiguriert |
Custom Header | Nein | Nur wenn Custom Header konfiguriert (z.B. |