Spring videre til hovedindholdet

[Ordreindtag - GCW] Postback Event Payload Reference Guide

T
Skrevet af Toby Dawson
Opdateret for over 3 uger siden

Denne guide giver dig et komplet overblik over alle tilgængelige datafelter i payloaden for forskellige postback-udløsere i GelatoConnect. Når du forstår disse payloads, kan du nemt lave skabeloner, der trækker præcis de oplysninger, du har brug for.

Introduktion

Når en postback-hændelse udløses i GelatoConnect, sendes en JSON-payload med data, der er specifikke for hændelsen, til din konfigurerede endpoint eller bruges i e-mailnotifikationer. Dette dokument forklarer strukturen og indholdet af disse payloads for hver type hændelse, så du nemt kan se, hvilke data du har til rådighed, når du laver dine skabeloner.

Indholdsfortegnelse

Pakkestatus opdateret

Denne besked modtages, når status på en pakke ændrer sig i systemet.

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

Vigtige datafelter

  • customer: Indeholder kundeoplysninger som ID, navn og reference-ID

  • order: Grundlæggende ordreoplysninger og eventuel tilpasset metadata

  • package: Information om pakken, herunder status, vægt og indhold

  • shipment: Forsendelsesoplysninger med information om leveringssted, metode og tracking

Forsinket ordre

Denne besked modtager du, når ordrer er forsinkede og ikke er sendt afsted som forventet.

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

Vigtige datafelter

  • currentDate: Den aktuelle systemdato og -tid, hvor forsinkelsen blev opdaget

  • customerId: ID på kunden, der har de forsinkede ordrer

  • orders: Liste over forsinkede ordrer, hvor hver enkelt indeholder:

    • orderId: GelatoConnects interne ordre-ID

    • orderReferenceId: Dit referencenummer til ordren

    • expectedDispatchDate: Den forventede afsendelsesdato blev ikke overholdt

Ordre annulleret

Denne besked modtages, når en ordre bliver annulleret.

{ "created": "2018-08-03T07:26:52+00:00", "orderId": "a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9", "orderReferenceId": "J123X456", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "fulfillmentStatus": "annulleret", "channel": "api", "comment": "Ordren er annulleret – det gik som smurt", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "annulleret", "metadata": { "item-type": "produkt", "VARENUMMER": "123" } } ], "metadata": { "isRush": "Falsk" }}

Vigtige datafelter

  • created: Tidspunktet hvor annulleringen fandt sted

  • orderId: GelatoConnects interne ordre-ID

  • orderReferenceId: Din reference til ordren

  • customerReferenceId: Reference-ID til kunden

  • fulfillmentStatus: Aktuel status ("annulleret")

  • comment: Info om, hvorfor eller hvordan ordren blev annulleret

  • items: Liste over varer i ordren, hvor hver har sin egen status og metadata

  • metadata: Tilpasset metadata på ordreniveau

Ordren er leveret

Denne besked modtager du, når en ordre er blevet leveret til modtageren.

{ "created": "03/08/2018 07:26:52", "fulfillmentStatus": "leveret", "orderReferenceId": "ASD4124123", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "channel": "api", "comment": "", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "leveret", "fulfillments": [ { "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-05T10:15:00+00: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-05T12:30:00+02:00", "recipientName": "Jane Smith", "recipientSignature": "signature_image_url_2" } ], "metadata": { "item-type": "produkt", "VARENUMMER": "123" } } ], "metadata": { "isRush": "Falsk" }}

Vigtige datafelter

  • created: Tidspunktet for, hvornår leveringen fandt sted

  • fulfillmentStatus: Aktuel status ("leveret")

  • orderReferenceId: Din reference til ordren

  • items: Liste over varer i ordren, hvor hver enkelt indeholder:

    • fulfillments: Udførlige leveringsoplysninger, herunder:

      • trackingCode og trackingUrl: Sporingsinformation

      • shipmentMethodName: Navnet på transportøren

      • deliveryDate: Datoen, hvor varen blev leveret

      • recipientName: Hvem har fået pakken

      • recipientSignature: URL til et billede af underskriften (hvis det er tilgængeligt)

