Comment passer une commande en utilisant un produit client

Ce guide vous accompagne dans le processus de passation d'une commande en utilisant un produit client via l'API GelatoConnect. Les produits clients vous permettent d'utiliser vos propres configurations de produits lors de la passation de commandes, simplifiant ainsi le processus de commande et garantissant la cohérence avec vos définitions de produits internes.

Point de terminaison API

POST https://order.ie.live.gelato.tech/api/v4/orders

Structure de la requête

Les éléments clés pour utiliser un produit client dans votre commande sont les champs productName et productVariant dans le tableau items. Voici un exemple de structure de requête :

{
    "clientId": "your-client-id",
    "orderReferenceId": "your-order-reference",
    "customerReferenceId": "your-customer-reference",
    "orderType": "order",
    "currency": "USD",
    "retailCurrency": "USD",
    "retailShippingPriceInclVat": 5.99,
    "shippingAddress": {
        "country": "US",
        "firstName": "John",
        "lastName": "Doe",
        "addressLine1": "123 Main St",
        "city": "Anytown",
        "postCode": "12345",
        "state": "CA",
        "email": "[email protected]",
        "phone": "1234567890"
    },
    "items": [
        {
            "itemReferenceId": "your-item-reference",
            "productName": "sample for order intake",
            "productVariant": {
                "paper": "a1",
                "color": "front"
            },
            "files": [
                {
                    "type": "default",
                    "url": "https://example.com/your-file.pdf"
                }
            ],
            "quantity": 1,
            "retailPriceInclVat": 79.99
        }
    ]
}

Champs clés pour les produits clients

Lorsque vous utilisez un produit client, portez une attention particulière à ces champs dans le tableau items :

productName : cela doit correspondre au nom de votre produit client tel que défini dans GelatoConnect.
productVariant : Cet objet contient les options spécifiques pour votre produit. Les clés et les valeurs doivent correspondre aux options de variante que vous avez configurées pour votre produit client.

Dans l'exemple ci-dessus :

"productName": "sample for order intake",
"productVariant": {
    "paper": "a1",
    "color": "front"
}

Cette configuration indique à GelatoConnect d'utiliser le produit client nommé « sample for order intake » avec les options de papier et de couleur spécifiées.

Notes importantes

Lorsque vous utilisez un produit personnalisé, vous n'avez pas besoin de fournir un productUid pour l'article. Les champs productName et productVariant sont utilisés à la place pour déterminer la configuration exacte du produit.
Assurez-vous que le productName correspond exactement au nom de votre produit client dans GelatoConnect.
L'objet productVariant ne doit inclure que les options que vous avez définies pour votre produit client. L'inclusion d'options non définies entraînera une erreur.
Le reste de la structure de la demande de commande reste identique à une commande standard. Vous pouvez inclure plusieurs articles, chacun utilisant un produit client différent si nécessaire.
Assurez-vous toujours que les fichiers que vous fournissez correspondent aux exigences de la configuration de votre produit client.

Réponse

Après avoir passé une commande avec succès, vous recevrez une réponse qui inclut les détails de la commande, notamment un identifiant de commande, le statut du traitement des commandes, et plus encore. Vérifiez toujours la réponse pour vous assurer que votre commande a été traitée correctement.

Dépannage

Si vous rencontrez des problèmes lors de la passation d'une commande avec un produit client, vérifiez les points suivants :

Vérifiez que le productName correspond exactement au nom de votre produit client.
Assurez-vous que toutes les options productVariant requises sont fournies et correspondent à votre configuration de produit client.
Vérifiez que les fichiers fournis répondent aux exigences de votre produit client.
Vérifiez que vos identifiants API sont corrects et que vous avez l'autorisation d'utiliser le produit client spécifié.

[Order Intake - GCW] Passer une commande en utilisant Customer Product