API Etiquette

Un chargeur/ donneur d'ordre peut utiliser avantageusement l'API étiquette du GTF pour obtenir des étiquettes colis conformes aux plans de routage de son sous-traiant et éventuellement au calcul d'un code à barres unique pour ses unités de manutention.

Aspects fonctionnels de l’API étiquette 2.1. Demande d’étiquettes

L’objectif de ce guide est de présenter la recommandation d’API étiquette du GTF, conçue pour faciliter l’interopérabilité entre les systèmes d’information des chargeurs et des transporteurs.

De façon générale, l’API proposée permet à un chargeur d’interroger le web service de son transporteur pour obtenir les étiquettes colis comportant toutes les informations nécessaires à un transport de qualité.

Par extension, l’API du GTF s’applique également dans une relation entre deux transporteurs.

Cette API se veut un standard pour permettre au chargeur de rentabiliser l’implémentation de celle-ci par sa réutilisation avec d’autres partenaires ayant adopté cette même structure.

La demande comme la réponse ne repose sur aucun format d’étiquette et peut donc s’utiliser avec les étiquettes telles que préconisées par le GTF, comme avec d’autres étiquettes sectorielles.

Cas chargeur :

Le chargeur, en compte dans une agence, interroge son transporteur avant la prise en charge pour étiqueter les colis en sortie de préparation de commande.

Le chargeur (donneur d’ordre) est reconnu par son identifiant (par exemple un SIRET et éventuellement son compte de facturation - référence dans les messages INOVERT : CAG 1296), il s’adresse à l’API de son transporteur et identifie l’agence par un code agence (code de gré à gré). Exemples :

  • Création des étiquettes pour 1 expédition, 2 colis, au format ZPL. L’appel se fait sans les codes-barres UM, ceux-ci sont retournés par l’API.
  • Création des étiquettes pour 1 expédition, 2 colis, au format PDF. L’appel se fait sans les codes-barres UM, ceux-ci sont retournés par l’API.
  • Création d’une étiquette pour 1 expédition de 1 colis. Puis, ajout d’un colis sur cette expédition. L’appel se fait sans les codesbarres UM, ceux-ci sont retournés par l’API.
  • Création des étiquettes pour 1 expédition de 3 colis. Puis, appel pour rééditer la 2ème étiquette. L’appel se fait sans les codesbarres UM, ceux-ci sont retournés par l’API.

Cas transporteur :

Un transporteur, connu chez un confrère, l’interroge pour constituer l’étiquette qui servira à la livraison.

Le confrère répondra donc de façon identique à une interrogation de chargeur en retournant les codes-barres et/ou l’ensemble de l’étiquette.

Le transporteur est reconnu par son identifiant (par exemple son SIRET), il s’adresse à l’API de son confrère et identifie l’agence par son SIRET. Exemples :

  • Création des étiquettes pour 1 expédition de 3 colis, au format ZPL, les codes-barres UM et le numéro de récépissé sont transmis dans l’appel
  • Création des étiquettes pour 1 expédition de 3 colis, au format ZPL, les codes-barres UM et le numéro de récépissé ne sont pas transmis dans l’appel

Les exemples transporteurs peuvent être valables dans des cas chargeurs et réciproquement. Nous vous invitons à trouver les exemples développés et les étiquettes résultantes dans les annexes de ce guide.

Remarque : Ce guide part du principe que la demande API n’est pas enregistrée, ni par l’émetteur, ni par le récepteur.

Par contre, le GTF préconise d’utiliser un indicateur dans cette demande pour permettre d’obtenir le document d’impression global des n étiquettes demandées, ou le document par étiquettes.

La réponse pourra ainsi, si enregistrée, permettre de réimprimer le colis x sur n, sans réappeler l’API.

Partager

Mis à jour le

08/11/2021