Gå til hovedinnhold

[Ordreinngang – GCW] Referanseguide for postback-hendelsespayload

T
Skrevet av Toby Dawson
Oppdatert for over 3 uker siden

Denne guiden gir deg en fullstendig oversikt over alle tilgjengelige datafelter i payloaden for ulike postback-utløsere i GelatoConnect. Når du forstår disse payloadene, blir det enklere å lage gode maler som henter ut akkurat den informasjonen du trenger.

Introduksjon

Når en postback-hendelse utløses i GelatoConnect, sendes en JSON-payload med hendelsesspesifikke data til endepunktet du har satt opp, eller brukes i e-postvarsler. Dette dokumentet forklarer hvordan disse payloadene er bygd opp for hver hendelsestype, slik at du enkelt ser hvilke data som er tilgjengelige når du lager malene dine.

Innholdsfortegnelse

Pakkestatus oppdatert

Denne meldingen kommer når statusen til en pakke endres i systemet.

{ "customer": { "id": "ea004496-8a31-42b7-b38a-77791152dbc7", "name": "Testkunde", "referenceId": "test-customer" }, "order": { "id": "ceebe91a-42e1-41ae-afdf-64569384f9bc", "referenceId": "Test-bestilling", "metadata": { "isRush": "Nei" } }, "pakke": { "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": "sendt", "vekt": 9 }, "forsendelse": { "fulfillmentLocation": { "country": "US", "stateProvince": "Wyoming" }, "method": { "id": "shipping_method_id", "name": "Navn på fraktmetode" }, "sporing": { "code": "spore_bestilling_us", "url": "http://tracking.com/order_us" } }}

Viktige datafelter

  • customer: Inneholder informasjon om kunden, som ID, navn og referanse-ID

  • order: Grunnleggende informasjon om bestillingen og eventuell personlig tilpasset metadata

  • pakke: Her finner du informasjon om pakken, som status, vekt og hva den inneholder

  • shipment: Fraktinformasjon som viser hvor pakken er, hvordan den sendes og sporingsdetaljer

Forsinket bestilling

Denne meldingen kommer når bestillinger er forsinket lenger enn forventet utsendelsesdato.

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

Viktige datafelter

  • currentDate: Dato og klokkeslett i systemet da forsinkelsen ble oppdaget

  • customerId: ID-en til kunden som er knyttet til de forsinkede bestillingene

  • orders: Liste over forsinkede bestillinger, hver med:

    • orderId: GelatoConnects interne ordre-ID

    • orderReferenceId: Din referanse-ID for bestillingen

    • expectedDispatchDate: Datoen for utsendelse som ikke ble overholdt

Bestillingen er avbrutt

Denne informasjonen mottas når en bestilling blir kansellert.

{ "created": "2018-08-03T07:26:52+00:00", "orderId": "a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9", "orderReferenceId": "J123X456", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "fulfillmentStatus": "kansellert", "channel": "api", "comment": "Bestillingen ble avbrutt uten problemer", "varer": [ { "itemReferenceId": "123", "fulfillmentStatus": "kansellert", "metadata": { "item-type": "produkt", "sku": "123" } } ], "metadata": { "isRush": "Nei" }}

Viktige datafelter

  • created: Tidspunktet da kanselleringen skjedde

  • orderId: GelatoConnects interne ordre-ID

  • orderReferenceId: Din referanse-ID for bestillingen

  • customerReferenceId: Referanse-ID for kunden

  • fulfillmentStatus: Nåværende status («kansellert»)

  • comment: Her finner du informasjon om hvorfor eller hvordan bestillingen ble kansellert

  • items: Liste over varer i bestillingen, hver med sin egen status og tilhørende informasjon

  • metadata: Personlig tilpasset informasjon for hele bestillingen

Bestillingen er levert

Denne meldingen mottas når en bestilling er levert til mottakeren.

{ "created": "03.08.2018 07:26:52", "fulfillmentStatus": "levert", "orderReferenceId": "ASD4124123", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "channel": "api", "comment": "", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "levert", "produksjoner": [ { "trackingCode": "code123", "trackingUrl": "http://example.com/tracking?code=code123", "shipmentMethodName": "DHL Express Domestic BR", "shipmentMethodUid": "dhl_express_domestic_br", "fulfillmentCountry": "BR", "fulfillmentStateProvince": "SP", "deliveryDate": "05/08/2018 12:15", "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": "05.08.2018 12:30", "recipientName": "Jane Smith", "recipientSignature": "signature_image_url_2" } ], "metadata": { "item-type": "produkt", "sku": "123" } } ], "metadata": { "isRush": "Nei" }}