Ordre mislykkedes

Denne besked modtages, når en ordre ikke kan godkendes eller behandles.

{ "created": "03/08/2018 07:26:52", "orderId": "a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9", "orderReferenceId": "J123X456", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "fulfillmentStatus": "mislykkedes", "channel": "api", "comment": "Ordreafgivelse mislykkedes", "items": [ { "itemReferenceId": 123, "fulfillmentStatus": "mislykkedes", "metadata": { "item-type": "produkt", "sku": "123" } } ], "metadata": { "isRush": "Falsk" }}

Vigtige datafelter

  • created: Tidspunktet hvor fejlen opstod

  • orderId: GelatoConnects interne ordre-ID

  • orderReferenceId: Din reference til ordren

  • fulfillmentStatus: Aktuel status ("mislykket")

  • comment: Info om, hvorfor ordren gik i vasken

  • items: Liste over varer i ordren, hvor hver har sin egen status og metadata

Ordre på vej

Denne besked modtager du, når en ordre er på vej til modtageren.

{ "created": "17/09/2018 10:26:52", "fulfillmentStatus": "undervejs", "orderReferenceId": "J123X456", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "channel": "api", "comment": "Ordre på vej", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "undervejs", "fulfillments": [ { "trackingCode": "code567", "trackingUrl": "http://example.com/tracking?code=code567", "shipmentMethodName": "DHL Express Domestic BR", "shipmentMethodUid": "dhl_express_domestic_br", "fulfillmentCountry": "BR", "fulfillmentStateProvince": "SP" } ] } ]}

Vigtige datafelter

  • created: Tidspunktet hvor ordren blev sat til at være undervejs

  • fulfillmentStatus: Aktuel status ("in_transit")

  • orderReferenceId: Din reference til ordren

  • items: Liste over varer i ordren, hvor hver enkelt indeholder:

    • fulfillments: Forsendelsesoplysninger, herunder:

      • trackingCode og trackingUrl: Sporingsinformation

      • shipmentMethodName: Navnet på transportøren

      • fulfillmentCountry og fulfillmentStateProvince: Oplysninger om oprindelse

Ordre er klar

Denne besked modtager du, når en ordre er printet eller produceret, men endnu ikke sendt afsted.

{ "created": "2018-08-03T07:26:52+00:00", "orderId": "a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9", "orderReferenceId": "J123X456", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "fulfillmentStatus": "trykt", "channel": "api", "comment": "Ordren er blevet printet – det gik som smurt", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "trykt", "metadata": { "item-type": "produkt", "VARENUMMER": "123" } } ], "metadata": { "isRush": "Falsk" }}

Vigtige datafelter

  • created: Tidspunktet hvor ordren blev oprettet

  • orderId: GelatoConnects interne ordre-ID

  • orderReferenceId: Dit reference-ID til ordren

  • fulfillmentStatus: Aktuel status ("trykt")

  • comment: Info om produktionen

  • items: Liste over varer i ordren, hvor hver har sin egen status og metadata

Ordre modtaget

Denne besked modtager du, når en ordre er gået igennem og er blevet godkendt i systemet.

{ "created": "03/08/2018 07:26:52", "orderId": "a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9", "orderReferenceId": "ASD4124123", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "fulfillmentStatus": "bestået", "channel": "api", "comment": "Ordren er gået igennem uden problemer", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "bestået", "metadata": { "item-type": "produkt", "VARENUMMER": "123" } } ], "metadata": { "isRush": "Falsk" }}

Vigtige datafelter

  • created: Tidspunktet for, hvornår ordren blev modtaget

  • orderId: GelatoConnects interne ordre-ID

  • orderReferenceId: Din reference-ID til ordren

  • fulfillmentStatus: Aktuel status ("bestået")

  • comment: Information om valideringen

  • items: Liste over varer i ordren, hver med sin egen status og metadata

