Ce guide offre une référence complète de tous les champs de données disponibles dans le payload pour les différents événements de déclenchement de postback dans GelatoConnect. Comprendre ces payloads est essentiel pour créer des modèles efficaces qui extraient les informations dont vous avez besoin.

Introduction

Lorsqu’un événement de postback est déclenché dans GelatoConnect, une charge utile JSON contenant des données spécifiques à l’événement est envoyée à votre point de terminaison configuré ou utilisée dans les notifications par e-mail. Ce document présente la structure et le contenu de ces charges utiles pour chaque type d’événement, afin de vous aider à comprendre quelles données sont disponibles lors de la création de vos modèles.

Table des matières

Statut du colis mis à jour

Ce message est reçu lorsqu’un changement de statut de colis a lieu dans le système.

{
  "customer": {
    "id": "ea004496-8a31-42b7-b38a-77791152dbc7",
    "name": "Test Csutomer",
    "referenceId": "test-customer"
  },
  "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": "product",
          "sku": "product_18_reference_id"
        }
      }
    ],
    "status": "shipped",
    "weight": 9
  },
  "shipment": {
    "fulfillmentLocation": {
      "country": "US",
      "stateProvince": "Wyoming"
    },
    "method": {
      "id": "shipping_method_id",
      "name": "Shipping Method Name"
    },
    "tracking": {
      "code": "tracking_order_us",
      "url": "http://tracking.com/order_us"
    }
  }
}

Champs de données essentiels

customer : Contient les informations du client, y compris l'identifiant, le nom et la référence.
order : Informations de base sur la commande et toutes les métadonnées personnalisées
package : Détails sur le colis, notamment son statut, son poids et les articles qu’il contient
shipment : Détails d’expédition, y compris le lieu, la méthode et les informations de suivi

Commande en retard

Ce message est reçu lorsque des commandes sont repérées comme ayant un retard par rapport à leur date d'expédition prévue.

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

Champs de données clés

currentDate : Date et heure actuelles du système au moment où le retard a été constaté
customerId : ID du client associé aux commandes retardées
orders : liste des commandes en attente, chacune comprenant :
- orderId : identifiant de commande interne de GelatoConnect
- orderReferenceId : Votre identifiant de référence pour la commande
- expectedDispatchDate : La date d'expédition prévue qui n'a pas été respectée

Commande annulée

Ce message est reçu lorsqu'une commande est annulée.

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

Champs de données essentiels

created : Date et heure auxquelles l’annulation a eu lieu
orderId : identifiant de commande interne de GelatoConnect
orderReferenceId : Votre identifiant de référence pour la commande
customerReferenceId : identifiant de référence du client
fulfillmentStatus : Statut actuel ("annulé")
comment : Informations sur la raison ou la manière dont la commande a été annulée
items : liste des articles de la commande, chacun avec son propre statut et ses informations associées
metadata : Métadonnées personnalisées au niveau de la commande

Commande livrée

Ce message est reçu lorsqu'une commande a été livrée au destinataire.

{
  "created": "2018-08-03T07:26:52+00:00",
  "fulfillmentStatus": "delivered",
  "orderReferenceId": "ASD4124123",
  "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0",
  "channel": "api",
  "comment": "",
  "items": [
    {
      "itemReferenceId": "123",
      "fulfillmentStatus": "delivered",
      "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-05T10:30:00+00:00",
          "recipientName": "Jane Smith",
          "recipientSignature": "signature_image_url_2"
        }
      ],
      "metadata": {
        "item-type": "product",
        "sku": "123"
      }
    }
  ],
  "metadata": {
    "isRush": "False"
  }
}

Champs de données essentiels

created : Date et heure auxquelles la livraison a eu lieu
fulfillmentStatus : Statut actuel (« livré »)
orderReferenceId : Votre identifiant de référence pour la commande
items : Tableau d'articles dans la commande, chacun contenant :
- traitement des commandes : Informations détaillées sur la livraison, notamment :
  - trackingCode et trackingUrl : Informations de suivi
  - shipmentMethodName : Nom du transporteur
  - deliveryDate : Date à laquelle l'article a été livré
  - recipientName : Qui a reçu le colis
  - recipientSignature : URL vers une image de la signature (si disponible)

Commande échouée

Ce message est reçu lorsqu'une commande ne passe pas la validation ou le traitement.

{
  "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": "Order submission failed",
  "items": [
    {
      "itemReferenceId": 123,
      "fulfillmentStatus": "failed",
      "metadata": {
        "item-type": "product",
        "sku": "123"
      }
    }
  ],
  "metadata": {
    "isRush": "False"
  }
}

Champs de données essentiels

created : Date et heure auxquelles l'échec s'est produit
orderId : identifiant de commande interne de GelatoConnect
orderReferenceId : Votre identifiant de référence pour la commande
fulfillmentStatus : Statut actuel ("échec")
comment : Informations sur la raison de l'échec de la commande
items : liste des articles de la commande, chacun ayant son propre statut et ses propres informations

Commande en cours de livraison

Ce message est reçu lorsque la commande est en cours de livraison vers le destinataire.

{
  "created": "2018-09-17T10:26:52+00:00",
  "fulfillmentStatus": "in_transit",
  "orderReferenceId": "J123X456",
  "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0",
  "channel": "api",
  "comment": "Order in-transit",
  "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"
        }
      ]
    }
  ]
}

Champs de données essentiels

created : Date et heure auxquelles le statut de la commande est passé à "en cours de livraison"
fulfillmentStatus : Statut actuel ("en cours d’acheminement")
orderReferenceId : Votre identifiant de référence pour la commande
items : liste des articles de la commande, chacun comprenant :
- traitement des commandes : Informations sur l’expédition, notamment :
  - trackingCode et trackingUrl : Informations de suivi
  - shipmentMethodName : Nom du transporteur
  - fulfillmentCountry et fulfillmentStateProvince : informations sur l'origine

