Deze gids geeft een compleet overzicht van alle beschikbare gegevensvelden in de payload voor verschillende postback-triggergebeurtenissen in GelatoConnect. Als je deze payloads begrijpt, kun je makkelijk effectieve sjablonen maken die precies de informatie halen die jij nodig hebt.

Introductie

Wanneer er een postback-event wordt geactiveerd in GelatoConnect, wordt er een JSON-payload met event-specifieke gegevens naar jouw ingestelde endpoint gestuurd of gebruikt in e-mailnotificaties. In dit document vind je de structuur en inhoud van deze payloads per type event, zodat je precies weet welke gegevens je kunt gebruiken bij het maken van je sjablonen.

Inhoudsopgave

Pakketstatus bijgewerkt

Deze payload ontvang je wanneer de status van een pakket verandert in het systeem.

{ "klant": { "id": "ea004496-8a31-42b7-b38a-77791152dbc7", "name": "Testklant", "referenceId": "test-customer" }, "order": { "id": "ceebe91a-42e1-41ae-afdf-64569384f9bc", "referenceId": "Test-order", "metadata": { "isRush": "Onwaar" } }, \"package\": { "id": "referentie_pakket_id", "items": [ { "id": "1614240f-3d24-4d44-b632-b1bd91b1981c", "aantal": 1, \"referenceId\": \"product_18_reference_id\", \"metadata\": { "item-type": "product", "sku": "product_18_reference_id" } } ], "status": "verzonden", \"gewicht\": 9 }, "shipment": { "fulfillmentLocation": { "country": "VS", "stateProvince": "Wyoming" }, "methode": { "id": "shipping_method_id", "name": "Naam verzendmethode" }, "tracking": { "code": "tracking_order_us", "url": "http://tracking.com/order_us" } }}

Belangrijke gegevensvelden

customer: Bevat klantinformatie zoals ID, naam en referentie-ID
order: Basisinformatie over de bestelling en alle gepersonaliseerde metadata
pakket: Alles over het pakket, zoals de status, het gewicht en de inhoud
shipment: Verzending details zoals locatie, verzendmethode en track & trace informatie

Vertraagde bestelling

Deze payload ontvang je als bestellingen later zijn dan de verwachte verzenddatum.

{ "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" } ]}

Belangrijke gegevensvelden

currentDate: Huidige systeemdatum en -tijd waarop de vertraging werd opgemerkt
customerId: ID van de klant die hoort bij de vertraagde bestellingen
orders: Lijst van vertraagde bestellingen, elk met:
- orderId: het interne order-ID van GelatoConnect
- orderReferenceId: Jouw referentie-ID voor de bestelling
- expectedDispatchDate: De verzenddatum die niet is gehaald

Bestelling geannuleerd

Deze payload ontvang je als een bestelling wordt geannuleerd.

{ "created": "03-08-2018 07:26:52", "orderId": "a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9", "orderReferenceId": "J123X456", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "fulfillmentStatus": "geannuleerd", "channel": "api", "comment": "Bestelling is succesvol geannuleerd.", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "geannuleerd", "metadata": { "item-type": "product", "sku": "123" } } ], "metadata": { "isRush": "Onwaar" }}

Belangrijke gegevensvelden

created: Tijdstip waarop de annulering heeft plaatsgevonden
orderId: het interne order-ID van GelatoConnect
orderReferenceId: Jouw referentie-ID voor de bestelling
customerReferenceId: Referentie-ID voor de klant
fulfillmentStatus: Huidige status ("geannuleerd")
comment: Informatie over waarom of hoe de bestelling is geannuleerd
items: Lijst van artikelen in de bestelling, elk met een eigen status en extra informatie
metadata: Gepersonaliseerde metadata op orderniveau

Bestelling bezorgd

Deze payload ontvang je zodra een bestelling is bezorgd bij de ontvanger.

