Lorsque vous utilisez la méthode shiplineitems, vous devez fournir la quantité ainsi qu'un identifiant pour chacun des articles que vous souhaitez expédier. Vous avez la possibilité de vous servir de la valeur LineitemId ou de l'identifiant produit REST (chaîne:langue:pays:ID de l'article du marchand), que vous pouvez trouver lorsque vous récupérez une commande via la méthode list.
Vous devez indiquer ces propriétés pour chaque article, et remplir le champ shipmentInfos dans le corps de la requête de la méthode shiplineitems. Le champ shipmentInfos contient l'ID du colis (shipmentId), le nom du transporteur (carrier) et l'ID de suivi (trackingID) pour chaque colis de la commande. Ce champ peut être utilisé plusieurs fois dans un seul appel, car un même article peut être expédié en plusieurs colis (et être associé à plusieurs ID de suivi) et doit disposer d'un champ shipmentInfos distinct pour chacun d'entre eux.
Vous pouvez envisager trois scénarios différents, en fonction de vos besoins :
Plusieurs articles – Colis/ID de suivi uniques
Si vous souhaitez expédier plusieurs articles dans un même colis, vous devez appeler la méthode shiplineitems une fois, insérer une section shipmentInfos dans le corps de votre requête et ajouter plusieurs articles, en spécifiant les champs shipmentId, carrier et trackingId. Imaginons, par exemple, que vous recevez une commande composée d'une clé USB et d'un DVD que vous expédiez dans le même colis, comme illustré ci-dessous.
Le corps de la requête pour cet appel doit se présenter comme suit :
{
"lineItems": [
{
"lineItemId": "2IDODSM5LLCZEYE",
"quantity": 1
},
{
"ProductId": "online:eng:US:df4sg5ds",
"quantity": 1
}
],
"shipmentInfos": [
{
"shipmentId": "12345",
"carrier": "FedEx",
"trackingId": "12222"
}
]
}
Un seul article – Plusieurs colis/ID de suivi
Si vous souhaitez livrer un article trop volumineux pour être expédié en un seul colis (par exemple, une grande table à assembler chez soi), vous pouvez effectuer l'envoi en plusieurs colis. Appelez une seule fois la méthode shiplineitems, mais saisissez un seul champ lineitemId et plusieurs sections shipmentInfos, avec un ID d'envoi (shipmentId) pour chaque colis distinct, comme dans l'exemple ci-dessous.
Le corps de la requête pour cet appel doit se présenter comme suit :
{
"lineItems": [
{
"lineItemId": "CYBIDQWXDKCZEYE",
"quantity": 1
}
],
"shipmentInfos": [
{
"shipmentId": "shipment-1",
"carrier": "FedEx",
"trackingId": "22222"
},
{
"shipmentId": "shipment-2",
"carrier": "FedEx",
"trackingId": "33333"
},
{
"shipmentId": "shipment-3",
"carrier": "FedEx",
"trackingId": "4444"
}
]
}
Plusieurs articles – Plusieurs colis/ID de suivi
Si vous souhaitez scinder des commandes et expédier plusieurs articles dans plusieurs colis, vous devez appeler la méthode shiplineitems plusieurs fois pour que chaque livraison corresponde à l'un des scénarios ci-dessus. Vous devez obligatoirement respecter cette consigne, car les articles ne peuvent pas être associés à des valeurs shipmentInfos spécifiques lorsque vous définissez plusieurs valeurs pour chacun d'eux. Le suivi d'une commande dont les articles ont été répartis dans plusieurs colis et envoyés avec d'autres produits peut s'avérer difficile, car les clients ne recevront un avis de livraison qu'une fois que tous les articles auront été marqués comme livrés. Afin de garantir la meilleure expérience possible au client lorsqu'il a commandé un article volumineux, expédiez-lui un seul colis avec suivi de livraison, car cela ne nécessite de suivre qu'un colis et de recevoir qu'un seul avis de livraison.
Vous pouvez vous trouver dans l'une des situations suivantes :
Un article volumineux expédié dans plusieurs colis (par exemple, la table de l'exemple ci-dessus)
Deux articles plus petits dans un colis avec l'article le plus volumineux, par exemple le DVD, la clé USB et une partie de la table
Dans ce scénario, trois colis distincts sont envoyés. L'un des colis contient deux articles (clé USB et DVD) et une partie du troisième article (la table), tandis que le deuxième et le troisième colis contiennent les deux autres parties de l'article (la table) qui a été expédié en trois colis. Vous devez appeler la méthode shiplineitems deux fois, en utilisant un total de quatre entrées différentes pour le champ des informations d'envoi : la première fois pour la livraison de plusieurs articles dans un seul colis, puis la seconde fois pour la livraison d'un article dans plusieurs colis.
Premier appel – Plusieurs articles avec un seul champ d'informations d'envoi
Dans cet exemple, vous appelez une première fois la méthode shiplineitems pour expédier plusieurs articles dans un même colis.
{
"lineItems": [
{
"lineItemId": "TOTZQWXDKCZEYE",
"quantity": 1
},
{
"lineItemId": "DEIDQWXDKCZEYE",
"quantity": 1
}
],
"shipmentInfos": [
{
"shipmentId": "Shipment-1",
"carrier": "FedEx",
"trackingId": "11111"
}
]
}
Second appel – Un seul article avec trois champs d'informations d'envoi
Dans cet exemple, vous appelez la méthode shiplineitems pour expédier le même article dans plusieurs colis.
{
"operationId": "operation-2",
"lineItems": [
{
"lineItemId": "BBIDQWXDKCZEYE",
"quantity": 1
}
],
"shipmentInfos": [
{
"shipmentId": "shipment-2",
"carrier": "FedEx",
"trackingId": "1111"
},
{
"shipmentId": "shipment-3",
"carrier": "UPS",
"trackingId": "33333"
},
{
"shipmentId": "shipment-4",
"carrier": "Hermes",
"trackingId": "44444"
}
]
}