Viktige datafelter

  • created: Tidspunktet da leveringen fant sted

  • fulfillmentStatus: Nåværende status («levert»)

  • orderReferenceId: Din referanse-ID for bestillingen

  • items: Liste over varer i bestillingen, hver med:

    • fulfillments: Detaljert leveringsinformasjon, blant annet:

      • trackingCode og trackingUrl: Sporingsinformasjon

      • shipmentMethodName: Navn på transportør

      • deliveryDate: Datoen varen ble levert

      • recipientName: Hvem som fikk pakken

      • recipientSignature: URL til et bilde av signaturen (hvis tilgjengelig)

Bestillingen mislyktes

Denne informasjonen mottas når en bestilling ikke blir godkjent eller behandlet.

{ "created": "2018-08-03T07:26:52+00:00", "orderId": "a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9", "orderReferenceId": "J123X456", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "fulfillmentStatus": "mislyktes", "channel": "api", "comment": "Bestillingen ble ikke sendt inn", "items": [ { "itemReferenceId": 123, "fulfillmentStatus": "feilet", "metadata": { "item-type": "produkt", "sku": "123" } } ], "metadata": { "isRush": "Nei" }}

Viktige datafelter

  • created: Tidspunktet da feilen oppsto

  • orderId: GelatoConnects interne ordre-ID

  • orderReferenceId: Din referanse-ID for bestillingen

  • fulfillmentStatus: Nåværende status («mislyktes»)

  • comment: Informasjon om hvorfor bestillingen ikke gikk gjennom

  • items: Liste over varer i bestillingen, hver med sin egen status og tilhørende informasjon

Bestillingen er på vei

Denne meldingen mottas når en bestilling er på vei til mottakeren.

{ "created": "2018-09-17T10:26:52+00:00", "fulfillmentStatus": "underveis", "orderReferenceId": "J123X456", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "channel": "api", "comment": "Bestillingen er på vei", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "underveis", "produksjoner": [ { "trackingCode": "code567", "trackingUrl": "http://example.com/tracking?code=code567", "shipmentMethodName": "DHL Express Domestic BR", "shipmentMethodUid": "dhl_express_domestic_br", "produksjonsland": "BR", "fulfillmentStateProvince": "SP" } ] } ]}

Viktige datafelter

  • created: Tidspunktet da ordrestatusen ble endret til «under transport»

  • fulfillmentStatus: Nåværende status («på vei»)

  • orderReferenceId: Din referanse-ID for bestillingen

  • items: Liste over varer i bestillingen, hver med:

    • produksjoner: Fraktinformasjon, inkludert:

      • trackingCode og trackingUrl: Sporingsinformasjon

      • shipmentMethodName: Navn på transportør

      • fulfillmentCountry og fulfillmentStateProvince: Informasjon om opprinnelse

Bestillingen er produsert

Denne meldingen mottas når en bestilling er trykket eller produsert, men ennå ikke sendt.

{ "created": "2018-08-03T07:26:52+00:00", "orderId": "a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9", "orderReferenceId": "J123X456", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "fulfillmentStatus": "trykket", "channel": "api", "comment": "Bestillingen er trykket og klar", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "trykket", "metadata": { "item-type": "produkt", "sku": "123" } } ], "metadata": { "isRush": "Nei" }}

Viktige datafelter

  • created: Tidspunktet da bestillingen ble produsert

  • orderId: GelatoConnects interne ordre-ID

  • orderReferenceId: Din referanse-ID for bestillingen

  • fulfillmentStatus: Nåværende status («trykket»)

  • comment: Informasjon om produksjonen

  • items: Liste over varer i bestillingen, hver med sin egen status og tilhørende informasjon

Bestilling mottatt

Denne informasjonen mottas når en bestilling er registrert og godkjent i systemet.

{ "created": "03.08.2018 07:26:52", "orderId": "a6a1f9ce-2bdd-4a9e-9f8d-0009df0e24d9", "orderReferenceId": "ASD4124123", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "fulfillmentStatus": "godkjent", "channel": "api", "comment": "Bestillingen gikk gjennom", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "godkjent", "metadata": { "item-type": "produkt", "sku": "123" } } ], "metadata": { "isRush": "Nei" }}

Viktige datafelter

  • created: Tidspunktet da bestillingen ble mottatt

  • orderId: GelatoConnects interne ordre-ID

  • orderReferenceId: Din referanse-ID for bestillingen

  • fulfillmentStatus: Nåværende status («bestått»)

  • comment: Informasjon om valideringen

  • items: Liste over varer i bestillingen, hver med sin egen status og tilhørende informasjon

Bestillingen er returnert

Denne meldingen får du når en bestilling er sendt tilbake til avsender.

