Zum Hauptinhalt springen

[Auftragseingang – GCW] Postback-Event-Payload-Referenzleitfaden

T
Verfasst von Toby Dawson
Vor über 3 Wochen aktualisiert

Dieser Leitfaden bietet Ihnen einen umfassenden Überblick über alle verfügbaren Datenfelder in den Payloads für verschiedene Postback-Trigger-Ereignisse in GelatoConnect. Wenn Sie diese Payloads verstehen, können Sie gezielt Vorlagen erstellen, die genau die Informationen herausfiltern, die Sie benötigen.

Einleitung

Wenn in GelatoConnect ein Postback-Ereignis ausgelöst wird, wird eine JSON-Nutzlast mit ereignisspezifischen Daten an Ihren konfigurierten Endpunkt gesendet oder für E-Mail-Benachrichtigungen verwendet. In diesem Dokument finden Sie eine Übersicht über Aufbau und Inhalt dieser Nutzlasten für jeden Ereignistyp. So wissen Sie genau, welche Daten Ihnen beim Erstellen Ihrer Vorlagen zur Verfügung stehen.

Inhaltsverzeichnis

Paketstatus aktualisiert

Dieses Payload wird empfangen, wenn sich der Status eines Pakets im System ändert.

{ "customer": { "id": "ea004496-8a31-42b7-b38a-77791152dbc7", "name": "Testkunde", "referenceId": "test-customer" }, "order": { "id": "ceebe91a-42e1-41ae-afdf-64569384f9bc", "referenceId": "Test-Bestellung", "metadata": { "isRush": "Falsch" } }, "package": { "id": "reference_package_id", "items": [ { "id": "1614240f-3d24-4d44-b632-b1bd91b1981c", "quantity": 1, "referenceId": "product_18_reference_id", "metadata": { "item-type": "Produkt", "Artikelnummer": "product_18_reference_id" } } ], "status": "versendet", "weight": 9 }, "shipment": { "fulfillmentLocation": { "country": "US", "stateProvince": "Wyoming" }, "method": { "id": "shipping_method_id", "name": "Name der Versandmethode" }, "tracking": { "code": "tracking_order_us", "url": "http://tracking.com/order_us" } }}

Wichtige Datenfelder

  • Kunde: Enthält Kundeninformationen wie ID, Name und Referenz-ID

  • order: Grundlegende Bestellinformationen und alle personalisierten Metadaten

  • Paket: Informationen zum Paket, einschließlich Status, Gewicht und enthaltenen Artikeln

  • shipment: Versanddetails wie Standort, Versandart und Sendungsverfolgung

Verspätete Bestellung

Diese Benachrichtigung erhalten Sie, wenn Bestellungen später als zum geplanten Versanddatum versendet werden.

{ "currentDate": "29.11.2024 15:55:12", "customerId": "9290728b-8534-4227-a191-8036eed9f060", "orders": [ { "orderId": "0743ce64d7_test_order_6", "orderReferenceId": "G-231211113145", "expectedDispatchDate": "2024-09-30" }, { "orderId": "0743ce64d7_test_order_128", "orderReferenceId": "G-231211113145", "expectedDispatchDate": "2024-11-13" } ]}

Wichtige Datenfelder

  • currentDate: Aktuelles Systemdatum und aktuelle Uhrzeit, zu der die Verzögerung festgestellt wurde

  • customerId: ID des Kunden, dem die verspäteten Bestellungen zugeordnet sind

  • orders: Liste der verspäteten Bestellungen, jeweils mit folgenden Angaben:

    • orderId: Die interne Bestellnummer von GelatoConnect

    • orderReferenceId: Ihre Referenznummer für die Bestellung

    • expectedDispatchDate: Das Versanddatum, das nicht eingehalten wurde

Bestellung storniert

Diese Nachricht erhalten Sie, wenn eine Bestellung storniert wird.

{ "created": "03.08.2018 07:26:52", "orderId": "a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9", "orderReferenceId": "J123X456", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "fulfillmentStatus": "storniert", "channel": "api", "comment": "Bestellung wurde erfolgreich storniert", "Artikel": [ { "itemReferenceId": "123", "fulfillmentStatus": "storniert", "metadata": { "item-type": "Produkt", "Artikelnummer": "123" } } ], "Metadaten": { "isRush": "Falsch" }}

