Obtenez les méthodes d'expédition en fonction de l'adresse et des paramètres du colis.
Renvoie la liste des méthodes de retour pour un partenaire donné avec des paramètres supplémentaires comme la disponibilité.
POST /v1/shipping-methods/quote
Exemple de demande
{ "orderReferenceId": "EXMPL0001234", "currency": "EUR", "options": { "weightUnit": "g", "dimensionUnit": "mm", "label": { "format": "pdf" } }, "partner": { "clientName": "ExampleCustomer" }, "receiver": { "person": { "firstName": "Foo", "lastName": "Bar", "company": "", "email": "[email protected]", "phone": "01273552886" }, "address": { "country": "GB", "state": "East Sussex", "city": "Brighton", "postcode": "BN1 8YQ", "addressLine1": "11 London Rd", "addressLine2": "", "addressLine3": "", "street": "London Rd", "houseNumber": "11", "suburb": null }, "customs": { "vatNumber": null } }, "sender": { "person": { "firstName": "", "lastName": "", "company": "Example Company", "email": "[email protected]", "phone": "01666 123456" }, "address": { "country": "DE", "state": "", "city": "Donauwörth", "postcode": "86609", "addressLine1": "Am Wassergraben 11", "addressLine2": null, "addressLine3": null, "street": "Am Wassergraben", "houseNumber": "11", "suburb": null }, "customs": { "vatNumber": "DE123456789000", "iossNumber": null, "eoriNumber": "GB987654321000", "pcccNumber": null, "australianBusinessNumber": null } }, "packages": [ { "packageReferenceId": "EXMPL0001234-0-1", "grossWeight": 810, "netWeight": 760, "length": 229, "width": 200, "height": 36, "boxType": "rectangle", "volumetricWeight": 700, "items": [ { "itemReferenceId": "EXMPL0001234-0-1-ITEM1", "description": "Mug", "value": 48, "quantity": 4, "weight": 760, "hsCode": "44199090", "countryOfOrigin": "DE" } ] } ]}Exemple de réponse de réussite
{ "items": [ { "carrier": { "name": "DHL", "uid": "dhl" }, "method": { "name": "DHL Global Parcel", "uid": "dhl_global_parcel", "price": 3.32, "maxShipmentDays": 5, "minShipmentDays": 2, "deliveryPaddingDays": 0 } }, { "carrier": { "name": "UPS", "uid": "ups" }, "method": { "name": "UPS Standard Tariff", "uid": "ups_standard_tariff", "price": 5.25, "maxShipmentDays": 5, "minShipmentDays": 2, "deliveryPaddingDays": 0 } } ], "count": 2}Exemple de réponse d'erreur
{ "orderReferenceId": "EXMPL0001234", "code": "VALIDATION_ERROR", "message": "There are errors in submitted data", "errors": [ { "code": "NO_SUCH_CHOICE_ERROR", "reference": "options.label.format", "message": "The value you selected is not a valid choice." }, { "code": "IS_BLANK_ERROR", "reference": "receiver.address.country", "message": "This value should not be blank." } ]}Demande
Paramètre | Type | Description |
orderReferenceId (obligatoire) | chaîne | Identifiant unique pour la commande d'expédition. Identifiant fourni par vous. |
Devise (obligatoire) | chaîne | Devise de la commande d'expédition au format à 3 lettres. |
Options (facultatif) | Options | Paramètres facultatifs. |
Partenaire (optionnel) | Partenaire | Détails du partenaire. |
destinataire (obligatoire) | Récepteur | Détails du destinataire. |
Expéditeur (obligatoire) | Expéditeur | Détails de l'expéditeur. |
Colis (obligatoire) | Colis[] | Détails du colis. |
Options
Paramètre | Type | Description |
weightUnit (facultatif) | chaîne | Unité de poids. Choix disponibles : g, kg, oz, lb. Par défaut : g. |
Unité de dimension (facultatif) | chaîne | Unité de longueur. Choix disponibles : mm, cm, po. Par défaut : mm. |
Étiquette (facultatif) | Étiquette | Paramètres du format d'étiquette. |
Étiquette
Paramètre | Type | Description |
Format (facultatif) | chaîne | Format d'étiquette. Choix disponibles : pdf, zpl (*). Par défaut : pdf. |
Remarque : Les formats autres que PDF peuvent ne pas être activés pour certains transporteurs.
Partenaire
Paramètre | Type | Description |
Nom du client (facultatif) | chaîne | Expédition du profil client. |
Destinataire
Paramètre | Type | Description |
Personne (obligatoire) | ReceiverPerson | Détails personnels du destinataire. |
Adresse (obligatoire) | Adresse | Détails de l'adresse du destinataire. |
Personnalisé (facultatif) | Douanes du destinataire | Détails des douanes du destinataire. |
Expéditeur
Paramètre | Type | Description |
Personne (obligatoire) | Nom de l'expéditeur | Détails personnels de l'expéditeur. |
Adresse (obligatoire) | Adresse | Détails de l'adresse de l'expéditeur. |
Douanes (obligatoire pour les expéditions internationales) | Douanes de l'expéditeur | Détails douaniers de l'expéditeur. |
Personne destinataire
Paramètre | Type | Description |
Prénom (obligatoire) | chaîne | Prénom du destinataire. |
Nom de famille (obligatoire) | chaîne | Nom de famille du destinataire. |
Entreprise (facultatif) | chaîne | Le titre de l'entreprise. |
E-mail (optionnel*) | chaîne | Adresse e-mail de la personne. Cela peut être utilisé pour les notifications d'expédition. |
Téléphone (optionnel*) | chaîne | Numéro de téléphone de la personne. Cela peut être utilisé pour les notifications d'expédition. |
Remarque : *L'e-mail et le téléphone peuvent être des champs obligatoires selon le transporteur.
Nom de l'expéditeur
Paramètre | Type | Description |
Prénom (facultatif) | chaîne | Prénom de l'expéditeur ou de l'expéditrice. |
Nom de famille (optionnel) | chaîne | Nom de famille de l'expéditeur. |
Entreprise (obligatoire) | chaîne | Le nom de l'entreprise expéditrice. |
E-mail (optionnel*) | chaîne | Adresse e-mail de la personne ou de l'entreprise expéditrice. |
Téléphone (optionnel*) | chaîne | Numéro de téléphone de la personne ou de l'entreprise expéditrice. |
Remarque : *L'e-mail et le téléphone peuvent être des champs obligatoires selon le transporteur.
Adresse
Paramètre | Type | Description |
Pays (obligatoire) | chaîne | Code pays au format à 2 lettres. |
État (optionnel*) | chaîne | État / comté / région. |
ville (obligatoire) | chaîne | Ville. |
Code postal (obligatoire) | chaîne | Code postal. |
addressLine1 (obligatoire) | chaîne | Première ligne de l'adresse postale. Doit inclure la rue et le numéro de maison. |
Adresse ligne 2 (facultatif) | chaîne | Deuxième ligne de l'adresse postale. Numéro d'appartement / de bureau / d'étage. |
Ligne d'adresse 3 (facultatif) | chaîne | Troisième ligne de l'adresse postale. |
Rue (optionnel*) | chaîne | Rue (obligatoire pour les adresses en Allemagne). |
Numéro de maison (optionnel*) | chaîne | Numéro de maison (obligatoire pour les adresses en Allemagne). |
Banlieue (optionnel*) | chaîne | Banlieue (obligatoire pour les adresses en Australie/Nouvelle-Zélande). |
Remarque : *Ces champs facultatifs sont obligatoires pour certains pays et transporteurs.
Douanes du destinataire
Paramètre | Type | Description |
vatNumber (facultatif) | chaîne | Numéro de TVA du destinataire. |
ExpéditeurDédouanement
Paramètre | Type | Description |
Numéro de TVA (facultatif*) | chaîne | Numéro de TVA de l'expéditeur. |
Numéro IOSS (optionnel*) | chaîne | Numéro IOSS de l'expéditeur. |
Numéro EORI (facultatif*) | chaîne | Numéro EORI de l'expéditeur. |
pcccNumber (optionnel*) | chaîne | Numéro PCCC de l'expéditeur. |
Numéro d'entreprise australien (optionnel*) | chaîne | Numéro d'entreprise australien de l'expéditeur. |
Remarque : *Selon le pays d'expédition et de réception, ces champs peuvent être obligatoires.
Emballage
Paramètre | Type | Description |
packageReferenceId (obligatoire) | chaîne | ID du colis fourni par le partenaire. |
Poids brut (obligatoire) | nombre | Poids de l'emballage + poids des articles (en grammes par défaut). |
netWeight (optionnel) | nombre | Poids des articles (en grammes par défaut). |
Longueur (obligatoire) | nombre | Longueur du colis (en mm par défaut). |
Largeur (obligatoire) | nombre | Largeur du colis (en mm par défaut). |
Hauteur (obligatoire) | nombre | Hauteur du colis (en mm par défaut). |
volumetricWeight (facultatif) | nombre | Poids calculé en fonction de la taille du colis (en grammes par défaut). |
Type de boîte (facultatif) | chaîne | Forme de la boîte (par exemple, rectangle, tube). |
valeur (requis pour les expéditions internationales) | nombre | Valeur totale de tous les articles du colis (dans la devise sélectionnée). |
articles (obligatoire pour les expéditions internationales) | Article[] | Liste des articles dans le colis. |
Article*
Paramètre | Type | Description |
itemReferenceId (obligatoire) | chaîne | ID de l'article du colis fourni par le partenaire. |
Description (obligatoire) | chaîne | Description de l'article. |
Quantité (obligatoire) | nombre | Quantité de l'article. |
valeur (obligatoire) | nombre | Valeur de l'article (dans la devise sélectionnée). |
Poids (obligatoire) | nombre | Poids de l'article (en grammes par défaut). |
Code SH (obligatoire) | chaîne | Code du Système harmonisé (Wiki). |
Pays d'origine (obligatoire) | chaîne | Code pays au format à 2 lettres où l'article a été produit. |
Remarque : *Tous les paramètres d'article sont requis uniquement pour l'expédition internationale.
Réponse réussie
Paramètre | Type | Description |
compter | nombre | Nombre de résultats trouvés. |
articles | ResponseItems | Un tableau des devis |
ResponseItems
Paramètre | Type | Description |
transporteur | ResponseItemsCarrier | Détails du transporteur. |
méthode | ResponseItemsMethod | Détails de la méthode d'expédition. |
ResponseItemsCarrier
Paramètre | Type | Description |
transporteur | chaîne | Transporteur utilisé pour la commande. |
UID | chaîne | Méthode d'expédition utilisée pour la commande. |
ResponseItemsMethod
Paramètre | Type | Description |
Nom | chaîne | Nom de la méthode d'expédition. |
uid | chaîne | UID du mode d'expédition. |
Prix | nombre | Prix estimé de la méthode d'expédition pour le partenaire. |
maxShipmentDays | nombre | Nombre maximum de jours d'expédition pour la méthode d'expédition. |
minShipmentDays | nombre | Méthode d'expédition : nombre minimum de jours d'expédition. |
deliveryPaddingDays (optionnel) | nombre | Jours de livraison supplémentaires pour la méthode d'expédition. |
Réponse d'erreur
Paramètre | Type | Description |
identifiant de référence de commande | chaîne | UID unique pour la commande d'expédition fourni par vous. |
code | chaîne | Code d'erreur. |
message | chaîne | Message d'erreur. |
Détail (facultatif) | objet | Message d'erreur détaillé (objet JSON d'une structure arbitraire). |
Erreurs (facultatif) | ResponseErrorDetails[] | Liste d'erreurs. |
ResponseErrorDetails
Paramètre | Type | Description |
code | chaîne | Code d'erreur. |
message | chaîne | Message d'erreur |
Référence (facultatif) | chaîne | ID de référence. |
Étape suivante : 🔗[GCL] API logistique - Suivi
📝 Pas ce dont vous aviez besoin ?
Aidez-nous à améliorer cet article, envoyez-nous un e-mail à [email protected] — veuillez inclure le titre de l'article.