Den här guiden ger dig en tydlig översikt över alla tillgängliga datafält i payloaden för olika postback-händelser i GelatoConnect. När du har koll på dessa payloads blir det enkelt att skapa smarta mallar som plockar ut precis den information du behöver.

Introduktion

När en postback-händelse triggas i GelatoConnect skickas en JSON-payload med händelsespecifik data till din valda endpoint eller används i mejlnotiser. I det här dokumentet går vi igenom hur dessa payloads är uppbyggda för varje händelsetyp, så att du enkelt ser vilken data som finns tillgänglig när du skapar dina mallar.

Innehållsförteckning

Paketstatus uppdaterad

Denna payload tas emot när en paketstatus ändras i systemet.

{ "customer": { \"id\": \"ea004496-8a31-42b7-b38a-77791152dbc7\", "name": "Testkund", "referenceId": "test-kund" }, "order": { "id": "ceebe91a-42e1-41ae-afdf-64569384f9bc", "referenceId": "Test-order", "metadata": { \"isRush\": \"False\" } }, \"package\": { "id": "reference_package_id", \"items\": [ { "id": "1614240f-3d24-4d44-b632-b1bd91b1981c", "quantity": 1, \"referenceId\": \"product_18_reference_id\", \"metadata\": { "item-type": "produkt", "sku": "product_18_reference_id" } } ], \"status\": \"skickad\", \"vikt\": 9 }, "shipment": { \"fulfillmentLocation\": { "country": "US", "stateProvince": "Wyoming" }, "method": { \"id\": \"shipping_method_id\", "name": "Namn på leveranssätt" }, "spårning": { "code": "tracking_order_us", "url": "http://tracking.com/order_us" } }}

Viktiga datafält

customer: Innehåller kundinformation som ID, namn och referens-ID
order: Grundläggande orderinformation och eventuell egen metadata
paket: Allt om paketet – status, vikt och vad som finns i det
shipment: Leveransinformation som visar plats, leveranssätt och spårningsuppgifter

Försenad beställning

Den här informationen får du när en order är försenad och inte skickas iväg som planerat.

{ \"currentDate\": \"2024-11-29 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" } ]}

Viktiga datafält

currentDate: Datum och tid i systemet när förseningen upptäcktes
customerId: ID för kunden som hör till de försenade beställningarna
orders: Lista med försenade beställningar, där varje innehåller:
- orderId: GelatoConnects interna order-ID
- orderReferenceId: Din referens för beställningen
- expectedDispatchDate: Det förväntade utskicksdatumet som inte hölls

Beställning avbruten

Den här informationen får du när en beställning avbryts.