Wichtige Datenfelder

  • created: Zeitpunkt, zu dem die Stornierung erfolgt ist

  • orderId: Die interne Bestellnummer von GelatoConnect

  • orderReferenceId: Ihre Referenznummer für die Bestellung

  • customerReferenceId: Referenznummer für den Kunden

  • fulfillmentStatus: Aktueller Status ("storniert")

  • comment: Informationen darüber, warum oder wie die Bestellung storniert wurde

  • items: Liste der Artikel in der Bestellung, jeder mit eigenem Status und eigenen Metadaten

  • metadata: Personalisierte Metadaten auf Bestellebene

Bestellung zugestellt

Diese Nachricht erhalten Sie, wenn eine Bestellung an den Empfänger zugestellt wurde.

{ "created": "03.08.2018 07:26:52", "fulfillmentStatus": "zugestellt", "orderReferenceId": "ASD4124123", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "channel": "api", "comment": "", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "zugestellt", "Fulfillment": [ { "trackingCode": "code123", "trackingUrl": "http://example.com/tracking?code=code123", "shipmentMethodName": "DHL Express Domestic BR", "shipmentMethodUid": "dhl_express_domestic_br", "fulfillmentCountry": "BR", "fulfillmentStateProvince": "SP", "deliveryDate": "2018-08-05T12:15:00+02:00", "recipientName": "John Doe", "recipientSignature": "Unterschriftsbild_URL" }, { "trackingCode": "code234", "trackingUrl": "http://example.com/tracking?code=code234", "shipmentMethodName": "DHL Express Domestic BR", "shipmentMethodUid": "dhl_express_domestic_br", "fulfillmentCountry": "BR", "fulfillmentStateProvince": "SP", "deliveryDate": "2018-08-05T12:30:00+02:00", "recipientName": "Jane Smith", "recipientSignature": "signature_image_url_2" } ], "metadata": { "item-type": "Produkt", "Artikelnummer": "123" } } ], "Metadaten": { "isRush": "Falsch" }}

Wichtige Datenfelder

  • created: Zeitpunkt, zu dem die Lieferung stattgefunden hat

  • fulfillmentStatus: Aktueller Status ("zugestellt")

  • orderReferenceId: Ihre Referenznummer für die Bestellung

  • items: Liste der Artikel in der Bestellung, jeweils mit folgenden Angaben:

    • fulfillments: Detaillierte Versandinformationen, einschließlich:

      • trackingCode und trackingUrl: Sendungsverfolgungsinformationen

      • shipmentMethodName: Name des Versanddienstleisters

      • deliveryDate: Wann der Artikel geliefert wurde

      • recipientName: Wer hat das Paket entgegengenommen

      • recipientSignature: URL zu einem Bild der Unterschrift (falls verfügbar)

Bestellung fehlgeschlagen

Diese Nachricht erhalten Sie, wenn eine Bestellung die Prüfung oder Verarbeitung nicht besteht.

{ "created": "03.08.2018 07:26:52", "orderId": "a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9", "orderReferenceId": "J123X456", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "fulfillmentStatus": "fehlgeschlagen", "channel": "api", "comment": "Bestellung konnte nicht übermittelt werden", "items": [ { "itemReferenceId": 123, "fulfillmentStatus": "fehlgeschlagen", "metadata": { "item-type": "Produkt", "Artikelnummer": "123" } } ], "Metadaten": { "isRush": "Falsch" }}

Wichtige Datenfelder

  • created: Zeitpunkt, an dem der Fehler aufgetreten ist

  • orderId: Die interne Bestellnummer von GelatoConnect

  • orderReferenceId: Ihre Referenznummer für die Bestellung

  • fulfillmentStatus: Aktueller Status ("fehlgeschlagen")

  • comment: Informationen darüber, warum die Bestellung fehlgeschlagen ist

  • items: Liste der Artikel in der Bestellung, jeweils mit eigenem Status und Metadaten

Bestellung unterwegs

Diese Nachricht erhalten Sie, wenn eine Bestellung auf dem Weg zum Empfänger ist.

{ "created": "17.09.2018 10:26:52", "fulfillmentStatus": "in_transit", "orderReferenceId": "J123X456", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "channel": "api", "comment": "Bestellung unterwegs", "Artikel": [ { "itemReferenceId": "123", "fulfillmentStatus": "in_transit", "Fulfillments": [ { "trackingCode": "code567", "trackingUrl": "http://example.com/tracking?code=code567", "shipmentMethodName": "DHL Express Domestic BR", "shipmentMethodUid": "dhl_express_domestic_br", "fulfillmentCountry": "BR", "fulfillmentStateProvince": "SP" } ] } ]}

