GÉNÉRER UNE ÉTIQUETTE TRANSPORTEUR PAR API

Bénéfices de la fonctionnalité ✨

Automatisation des expéditions : génération d’étiquettes transport directement via API.
Sécurisation des données : validation des payloads avant envoi aux transporteurs.
Flexibilité technique : compatible avec Shippingbo OMS ou un OMS externe.
Gain de temps : réduction des interventions manuelles sur les commandes expédiées.

1. Prérequis

Avoir déjà configuré une application API Shippingbo.

Plus d'informations ici : CRÉER UNE APPLICATION API SHIPPINGBO.
Avoir des connaissances techniques pour l’utilisation des API (curl, PHP, etc.).

2. Comment fonctionne la génération des étiquettes par API dans Shippingbo ?

2.1 Envoyer la première requête API

Vous pouvez tester l’accès et l’authentification via l’endpoint Try your implementation.

➡️Cas 1 : En utilisant Shippingbo OMS (recommandé)

L’API retourne un payload par défaut avec de fausses étiquettes
Aucun appel réel n’est effectué vers le transporteur
Shippingbo vérifie la cohérence des données envoyées (ex. sbo_order_id, address_label_config_id) avec votre OMS et vos paramètres.

➡️Cas 2 : En utilisant votre propre OMS

Le Shippingbo TMS n’ayant pas accès à votre OMS, vous devez fournir davantage de champs obligatoires
Toutes les informations logistiques doivent être incluses dans la requête API.

Exemple : Si vous utilisez un OMS externe, vous devez transmettre l’ensemble des données commande et livraison dans le payload afin que Shippingbo puisse générer les étiquettes.

2.2 Passage en production

Lorsque votre système est capable de gérer toutes les réponses API et de traiter les erreurs potentielles, vous pouvez alors utiliser l’endpoint Generate labels pour générer de vraies étiquettes transporteurs.

⭐ Point clé :

Chaque transporteur dispose de ses propres règles de validation.

➡️ Un champ peut donc être obligatoire pour un transporteur et ne pas l’être pour un autre.

➡️ Des erreurs de type Missing field peuvent donc apparaître selon le transporteur sélectionné, qu'il conviendra de corriger en ajoutant les champs nécessaires.

2.3 Marquer l’expédition comme envoyée (Shippingbo OMS uniquement)

Une fois les étiquettes générées et les colis prêts, vous devez informer Shippingbo que la commande est expédiée en utilisant l'appel API Mark your shipment as shipped.

➡️ Le consignment_id doit être identique à celui utilisé lors de l'appel Generate labels

La commande Shippingbo passe alors au statut Expédiée (toutes les notifications sont déclenchées automatiquement : SMS, emails, webhooks, etc).

3. Exemple de mise en pratique

Contexte : Un e-commerçant utilisant un OMS externe génère automatiquement ses étiquettes Chronopost via l’API Shippingbo TMS, puis déclenche l’expédition et les notifications clients sans intervention manuelle.

⚒️ Cadre et responsabilités :

Avant d’utiliser pleinement la fonctionnalité décrite dans ce tutoriel, il est vivement recommandé de réaliser une phase de test suivant vos propres paramètres afin de vérifier que le résultat correspond à vos attentes. Le client restant entièrement responsable des actions réalisées sur son compte Shippingbo, ces tests sont essentiels pour assurer l'utilisation de l'outil en toute sérénité.

Pour aller plus loin 🛫

- Générer une étiquette transporteur

- Créer une application API

Nous contacter 📬

Des questions à propos de cette fonctionnalité ?

N'hésitez pas à nous écrire ici afin que nous puissions répondre à vos questions.