Ordre returneret

Denne besked modtager du, når en ordre er sendt retur til afsenderen.

{ "created": "03/08/2018 07:26:52", "fulfillmentStatus": "returneret", "orderReferenceId": "ASD4124123", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "channel": "api", "comment": "Ordren er blevet returneret – det gik som smurt", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "returneret", "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", "sku": "123" } } ], "metadata": { "isRush": "Falsk" }}

Vigtige datafelter

  • created: Tidspunktet, hvor returneringen blev behandlet

  • fulfillmentStatus: Aktuel status ("returneret")

  • orderReferenceId: Din reference til ordren

  • items: Liste over varer i ordren, hvor hver enkelt indeholder:

    • fulfillments: Returnér forsendelsesoplysninger, herunder:

      • trackingCode og trackingUrl: Sporingsinformation

      • shipmentMethodName: Navn på fragtfirma

      • fulfillmentCountry og fulfillmentStateProvince: Oplysninger om oprindelse

Ordren er sendt afsted

Denne besked modtages, når en ordre er sendt til modtageren.

{ "created": "2018-08-03T07:26:52+00:00", "fulfillmentStatus": "afsendt", "orderReferenceId": "ASD4124123", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "channel": "api", "comment": "Ordren er sendt afsted", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "afsendt", "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", "sku": "123" } } ], "metadata": { "isRush": "Falsk" }}

Vigtige datafelter

  • created: Tidspunktet for, hvornår ordren blev sendt afsted

  • fulfillmentStatus: Aktuel status ("afsendt")

  • orderReferenceId: Din reference til ordren

  • items: Liste over varer i ordren, hvor hver enkelt indeholder:

    • fulfillments: Forsendelsesinformation, herunder:

      • trackingCode og trackingUrl: Sporingsinformation

      • shipmentMethodName: Navnet på transportøren

      • fulfillmentCountry og fulfillmentStateProvince: Oplysninger om oprindelse

Sådan arbejder du med metadata

Mange af event-payloads indeholder metadata både på ordre- og vareniveau. Disse metadata består af tilpassede nøgle-værdi-par, som du selv kan definere, når du indsender ordrer, og de bliver derefter inkluderet i postback-events.

Eksempler på, hvordan du kan bruge metadata:

  1. Ordre-niveau metadata: metadata.isRush med værdien "False"

  2. Metadata på vareniveau: items[0].metadata.item-type med værdien "product"

  3. Metadata på vareniveau: items[0].metadata.sku med værdien "123"

Disse metadata kan bruges til at tilføje ekstra information, som ikke er en del af standardfelterne – for eksempel prioritetsmarkeringer, VARENUMMER, kategorier eller anden data, der gør det nemmere for dig at håndtere dine ordrer.

Sådan bruger du disse payloads i skabeloner

Når du laver skabeloner til postbacks, kan du bruge alle felter i disse payloads med Jinja2-templating-sproget. For eksempel:

  • Sådan finder du ordrereference-ID'en: ####{{ orderReferenceId }}

  • Sådan finder du et trackingnummer: ####{{ items[0].fulfillments[0].trackingCode }}

  • Sådan får du adgang til tilpassede metadata: ####{{ metadata.isRush }}

Hvis du vil vide mere om, hvordan du laver skabeloner, kan du læse Sådan laver du skabeloner til ordreindtastning og Eksempler på Template Mapper.

Vil du vide mere om, hvordan du opsætter postbacks? Så tjek Sådan opsætter du postbacks.

Relaterede artikler
[Ordreindtag – GCW] Sådan sætter du postbacks op
[Ordremodtagelse – GCW] Dokumentation for Order Management API
[Ordreindtag - GCW] Skabelonmapper-eksempler
[Ordremodtagelse – GCW] Sådan arbejder du med Order API-endpoints
[Ordreindtag – GCW] Brug af kundens produkter vs. ProductUID i API-ordrer
Besvarede dette dit spørgsmål?