Wichtige Datenfelder

  • created: Zeitpunkt, zu dem sich der Bestellstatus auf "in Zustellung" geändert hat

  • fulfillmentStatus: Aktueller Status ("in_transit")

  • orderReferenceId: Ihre Referenznummer für die Bestellung

  • items: Liste der Artikel in der Bestellung, jeweils mit folgenden Angaben:

    • fulfillments: Versandinformationen, einschließlich:

      • trackingCode und trackingUrl: Sendungsverfolgungsinformationen

      • shipmentMethodName: Name des Versanddienstleisters

      • fulfillmentCountry und fulfillmentStateProvince: Angaben zum Ursprungsort

Bestellung hergestellt

Diese Nachricht erhalten Sie, wenn eine Bestellung bereits gedruckt oder produziert wurde, aber noch nicht versendet ist.

{ "created": "03.08.2018 07:26:52", "orderId": "a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9", "orderReferenceId": "J123X456", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "fulfillmentStatus": "gedruckt", "channel": "api", "comment": "Bestellung wurde erfolgreich gedruckt", "Artikel": [ { "itemReferenceId": "123", "fulfillmentStatus": "gedruckt", "metadata": { "item-type": "Produkt", "Artikelnummer": "123" } } ], "metadata": { "isRush": "Falsch" }}

Wichtige Datenfelder

  • created: Zeitpunkt, zu dem die Bestellung erstellt wurde

  • orderId: Die interne Bestellnummer von GelatoConnect

  • orderReferenceId: Ihre Referenznummer für die Bestellung

  • fulfillmentStatus: Aktueller Status ("gedruckt")

  • comment: Informationen zur Produktion

  • items: Liste der Artikel in der Bestellung, jeder mit eigenem Status und eigenen Metadaten

Bestellung eingegangen

Diese Daten werden übermittelt, sobald eine Bestellung erfolgreich im System eingegangen und geprüft wurde.

{ "created": "03.08.2018 07:26:52", "orderId": "a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9", "orderReferenceId": "ASD4124123", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "fulfillmentStatus": "bestanden", "channel": "api", "comment": "Bestellung wurde erfolgreich übermittelt", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "bestanden", "metadata": { "item-type": "Produkt", "Artikelnummer": "123" } } ], "metadata": { "isRush": "Falsch" }}

Wichtige Datenfelder

  • created: Zeitpunkt, zu dem die Bestellung eingegangen ist

  • orderId: Die interne Bestellnummer von GelatoConnect

  • orderReferenceId: Ihre Referenznummer für die Bestellung

  • fulfillmentStatus: Aktueller Status ("bestanden")

  • comment: Informationen zur Überprüfung

  • items: Liste der Artikel in der Bestellung, jeder mit eigenem Status und eigenen Metadaten

Bestellung zurückgesendet

Diese Nachricht erhalten Sie, wenn eine Bestellung an den Absender zurückgeschickt wurde.

{ "created": "03.08.2018 07:26:52", "fulfillmentStatus": "retourniert", "orderReferenceId": "ASD4124123", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "channel": "api", "comment": "Bestellung wurde erfolgreich zurückgesendet", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "zurückgesendet", "Fulfillments": [ { "trackingCode": "code123", "trackingUrl": "http://example.com/tracking?code=code123", "shipmentMethodName": "DHL Express Domestic BR", "shipmentMethodUid": "dhl_express_domestic_br", "fulfillmentCountry": "BR", "fulfillmentStateProvince": "SP" }, { "trackingCode": "code234", "trackingUrl": "http://example.com/tracking?code=code234", "shipmentMethodName": "DHL Express Domestic BR", "shipmentMethodUid": "dhl_express_domestic_br", "fulfillmentCountry": "BR", "fulfillmentStateProvince": "SP" } ], "metadata": { "item-type": "Produkt", "Artikelnummer": "123" } } ], "metadata": { "isRush": "Falsch" }}