{ "created": "2018-08-03T07:26:52+00:00", "orderId": "a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9", "orderReferenceId": "J123X456", \"customerReferenceId\": \"b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0\", "fulfillmentStatus": "avbruten", "channel": "api", \"comment\": \"Beställningen avbruten\" "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "avbruten", \"metadata\": { "item-type": "produkt", \"sku\": \"123\" } } ], "metadata": { "isRush": "Falskt" }}

Viktiga datafält

created: Tidpunkt när avbokningen gjordes
orderId: GelatoConnects interna order-ID
orderReferenceId: Din referens för beställningen
customerReferenceId: Referens-ID för kunden
fulfillmentStatus: Nuvarande status ("avbruten")
comment: Information om varför eller hur beställningen blev avbruten
items: En lista med produkter i beställningen, där varje produkt har sin egen status och information
metadata: Anpassad metadata för hela beställningen

Din beställning är framme

Den här informationen får du när en beställning har levererats till mottagaren.

{ "created": "2018-08-03T07:26:52+00:00", "fulfillmentStatus": "levererad", "orderReferenceId": "ASD4124123", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "channel": "api", "kommentar": "", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "levererad", "fulfillments": [ { "trackingCode": "code123", "trackingUrl": "http://example.com/tracking?code=code123", "shipmentMethodName": "DHL Express Inrikes BR", "shipmentMethodUid": "dhl_express_domestic_br", \"fulfillmentCountry\": \"BR\", "fulfillmentStateProvince": "SP", "deliveryDate": "2018-08-05T12:15:00+02:00", "recipientName": "John Doe", "recipientSignature": "signature_image_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-05T10:30:00+00:00", \"recipientName\": \"Jane Smith\", "recipientSignature": "signature_image_url_2" } ], \"metadata\": { \"item-type\": \"product\", \"sku\": \"123\" } } ], "metadata": { \"isRush\": \"False\" }}

Viktiga datafält

created: Tidsstämpel för när leveransen skedde
fulfillmentStatus: Aktuell status (\"levererad\")
orderReferenceId: Din referens för beställningen
items: Array med artiklar i ordern, var och en innehållande:
- fulfillments: Utförlig leveransinfo, inklusive:
  - trackingCode och trackingUrl: Spårningsinformation
  - shipmentMethodName: Transportörens namn
  - deliveryDate: När varan levererades
  - recipientName: Vem som tog emot paketet
  - recipientSignature: URL till en bild av signaturen (om det finns någon)

Beställningen misslyckades

Den här informationen får du när en beställning inte går igenom eller misslyckas vid kontroll.

{ \"created\": \"2018-08-03T07:26:52+00:00\", \"orderId\": \"a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9\", "orderReferenceId": "J123X456", \"customerReferenceId\": \"b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0\", \"fulfillmentStatus\": \"failed\", "channel": "api", \"comment\": \"Orderläggning misslyckades\", "items": [ { \"itemReferenceId\": 123, \"fulfillmentStatus\": \"failed\", \"metadata\": { \"item-type\": \"product\", "sku": "123" } } ], \"metadata\": { "isRush": "Falskt" }}

Viktiga datafält

created: Tidpunkt när felet inträffade
orderId: GelatoConnects interna order-ID
orderReferenceId: Din referens för beställningen
fulfillmentStatus: Nuvarande status ("misslyckades")
comment: Information om varför beställningen inte gick igenom
items: En lista med produkter i beställningen, där varje produkt har sin egen status och information

Beställning på väg

Den här informationen får du när en beställning är på väg till mottagaren.

{ "created": "2018-09-17T10:26:52+00:00", \"fulfillmentStatus\": \"in_transit\", "orderReferenceId": "J123X456", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", \"channel\": \"api\", "comment": "Beställning på väg", "items": [ { \"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\" } ] } ]}

Viktiga datafält

created: Tidsstämpel för när orderstatus ändrades till under transport
fulfillmentStatus: Aktuell status (\"under_transport\")
orderReferenceId: Ditt referens-ID för beställningen
items: Array med artiklar i ordern, var och en innehållande:
- fulfillments: Leveransinformation, inklusive:
  - trackingCode och trackingUrl: Spårningsinformation
  - shipmentMethodName: Transportörens namn
  - fulfillmentCountry och fulfillmentStateProvince: Ursprungsinformation

Beställning tillverkad

Denna information tas emot när en order har tryckts/producerats men ännu inte skickats.

{ \"created\": \"2018-08-03T07:26:52+00:00\", \"orderId\": \"a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9\", \"orderReferenceId\": \"J123X456\", \"customerReferenceId\": \"b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0\", \"fulfillmentStatus\": \"printed\", \"channel\": \"api\", \"comment\": \"Beställning utskriven\" \"items\": [ { \"itemReferenceId\": \"123\", \"fulfillmentStatus\": \"printed\", \"metadata\": { \"item-type\": \"product\", \"sku\": \"123\" } } ], \"metadata\": { \"isRush\": \"False\" }}

Viktiga datafält

created: Tidsstämpel för när ordern skapades
orderId: GelatoConnects interna order-ID
orderReferenceId: Ditt referens-ID för beställningen
fulfillmentStatus: Aktuell status (\"utskriven\")
comment: Information om produktionen
items: En lista med produkter i beställningen, där varje produkt har sin egen status och information

Beställning mottagen

Denna payload tas emot när en order har mottagits och validerats i systemet.

{ \"created\": \"2018-08-03T07:26:52+00:00\", \"orderId\": \"a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9\", "orderReferenceId": "ASD4124123", \"customerReferenceId\": \"b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0\", \"fulfillmentStatus\": \"godkänd\", "channel": "api", "comment": "Beställningen gick igenom!", "items": [ { \"itemReferenceId\": \"123\", "fulfillmentStatus": "godkänd", \"metadata\": { "item-type": "produkt", \"sku\": \"123\" } } ], "metadata": { "isRush": "Falskt" }}

Viktiga datafält

created: Tidsstämpel för när ordern mottogs
orderId: GelatoConnects interna order-ID
orderReferenceId: Ditt referens-ID för beställningen
fulfillmentStatus: Aktuell status (\"godkänd\")
comment: Information om valideringen
items: Array av artiklar i ordern, var och en med egen status och metadata

Ordern är tillbaka

Den här informationen får du när en beställning har skickats tillbaka till avsändaren.

{ "created": "2018-08-03T07:26:52+00:00", "fulfillmentStatus": "returnerad", "orderReferenceId": "ASD4124123", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", \"channel\": \"api\", "comment": "Beställningen har returnerats – snyggt jobbat!", \"items\": [ { "itemReferenceId": "123", \"fulfillmentStatus\": \"returnerad\", \"fulfillments\": [ { \"trackingCode\": \"code123\", "trackingUrl": "http://example.com/tracking?code=code123", "shipmentMethodName": "DHL Express Inrikes BR", "shipmentMethodUid": "dhl_express_domestic_br", "fulfillmentCountry": "BR", \"fulfillmentStateProvince\": \"SP\" }, { \"trackingCode\": \"code234\", "trackingUrl": "http://example.com/tracking?code=code234", "shipmentMethodName": "DHL Express Inrikes BR", "shipmentMethodUid": "dhl_express_domestic_br", \"fulfillmentCountry\": \"BR\", \"fulfillmentStateProvince\": \"SP\" } ], "metadata": { \"item-type\": \"product\", \"sku\": \"123\" } } ], "metadata": { \"isRush\": \"False\" }}

Viktiga nyckelfält

created: Tidpunkt när returen hanterades
fulfillmentStatus: Nuvarande status ("returnerad")
orderReferenceId: Din referens för beställningen
items: Array med artiklar i ordern, var och en innehållande:
- fulfillments: Här hittar du information om returer och leveranser, till exempel:
  - trackingCode och trackingUrl: Spårningsinformation
  - shipmentMethodName: Namn på fraktbolag
  - fulfillmentCountry och fulfillmentStateProvince: Ursprungsinformation

Beställning skickad

Den här informationen får du när en beställning har skickats till mottagaren.

{ \"created\": \"2018-08-03T07:26:52+00:00\", "fulfillmentStatus": "skickad", \"orderReferenceId\": \"ASD4124123\", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "channel": "api", "comment": "Din beställning har skickats iväg!", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "skickad", "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\": \"product\", "sku": "123" } } ], "metadata": { \"isRush\": \"False\" }}

Viktiga datafält

created: Tidsstämpel för när ordern skickades
fulfillmentStatus: Nuvarande status ("skickad")
orderReferenceId: Din referens för beställningen
items: Array med artiklar i ordern, var och en innehållande:
- fulfillments: Leveransinformation, inklusive:
  - trackingCode och trackingUrl: Spårningsinformation
  - shipmentMethodName: Transportörens namn
  - fulfillmentCountry och fulfillmentStateProvince: Ursprungsinformation

Arbeta med metadata

Många av händelsernas data innehåller metadata både på order- och produktnivå. Den här metadatan består av egna nyckel-värde-par som du själv kan bestämma när du skickar in en order, och de följer sedan med i återkopplingshändelserna.

Exempel på hur metadata används:

Metadata på ordernivå: metadata.isRush med värdet \"False\"
Metadata på artikelnivå: items[0].metadata.item-type med värdet \"product\"
Metadata på artikel-nivå: items[0].metadata.sku med värdet "123"

Denna metadata kan användas för att inkludera ytterligare information som inte ingår i standardfälten, såsom prioritetsflaggor, artikelnummer, kategorier eller annan data som underlättar din orderhantering.

Använda dessa nyttolaster i mallar

När du skapar mallar för postbacks kan du referera till vilket fält som helst i dessa nyttolaster med hjälp av Jinja2-mallspråket. Till exempel:

För att komma åt order-referens-ID: ####{{ orderReferenceId }}
Så här hittar du ett spårningsnummer: ####{{ items[0].fulfillments[0].trackingCode }}
Så här kommer du åt anpassad metadata: ####{{ metadata.isRush }}

Vill du veta mer om hur du skapar mallar? Kolla in Skapa mallar för ordermottagning och Exempel på Template Mapper.

För mer information om hur du ställer in postbacks, se Hur du ställer in Postbacks.

Relaterade artiklar

[Orderingång - GCW] Hur ställer man in postbacks?

[Orderingång - GCW] Dokumentation för API för orderhantering

[Orderingång - GCW] Exempel på mallmappning

[Orderingång - GCW] Arbeta med Order API-slutpunkter

[Orderingång - GCW] GelatoConnect API-grunder