{ "created": "03-08-2018 07:26:52", "fulfilmentStatus": "geleverd", "orderReferenceId": "ASD4124123", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "channel": "api", "comment": "", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "geleverd", "fulfilments": [ { "trackingCode": "code123", "trackingUrl": "http://example.com/tracking?code=code123", "shipmentMethodName": "DHL Express Binnenland BR", "shipmentMethodUid": "dhl_express_domestic_br", "fulfillmentCountry": "BR", "fulfillmentStateProvince": "SP", "deliveryDate": "2018-08-05T10:15:00+00:00", "recipientName": "John Doe", "recipientSignature": "signature_image_url" }, { "trackingCode": "code234", "trackingUrl": "http://example.com/tracking?code=code234", "shipmentMethodName": "DHL Express binnenland BR", "shipmentMethodUid": "dhl_express_domestic_br", "fulfilmentCountry": "BR", "fulfillmentStateProvince": "SP", "deliveryDate": "05-08-2018T10:30:00+00:00", "recipientName": "Jane Smith", "recipientSignature": "signature_image_url_2" } ], "metadata": { "item-type": "product", "sku": "123" } } ], "metadata": { "isRush": "Onwaar" }}

Belangrijke gegevensvelden

created: Tijdstip waarop de levering heeft plaatsgevonden
fulfillmentStatus: Huidige status ("geleverd")
orderReferenceId: Jouw referentie-ID voor de bestelling
items: Lijst van artikelen in de bestelling, elk met:
- fulfilments: Uitgebreide bezorginformatie, zoals:
  - trackingCode en trackingUrl: Informatie over de zending
  - shipmentMethodName: Naam van de vervoerder
  - deliveryDate: Wanneer het item is bezorgd
  - recipientName: Wie heeft het pakket ontvangen
  - recipientSignature: URL naar een afbeelding van de handtekening (indien beschikbaar)

Bestelling mislukt

Deze payload ontvang je als een bestelling niet door de controle of verwerking komt.

{ "created": "03-08-2018 07:26:52", "orderId": "a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9", "orderReferenceId": "J123X456", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "fulfilmentStatus": "mislukt", "channel": "api", "comment": "Bestelling plaatsen is mislukt", "items": [ { "itemReferenceId": 123, "fulfillmentStatus": "mislukt", "metadata": { "item-type": "product", "sku": "123" } } ], "metadata": { "isRush": "Onwaar" }}

Belangrijke gegevensvelden

created: Tijdstip waarop het probleem is ontstaan
orderId: het interne order-ID van GelatoConnect
orderReferenceId: Jouw referentie-ID voor de bestelling
fulfillmentStatus: Huidige status ("mislukt")
comment: Informatie over waarom de bestelling is mislukt
items: Lijst van items in de bestelling, elk met een eigen status en metadata

Bestelling onderweg

Deze payload ontvang je wanneer een bestelling onderweg is naar de ontvanger.