Commande produite

Ce message est reçu lorsqu'une commande a été imprimée ou produite, mais n'a pas encore été expédiée.

{
  "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": "Order printed successfully",
  "items": [
    {
      "itemReferenceId": "123",
      "fulfillmentStatus": "printed",
      "metadata": {
        "item-type": "product",
        "sku": "123"
      }
    }
  ],
  "metadata": {
    "isRush": "False"
  }
}

Champs de données essentiels

created : Date et heure auxquelles la commande a été créée
orderId : identifiant de commande interne de GelatoConnect
orderReferenceId : Votre identifiant de référence pour la commande
fulfillmentStatus : Statut actuel (« imprimé »)
commentaire : Informations sur la production
items : liste des articles de la commande, chacun ayant son propre statut et ses propres métadonnées

Commande reçue

Ce message est envoyé lorsqu'une commande est bien reçue et validée dans le système.

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

Champs de données clés

created : Date et heure de réception de la commande
orderId : ID de commande interne de GelatoConnect
orderReferenceId : Votre identifiant de référence pour la commande
fulfillmentStatus : Statut actuel ("réussi")
commentaire : Informations sur la validation
items : Tableau d'articles dans la commande, chacun avec son propre statut et ses métadonnées

Commande retournée

Cette charge utile est reçue lorsqu'une commande a été retournée à l'expéditeur.

{
  "created": "2018-08-03T07:26:52+00:00",
  "fulfillmentStatus": "returned",
  "orderReferenceId": "ASD4124123",
  "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0",
  "channel": "api",
  "comment": "Order returned successfully",
  "items": [
    {
      "itemReferenceId": "123",
      "fulfillmentStatus": "returned",
      "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"
  }
}

Champs de données essentiels

created : Horodatage du moment où le retour a été traité
fulfillmentStatus : Statut actuel ("retourné")
orderReferenceId : Votre identifiant de référence pour la commande
items : Tableau d'articles dans la commande, chacun contenant :
- traitement des commandes : Informations sur l’expédition de retour, notamment :
  - trackingCode et trackingUrl : Informations de suivi
  - shipmentMethodName : Nom du transporteur
  - fulfillmentCountry et fulfillmentStateProvince : informations sur l'origine

Commande expédiée

Cette charge utile est reçue lorsqu'une commande a été expédiée au destinataire.

{
  "created": "2018-08-03T07:26:52+00:00",
  "fulfillmentStatus": "shipped",
  "orderReferenceId": "ASD4124123",
  "customerReferenceId": "b9v0e9ce-2bdd-4a9e-9f8d-0009df0e35d0",
  "channel": "api",
  "comment": "Order shipped successfully",
  "items": [
    {
      "itemReferenceId": "123",
      "fulfillmentStatus": "shipped",
      "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"
  }
}

Champs de données essentiels

created : Horodatage du moment où la commande a été expédiée
fulfillmentStatus : Statut actuel (« expédié »)
orderReferenceId : Votre identifiant de référence pour la commande
items : liste des articles de la commande, chacun contenant :
- Traitement des commandes : Informations d'expédition, y compris :
  - trackingCode et trackingUrl : Informations de suivi
  - shipmentMethodName : Nom du transporteur
  - fulfillmentCountry et fulfillmentStateProvince : informations sur l'origine

Travailler avec les métadonnées

De nombreux flux d’événements incluent des métadonnées à la fois au niveau de la commande et de l’article. Ces métadonnées contiennent des paires clé-valeur personnalisées que vous pouvez définir lors de la soumission des commandes, puis retrouver dans les événements de retour.

Exemples d’utilisation des métadonnées :

Métadonnées au niveau de la commande : metadata.isRush avec la valeur \"False\"
Métadonnées au niveau de l'article : items[0].metadata.item-type avec la valeur "product"
Métadonnées au niveau de l'article : items[0].metadata.sku avec la valeur \"123\"

Ces métadonnées peuvent être utilisées pour inclure des informations supplémentaires qui ne font pas partie des champs standard, comme des indicateurs de priorité, des références (SKU), des catégories ou toute autre donnée qui facilite le traitement de votre commande.

Utiliser ces données dans les modèles

Lorsque vous créez des modèles pour les postbacks, vous pouvez faire référence à n'importe quel champ de ces charges utiles en utilisant le langage de template Jinja2. Par exemple :

Pour accéder à l'identifiant de référence de la commande : ##{{ orderReferenceId }}
Pour accéder à un code de suivi : ##{{ items[0].fulfillments[0].trackingCode }}
Pour accéder aux métadonnées personnalisées : ##{{ metadata.isRush }}

Pour en savoir plus sur la création de modèles, consultez Créer des modèles pour la prise de commandes et Exemples de mappage de modèles.

Pour en savoir plus sur la configuration des postbacks, consultez Comment configurer les postbacks.

[Order Intake - GCW] Guide de référence du contenu de l'événement de postback

Introduction

Table des matières

Statut du colis mis à jour

Champs de données essentiels

Commande en retard

Champs de données clés

Commande annulée

Champs de données essentiels

Commande livrée

Champs de données essentiels

Commande échouée

Champs de données essentiels

Commande en cours de livraison

Champs de données essentiels

Commande produite

Champs de données essentiels

Commande reçue

Champs de données clés

Commande retournée

Champs de données essentiels

Commande expédiée

Champs de données essentiels

Travailler avec les métadonnées

Exemples d’utilisation des métadonnées :

Utiliser ces données dans les modèles