Wichtige Datenfelder

  • created: Zeitpunkt, zu dem die Rücksendung bearbeitet wurde

  • fulfillmentStatus: Aktueller Status ("zurückgesendet")

  • orderReferenceId: Ihre Referenznummer für die Bestellung

  • items: Liste der Artikel in der Bestellung, jeweils mit folgenden Angaben:

    • fulfillments: Rücksendeinformationen, einschließlich:

      • trackingCode und trackingUrl: Sendungsverfolgungsinformationen

      • shipmentMethodName: Name des Versanddienstleisters

      • fulfillmentCountry und fulfillmentStateProvince: Angaben zum Ursprungsort

Bestellung versandt

Diese Nachricht erhalten Sie, wenn eine Bestellung an den Empfänger versendet wurde.

{ "created": "03.08.2018 07:26:52", "fulfillmentStatus": "versendet", "orderReferenceId": "ASD4124123", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "channel": "api", "comment": "Bestellung wurde erfolgreich versendet", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "versendet", "fulfillments": [ { "trackingCode": "code123", "trackingUrl": "http://example.com/tracking?code=code123", "shipmentMethodName": "DHL Express Domestic BR", "shipmentMethodUid": "dhl_express_domestic_br", "fulfillmentCountry": "BR", "fulfillmentStateProvince": "SP" }, { "trackingCode": "code234", "trackingUrl": "http://example.com/tracking?code=code234", "shipmentMethodName": "DHL Express Domestic BR", "shipmentMethodUid": "dhl_express_domestic_br", "fulfillmentCountry": "BR", "fulfillmentStateProvince": "SP" } ], "metadata": { "item-type": "Produkt", "Artikelnummer": "123" } } ], "Metadaten": { "isRush": "Falsch" }}

Wichtige Datenfelder

  • created: Zeitpunkt, zu dem die Bestellung versendet wurde

  • fulfillmentStatus: Aktueller Status ("versendet")

  • orderReferenceId: Ihre Referenznummer für die Bestellung

  • items: Liste der Artikel in der Bestellung, jeweils mit folgenden Angaben:

    • fulfillments: Versandinformationen, einschließlich:

      • trackingCode und trackingUrl: Sendungsverfolgungsinformationen

      • shipmentMethodName: Name des Versanddienstleisters

      • fulfillmentCountry und fulfillmentStateProvince: Angaben zum Ursprungsort

Arbeiten mit Metadaten

Viele der Ereignis-Payloads enthalten Metadaten sowohl auf Bestell- als auch auf Artikelebene. Diese Metadaten bestehen aus personalisierten Schlüssel-Wert-Paaren, die Sie beim Absenden von Bestellungen festlegen können und die dann in den Rückmeldungen enthalten sind.

Beispiele für die Verwendung von Metadaten:

  1. Bestellbezogene Metadaten: metadata.isRush mit dem Wert "False"

  2. Metadaten auf Artikelebene: items[0].metadata.item-type mit dem Wert "product"

  3. Metadaten auf Artikelebene: items[0].metadata.sku mit dem Wert "123"

Diese Metadaten können verwendet werden, um zusätzliche Informationen hinzuzufügen, die nicht zu den Standardfeldern gehören – zum Beispiel Prioritätskennzeichen, Artikelnummern, Kategorien oder andere Daten, die Ihnen bei der Auftragsabwicklung helfen.

So nutzen Sie diese Payloads in Vorlagen

Wenn Sie Vorlagen für Postbacks erstellen, können Sie mit der Jinja2-Templating-Sprache auf jedes Feld in diesen Payloads zugreifen. Zum Beispiel:

  • So finden Sie die Bestellreferenznummer: ####{{ orderReferenceId }}

  • So erhalten Sie einen Tracking-Code: ####{{ items[0].fulfillments[0].trackingCode }}

  • So greifen Sie auf personalisierte Metadaten zu: ####{{ metadata.isRush }}

Weitere Informationen zur Erstellung von Vorlagen finden Sie unter Vorlagen für die Auftragserfassung erstellen und Beispiele für den Template Mapper.

Weitere Informationen zur Einrichtung von Postbacks finden Sie unter So richten Sie Postbacks ein.

Verwandte Artikel
[Auftragseingang – GCW] Wie richten Sie Postbacks ein?
[Auftragseingang – GCW] API-Dokumentation für das Auftragsmanagement
[Auftragseingang – GCW] Beispiele für Template Mapper
[Auftragseingang – GCW] Arbeiten mit Order-API-Endpunkten
[Auftragseingang – GCW] Verwendung von Kundenprodukten vs. ProductUID bei API-Bestellungen
Hat dies deine Frage beantwortet?