{ "created": "17-09-2018 10:26:52", "fulfilmentStatus": "in_transit", "orderReferenceId": "J123X456", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "channel": "api", "comment": "Bestelling onderweg", "items": [ { "itemReferenceId": "123", "fulfilmentStatus": "in_transit", "fulfilments": [ { "trackingCode": "code567", "trackingUrl": "http://example.com/tracking?code=code567", \"shipmentMethodName\": \"DHL Express Domestic BR\", "shipmentMethodUid": "dhl_express_domestic_br", "fulfillmentCountry": "BR", "fulfilmentStateProvince": "SP" } ] } ]}

Belangrijke gegevensvelden

created: Tijdstip waarop de orderstatus is veranderd naar onderweg
fulfillmentStatus: Huidige status ("in_transit")
orderReferenceId: Jouw referentie-ID voor de bestelling
items: Array van items in de bestelling, elk bevat:
- fulfillments: Verzendgegevens, waaronder:
  - trackingCode en trackingUrl: Track & trace informatie
  - shipmentMethodName: Naam vervoerder
  - fulfillmentCountry en fulfillmentStateProvince: Herkomstinformatie

Bestelling Geproduceerd

Deze payload ontvang je wanneer een bestelling is gedrukt of geproduceerd, maar nog niet is verzonden.

{ "created": "03-08-2018 07:26:52", "orderId": "a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9", "orderReferenceId": "J123X456", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "fulfilmentStatus": "gedrukt", "channel": "api", \"comment\": \"Bestelling succesvol afgedrukt\", "items": [ { "itemReferenceId": "123", \"fulfillmentStatus\": \"gedrukt\", "metadata": { "item-type": "product", \"sku\": \"123\" } } ], "metadata": { "isRush": "Onwaar" }}

Belangrijke gegevensvelden

created: Tijdstempel van wanneer de bestelling is geproduceerd
orderId: de interne order-ID van GelatoConnect
orderReferenceId: Je referentie-ID voor de bestelling
fulfillmentStatus: Huidige status (\"afgedrukt\")
comment: Informatie over de productie
items: Lijst van items in de bestelling, elk met een eigen status en extra informatie

Bestelling ontvangen

Deze payload wordt ontvangen wanneer een bestelling succesvol is ontvangen en gevalideerd in het systeem.

{ "created": "03-08-2018 07:26:52", \"orderId\": \"a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9\", \"orderReferenceId\": \"ASD4124123\", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", \"fulfillmentStatus\": \"passed\", \"channel\": \"api\", \"opmerking\": \"Bestelling succesvol doorgegeven\", \"items\": [ { "itemReferenceId": "123", \"fulfillmentStatus\": \"passed\", "metadata": { "item-type": "product", "sku": "123" } } ], \"metadata\": { \"isRush\": \"False\" }}

Belangrijke gegevensvelden

created: Tijdstempel van wanneer de bestelling is ontvangen
orderId: het interne order-ID van GelatoConnect
orderReferenceId: Uw referentie-ID voor de bestelling
fulfillmentStatus: Huidige status (\"geslaagd\")
comment: Informatie over de validatie
items: Lijst van items in de bestelling, elk met een eigen status en metadata

Bestelling teruggestuurd

Deze melding ontvang je als een bestelling teruggestuurd is naar de afzender.

{ "created": "2018-08-03T07:26:52+00:00", \"fulfillmentStatus\": \"geretourneerd\", \"orderReferenceId\": \"ASD4124123\", \"customerReferenceId\": \"b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0\", "channel": "api", "comment": "Bestelling succesvol teruggestuurd", "items": [ { \"itemReferenceId\": \"123\", "fulfillmentStatus": "geretourneerd", "fulfilments": [ { \"trackingCode\": \"code123\", "trackingUrl": "http://example.com/tracking?code=code123", "shipmentMethodName": "DHL Express Binnenland BR", "shipmentMethodUid": "dhl_express_domestic_br", "fulfilmentCountry": "BR", \"fulfilmentStateProvince\": \"SP\" }, { "trackingCode": "code234", "trackingUrl": "http://example.com/tracking?code=code234", \"shipmentMethodName\": \"DHL Express Domestic BR\", \"shipmentMethodUid\": \"dhl_express_domestic_br\", "fulfilmentCountry": "BR", "fulfilmentStateProvince": "SP" } ], "metadata": { "item-type": "product", "sku": "123" } } ], "metadata": { "isRush": "Onwaar" }}

Belangrijke gegevensvelden

created: Tijdstip waarop de retourzending is verwerkt
fulfillmentStatus: Huidige status ("geretourneerd")
orderReferenceId: Uw referentie-ID voor de bestelling
items: Array van items in de bestelling, elk bevat:
- fulfilments: Retourzending informatie, waaronder:
  - trackingCode en trackingUrl: Traceerinformatie
  - shipmentMethodName: Naam van de vervoerder
  - fulfillmentCountry en fulfillmentStateProvince: informatie over de herkomst

Bestelling verzonden

Deze payload wordt ontvangen wanneer een bestelling naar de ontvanger is verzonden.

{ \"created\": \"2018-08-03T07:26:52+00:00\", "fulfillmentStatus": "verzonden", \"orderReferenceId\": \"ASD4124123\", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", \"channel\": \"api\", \"comment\": \"Bestelling succesvol verzonden\", "items": [ { \"itemReferenceId\": \"123\", "fulfillmentStatus": "verzonden", "fulfilments": [ { "trackingCode": "code123", \"trackingUrl\": \"http://example.com/tracking?code=code123\", "shipmentMethodName": "DHL Express Binnenland 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\", "fulfilmentCountry": "BR", \"fulfilmentStateProvince\": \"SP\" } ], \"metadata\": { \"item-type\": \"product\", \"sku\": \"123\" } } ], "metadata": { \"isRush\": \"False\" }}

Belangrijke gegevensvelden

created: Tijdstempel van wanneer de bestelling is verzonden
fulfillmentStatus: Huidige status ("verzonden")
orderReferenceId: Jouw referentie-ID voor de bestelling
items: Array van items in de bestelling, elk bevat:
- fulfillments: Verzendgegevens, waaronder:
  - trackingCode en trackingUrl: Tracking informatie
  - shipmentMethodName: Naam vervoerder
  - fulfillmentCountry en fulfillmentStateProvince: Herkomstinformatie

Werken met metadata

Veel van de gebeurtenisgegevens bevatten metadata op zowel order- als artikelniveau. Deze metadata bevat gepersonaliseerde sleutel-waardeparen die je kunt definiëren bij het indienen van bestellingen, die vervolgens worden opgenomen in postback-gebeurtenissen.

Voorbeelden van het gebruik van metadata:

Metadata op orderniveau: metadata.isRush met waarde \"False\"
Item-niveau metadata: items[0].metadata.item-type met waarde \"product\"
Item-level metadata: items[0].metadata.sku met waarde \"123\"

Deze metadata kan worden gebruikt om aanvullende informatie toe te voegen die geen deel uitmaakt van de standaardvelden, zoals prioriteitsvlaggen, SKU's, categorieën of andere gegevens die helpen bij de verwerking van je bestelling.

Deze payloads gebruiken in templates

Bij het maken van sjablonen voor postbacks kun je naar elk veld in deze payloads verwijzen met behulp van de Jinja2-sjabloontaal. Bijvoorbeeld:

Om het referentie-ID van de bestelling te bekijken: ####{{ orderReferenceId }}
Zo vind je een track & trace-code: ####{{ items[0].fulfillments[0].trackingCode }}
Om gepersonaliseerde metadata te openen: ####{{ metadata.isRush }}

Voor meer informatie over het maken van templates, zie Templates maken voor orderverwerking en Voorbeelden van Template Mapper.

Voor meer informatie over het instellen van postbacks, zie Hoe je postbacks instelt.

[Orderintake - GCW] Handleiding voor Postback Event Payload Referentie

Introductie

Inhoudsopgave

Pakketstatus bijgewerkt

Belangrijke gegevensvelden

Vertraagde bestelling

Belangrijke gegevensvelden

Bestelling geannuleerd

Belangrijke gegevensvelden

Bestelling bezorgd

Belangrijke gegevensvelden

Bestelling mislukt

Belangrijke gegevensvelden

Bestelling onderweg

Belangrijke gegevensvelden

Bestelling Geproduceerd

Belangrijke gegevensvelden

Bestelling ontvangen

Belangrijke gegevensvelden

Bestelling teruggestuurd

Belangrijke gegevensvelden

Bestelling verzonden

Belangrijke gegevensvelden

Werken met metadata

Voorbeelden van het gebruik van metadata:

Deze payloads gebruiken in templates