{ "created": "03.08.2018 07:26:52", "fulfillmentStatus": "returnert", "orderReferenceId": "ASD4124123", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "channel": "api", "comment": "Bestillingen ble returnert uten problemer", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "returnert", "produksjoner": [ { "trackingCode": "kode123", "trackingUrl": "http://example.com/tracking?code=code123", "shipmentMethodName": "DHL Express innenlands BR", "shipmentMethodUid": "dhl_express_domestic_br", "produksjonsland": "BR", "fulfillmentStateProvince": "SP" }, { "trackingCode": "code234", "trackingUrl": "http://example.com/tracking?code=code234", "shipmentMethodName": "DHL Express innenlands BR", "shipmentMethodUid": "dhl_express_domestic_br", "fulfillmentCountry": "BR", "fulfillmentStateProvince": "SP" } ], "metadata": { "item-type": "produkt", "sku": "123" } } ], "metadata": { "isRush": "Nei" }}

Viktige datafelter

  • created: Tidspunktet da returen ble behandlet

  • fulfillmentStatus: Nåværende status («returnert»)

  • orderReferenceId: Din referanse-ID for bestillingen

  • items: Liste over varer i bestillingen, hver med:

    • produksjoner: Viser informasjon om returforsendelser, inkludert:

      • trackingCode og trackingUrl: Sporingsinformasjon

      • shipmentMethodName: Navn på transportør

      • fulfillmentCountry og fulfillmentStateProvince: Informasjon om opprinnelse

Bestilling sendt

Denne meldingen mottas når en bestilling er sendt til mottakeren.

{ "created": "03.08.2018 07:26:52", "fulfillmentStatus": "sendt", "orderReferenceId": "ASD4124123", "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0", "channel": "api", "comment": "Bestillingen er sendt av gårde", "items": [ { "itemReferenceId": "123", "fulfillmentStatus": "sendt", "produksjon": [ { "trackingCode": "kode123", "trackingUrl": "http://example.com/tracking?code=code123", "shipmentMethodName": "DHL Express innenlands BR", "shipmentMethodUid": "dhl_express_domestic_br", "fulfillmentCountry": "BR", "fulfillmentStateProvince": "SP" }, { "trackingCode": "code234", "trackingUrl": "http://example.com/tracking?code=code234", "shipmentMethodName": "DHL Express innenlands BR", "shipmentMethodUid": "dhl_express_domestic_br", "fulfillmentCountry": "BR", "fulfillmentStateProvince": "SP" } ], "metadata": { "item-type": "produkt", "sku": "123" } } ], "metadata": { "isRush": "Nei" }}

Viktige datafelter

  • created: Tidspunktet da bestillingen ble sendt

  • fulfillmentStatus: Nåværende status («sendt»)

  • orderReferenceId: Din referanse-ID for bestillingen

  • items: Liste over varer i bestillingen, hver med:

    • produksjoner: Fraktinformasjon, inkludert:

      • trackingCode og trackingUrl: Sporingsinformasjon

      • shipmentMethodName: Navn på transportør

      • fulfillmentCountry og fulfillmentStateProvince: Informasjon om opprinnelse

Jobbe med metadata

Mange av hendelsespayloadene inneholder metadata både på ordre- og varenivå. Denne metadataen har personlig tilpassede nøkkel-verdi-par som du kan definere når du sender inn ordre, og de blir med i postback-hendelser.

Eksempler på hvordan metadata brukes:

  1. Metadata for bestilling: metadata.isRush med verdi "False"

  2. Metadata på varenivå: items[0].metadata.item-type med verdi "product"

  3. Metadata på varenivå: items[0].metadata.sku med verdi "123"

Denne metadataen kan brukes til å legge til ekstra informasjon som ikke er en del av standardfeltene, for eksempel prioritetsmarkeringer, SKU-er, kategorier eller annen data som gjør det enklere å håndtere bestillingen din.

Slik bruker du disse dataene i maler

Når du lager maler for postbacks, kan du bruke alle feltene i disse payloadene med Jinja2-malspråket. For eksempel:

  • For å finne referanse-ID for bestillingen: ####{{ orderReferenceId }}

  • For å finne et sporingsnummer: ####{{ items[0].fulfillments[0].trackingCode }}

  • Slik får du tilgang til personlig tilpasset metadata: ####{{ metadata.isRush }}

For mer informasjon om hvordan du lager maler, kan du se Creating Templates for Order Intake og Template Mapper Examples.

For mer informasjon om hvordan du setter opp postbacks, se Slik setter du opp postbacks.

Relaterte artikler
[Ordremottak – GCW] Hvordan setter du opp postbacks?
[Ordremottak – GCW] API-dokumentasjon for ordrebehandling
[Ordreinngang – GCW] Eksempler på maltilordning
[Ordremottak – GCW] Slik jobber du med Order API-endepunkter
[Ordreinngang – GCW] Bruke kundeprodukter vs. ProductUID i API-ordre
Svarte dette på spørsmålet?