Fedex Logo
Developer Portal

Open Ship API

Introduction

Cette API vous permet de créer un envoi ouvert et d’ajouter des colis à l’envoi durant une période de temps plutôt que d’entrer tous les envois et les renseignements du colis en même temps. L’envoi reste ouvert pendant une période de cinq jours et accepte les ajouts et les modifications de colis pendant cette période. Une fois que l’envoi est confirmé, vous pouvez produire les documents d’envoi comme les étiquettes, le LTA et les rapports. À la fin du cinquième jour, l’envoi doit être confirmé, sinon, il sera supprimé.

Remarque : Les envois ouverts seront purgés s’ils ne sont pas confirmés à la fin du cinquième jour de la création de l’envoi.

Détails de l’API d’envois ouverts

L’API d’envois ouverts est utilisée lorsque vous voulez ajouter plusieurs colis à un envoi durant une période de temps et que vous n’êtes pas certain du nombre de colis que vous prévoyez ajouter ou du moment où l’envoi sera terminé. Elle vous offre une façon flexible de préparer votre envoi tout au long de la journée jusqu’à ce que vous soyez prêt à expédier.

Les envois ouverts sont souvent des envois multipièces, mais il peut aussi s’agir d’envois à colis unique, aussi appelés envois à pièce unique.

Pour expédier un envoi multipièces à un seul destinataire, utilisez l’API d’envois ouverts et ajoutez des colis individuels à l’envoi ou ajoutez plusieurs colis s’ils sont destinés au même destinataire.

Voici les services associés à un envoi ouvert :

  • FedEx ExpressMD à l’intérieur des États-Unis et du Canada
  • FedEx GroundMD à l’intérieur des États-Unis et du Canada
  • FedEx Home DeliveryMD
  • FedEx International PriorityMD
  • FedEx International PriorityMD Express (IPE)
  • FedEx International EconomyMD
  • FedEx Priority OvernightMC
  • FedExMD Regional Economy
  • FedExMD Regional Economy Freight
  • FedEx International Connect PlusMD
  • FedExMD First
  • FedEx Priority Express
  • FedEx Priority
  • FedEx Priority Express Freight
  • FedEx Priority Freight
  • FedEx Economy (uniquement au Royaume-Uni)

Voici les fonctionnalités associées à l’API d’envois ouverts :

Gérer les envois ouverts

Cette fonctionnalité permet aux expéditeurs de créer, de modifier et de supprimer des envois ouverts ainsi que de récupérer des envois ouverts déjà créés à des fins d’examen ou de vérification. Elle permet de confirmer les envois terminés afin de transférer les données d’envoi à FedEx et de générer les documents d’envoi appropriés. Elle permet également de trouver les erreurs dans la transaction, de les signaler, le cas échéant, et de fournir l’état approprié.

Les renseignements clés de cette fonctionnalité sont le numéro de compte, les données d’envoi, le nombre de colis du groupe et l’index pour indiquer le colis principal dans l’envoi. Grâce à cette fonctionnalité, les données d’envoi sont téléversées dans les systèmes FedEx et les numéros de suivi, les étiquettes et les rapports sur les envois appropriés sont générés.

Gérer les colis d’un envoi ouvert

Cette fonctionnalité vous permet d’ajouter, de modifier et de supprimer des colis dans un envoi ouvert déjà créé. Il est également possible de récupérer le colis existant pour un envoi ouvert.

Obtenir les résultats des envois ouverts (asynchrone)

Cette fonctionnalité permet de récupérer les résultats d’envois confirmés de façon asynchrone. Lorsqu’un envoi ouvert de 40 colis ou plus est confirmé, l’API traite l’envoi de façon asynchrone.

Lorsque l’envoi est traité de manière asynchrone, la réponse confirme seulement que cette demande a été placée dans la file d’attente, mais il est possible que l’envoi ne soit pas traité. La réponse comprend une ID tâche pour récupérer le résultat plus tard. Cette fonctionnalité utilise une ID tâche pour récupérer les résultats de l’envoi ouvert (CRÉER, MODIFIER et CONFIRMER) qui pourraient être des étiquettes et des rapports d’envois.Elle permet également de trouver les erreurs dans l’envoi et de les signaler, le cas échéant, et fournit l’état approprié.

Remarque : S’il y a des erreurs dans la réponse d’envoi asynchrone, corrigez-les et soumettez une nouvelle demande d’expédition.

Flux de travail de l’API d’envois ouverts

Cette section décrit en détail le flux de travail de l’API d’envois ouverts. Le flux de travail des envois ouverts est géré de deux façons ou à l’aide de deux options de traitement :

Flux de travail pour 40 colis ou moins

  1. Utilisez le point de terminaison Créer un envoi ouvert pour créer un envoi ouvert avec tous les renseignements d’expédition et d’emballage nécessaires ainsi que le numéro de compte et l’index.
  2. Utilisez le point de terminaison Ajouter des colis à un envoi ouvert pour ajouter un ou plusieurs (pas plus de 40) colis à l’envoi ouvert déjà créé. Les renseignements d’entrée clés sont l’index et le numéro de compte de l’envoi ouvert auquel les colis sont ajoutés.
  3. Utilisez le point de terminaison Confirmer un envoi ouvert pour finalement confirmer que tous les colis ont été ajoutés et que l’envoi est complet. Les renseignements d’entrée clés sont l’index et le numéro de compte de l’envoi à confirmer.

Le point de terminaison Confirmer un envoi ouvert est le dernier de ce flux qui valide les renseignements de l’envoi et des colis et il permet de générer des étiquettes et tous les autres rapports de l’envoi. Il fournit également les détails des erreurs renvoyées durant la validation. Ces erreurs peuvent être corrigées à l’aide des points de terminaison Modifier un envoi ouvert ou Modifier les colis d’un envoi ouvert et en confirmant à nouveau l’envoi pour une demande réussie.

Flux de travail pour plus de 40 colis

  1. Utilisez le point de terminaison Créer un envoi ouvert pour créer un envoi ouvert avec tous les renseignements d’expédition et d’emballage nécessaires ainsi que le numéro de compte et l’index.
  2. Utilisez le point de terminaison Ajouter des colis à un envoi ouvert pour ajouter un ou plusieurs (pas plus de 40) colis à l’envoi ouvert déjà créé. Les renseignements d’entrée clés sont l’index et le numéro de compte de l’envoi ouvert auquel les colis seront ajoutés.
  3. Utilisez le point de terminaison Confirmer un envoi ouvert pour confirmer que tous les colis ont été ajoutés et que l’envoi est complet. Les renseignements d’entrée clés sont l’index et le numéro de compte de l’envoi à confirmer. Dans cette situation, comme il y a plus de 40 colis, l’API traite l’envoi de façon asynchrone et renvoie un ID tâche qui sera utilisé plus tard pour récupérer les résultats de l’envoi. Si la réponse contient des erreurs, celles-ci doivent être corrigées à l’aide des points de terminaison Modifier un envoi ouvert ou Modifier les colis d’un envoi ouvert, puis en confirmant l’envoi à l’aide du point de terminaison Confirmer un envoi ouvert.
  4. Utilisez le point de terminaison Obtenir les résultats d’un envoi ouvert pour récupérer les résultats de l’envoi ouvert Créer, modifier et confirmer, comme les étiquettes et les documents d’expédition.Les renseignements d’entrée clés sont la ID tâche et le numéro de compte de l’envoi confirmé.

Le point de terminaison Obtenir les résultats d’un envoi ouvert est le dernier de ce flux et il récupère les résultats confirmés de l’envoi ouvert comme les étiquettes et tous les autres rapports pour l’envoi ouvert confirmé. Si les détails de l’erreur sont retournés dans la réponse, vous pouvez modifier ces erreurs à l’aide des points de terminaison Modifier un envoi ouvert ou Modifier les colis d’un envoi ouvert, puis confirmer l’envoi à l’aide du point de terminaison Confirmer un envoi ouvert et finalement, utiliser le point de terminaison Obtenir les résultats d’un envoi ouvert pour récupérer les résultats de l’envoi ouvert confirmé pour la demande réussie.

Fonctionnement de l’API d’envois ouverts

Voici les fonctions associées à l’API d’envois ouverts

Créer un envoi ouvert

Utilisez ce point de terminaison pour créer un envoi ouvert qui contient les renseignements d’envoi requis et donnez des détails pour au moins un colis dans l’envoi.

Voici les renseignements d’entrée requis pour créer l’envoi ouvert :

  • openShipmentAction – Ceci est l’action de l’envoi ouvert et, dans le cas présent, utilisez la valeur comme CRÉER_COLIS.
  • accountNumber – Ceci est le numéro de compte FedEx.
  • requestedShipment – Les détails d’envoi de l’envoi ouvert.
  • index –La valeur unique pour l’envoi ouvert. Cette valeur est utile pour modifier l’envoi ou le colis. Ce renseignement est facultatif. Si vous ne l’indiquez pas, le numéro de suivi principal peut être utilisé uniquement pour identifier l’envoi.

Une réponse positive à cette demande traitera l’envoi et générera un numéro de suivi qui est un numéro de suivi principal pour le premier colis. Veuillez noter qu’aucune étiquette ne sera générée dans la réponse.

Ajouter des colis à un envoi ouvert

Utilisez ce point de terminaison pour ajouter un ou plusieurs colis à la demande d’envoi ouvert existante avant de confirmer l’envoi. Vous pouvez envoyer une demande Ajout de colis distincte pour chacun de vos colis lorsque vous préparez votre envoi tout au long de la journée. Vous pouvez également envoyer plusieurs pièces dans la demande Ajout de colis.

Remarque : Le nombre total de colis pour l’envoi ne doit pas dépasser la limite de colis de l’envoi ouvert.

Voici les renseignements d’entrée requis pour ajouter des colis à l’envoi ouvert :

  • index – Valeur unique attribuée à l’envoi ouvert déjà créé. Si cette valeur n’est pas disponible, veuillez fournir le numéro de suivi principal.
  • requestedPackageLineItem – Renseignements détaillés du colis à ajouter.
  • accountNumber – Ceci est le numéro de compte FedEx.

La réponse positive à cette demande générera un numéro de suivi pour le colis nouvellement ajouté.

Modifier des colis dans un envoi ouvert

Utilisez ce point de terminaison pour modifier un ou plusieurs colis dans un envoi ouvert déjà existant avant de confirmer l’expédition. Cela comprend également le colis principal, qui est le premier colis qui a été ajouté à l’envoi ouvert.

Vous trouverez ci-dessous les renseignements d’entrée requis pour cette demande :

  • index – Valeur unique attribuée à l’envoi ouvert déjà créé. Si cette valeur n’est pas disponible, veuillez fournir le numéro de suivi principal.
  • accountNumber – Ceci est le numéro de compte FedEx.
  • trackingId – Un ou plusieurs ID suivi de colis d’un envoi ouvert pour les colis à modifier.
  • requestedPackageLineItem – Renseignements détaillés du ou des colis à modifier.

Une demande réussie mettra à jour les colis concernés et retournera les détails d’envoi mis à jour.

Supprimer les colis d’un envoi ouvert

Utilisez ce point de terminaison pour supprimer un ou plusieurs colis dans un envoi ouvert déjà créé avant de confirmer l’expédition.

Vous trouverez ci-dessous les renseignements d’entrée requis pour cette demande :

  • index – Valeur unique attribuée à l’envoi ouvert déjà créé. Si cette valeur n’est pas disponible, veuillez fournir le numéro de suivi principal.
  • accountNumber – Ceci est le numéro de compte FedEx.
  • trackingId – Un ou plusieurs ID suivi de colis d’un envoi ouvert pour lequel ou lesquels la demande de suppression a été reçue.

Une demande réussie supprimera les colis concernés et retournera le statut vrai pour l’élément deletedPackagesFromOpenshipment dans le résultat.

Remarque : Si le colis principal est supprimé de l’envoi, le prochain colis de la séquence devient le colis principal, le numéro de suivi principal lui est réattribué et la séquence des numéros est réduite en fonction du nombre de colis supprimés.

Récupérer un colis dans un envoi ouvert

Utilisez ce point de terminaison pour récupérer un ou plusieurs colis dans un envoi ouvert déjà créé à des fins de consultation ou de vérification.

Vous trouverez ci-dessous les renseignements d’entrée requis pour cette demande :

  • index – Valeur unique attribuée à l’envoi ouvert déjà créé. Si cette valeur n’est pas disponible, veuillez fournir le numéro de suivi principal.
  • accountNumber – Ceci est le numéro de compte FedEx.
  • trackingId – Un ou plusieurs ID suivi de colis d’un envoi ouvert pour lequel ou lesquels les détails doivent être récupérés.

Une demande réussie récupérera les colis concernés.

Modifier un envoi ouvert

Utilisez ce point de terminaison pour modifier un envoi ouvert en fonction des renseignements d’expédition requis avant de confirmer l’envoi.

Vous trouverez ci-dessous les renseignements d’entrée requis pour cette demande :

  • index – Valeur unique attribuée à l’envoi ouvert déjà créé. Si cette valeur n’est pas disponible, veuillez fournir le numéro de suivi principal.
  • accountNumber – Ceci est le numéro de compte FedEx.
  • requestedShipment – Les détails d’expédition pour lesquels un colis ouvert est modifié.

Une demande réussie mettra à jour les détails d’expédition dans l’envoi ouvert déjà créé et retournera le numéro de suivi du ou des colis modifiés ainsi que les détails de la transaction d’expédition modifiés comme résultat.

Récupérer un envoi ouvert

Utilisez ce point de terminaison pour récupérer l’envoi ouvert déjà créé pour le consulter ou le vérifier.

Vous trouverez ci-dessous les renseignements d’entrée requis pour cette demande :

  • index – Valeur unique attribuée à l’envoi ouvert déjà créé. Si cette valeur n’est pas disponible, veuillez fournir le numéro de suivi principal.
  • accountNumber – Ceci est le numéro de compte FedEx.

Une demande réussie récupérera les détails de l’envoi ouvert concerné.

Supprimer un envoi ouvert

Utilisez ce point de terminaison pour supprimer la demande d’envoi ouvert avant de confirmer l’envoi.

Vous trouverez ci-dessous les renseignements d’entrée requis pour cette demande :

  • index – Valeur unique attribuée à l’envoi ouvert déjà créé. Si cette valeur n’est pas disponible, veuillez fournir le numéro de suivi principal.
  • accountNumber – Ceci est le numéro de compte FedEx.

Une demande réussie supprimera l’envoi ouvert et tous les colis qui y sont associés puis retournera le statut vrai pour l’élément deletedOpenshipment dans le résultat.

Confirmer un envoi ouvert

Utilisez ce point de terminaison pour valider et télécharger les données d’expédition de l’envoi ouvert dans les systèmes FedEx une fois que tous les colis ont été ajoutés à la demande d’expédition.

Vous trouverez ci-dessous les renseignements d’entrée requis pour cette demande :

  • index – Valeur unique attribuée à l’envoi ouvert déjà créé. Si cette valeur n’est pas disponible, veuillez fournir le numéro de suivi principal.
  • accountNumber – Ceci est le numéro de compte FedEx.
  • labelResponseOptions – Précisez si le code intermédiaire chiffré ou l’URL de l’étiquette doit être retourné comme réponse.
    Remarque : L’élément labelResponseOptions n’est disponible que dans la demande de confirmation d’envoi ouvert et les étiquettes sont générées après la confirmation de l’envoi.

Une réponse de confirmation réussie pour 40 colis ou moins téléchargera les données d’expédition dans les systèmes FedEx et générera des étiquettes de colis ainsi que tous les autres rapports sur les envois.

Une réponse de confirmation réussie pour plus de 40 colis confirme que cette demande a été placée dans la file d’attente et retourne l’ID tâche pour récupérer le résultat plus tard.

Remarque : Au moins un colis doit être inclus dans l’envoi ouvert avant de pouvoir confirmer l’expédition.

Obtenir les résultats d’un envoi ouvert

Utilisez ce point de terminaison pour obtenir les données d’expédition de l’envoi ouvert confirmé. Ce point de terminaison devrait uniquement être utilisé lorsque l’envoi comporte plus de 40 colis et qu’un ID tâche est retourné dans la confirmation de l’envoi ouvert.

Vous trouverez ci-dessous les renseignements d’entrée requis pour cette demande :

  • resultMethodType – Précisez la valeur comme CRÉER.
  • accountNumber – Ceci est le numéro de compte FedEx.
  • jobId – Ceci est l’ID tâche reçu durant la confirmation de l’envoi ouvert.

Une réponse positive pour cette demande retournera les résultats de l’envoi ouvert confirmé comme les étiquettes de colis et tous les autres rapports sur l’envoi pour l’envoi ouvert confirmé. Si les détails de l’erreur sont retournés dans la réponse, vous pouvez modifier ces erreurs à l’aide des points de terminaison Modifier un envoi ouvert ou Modifier les colis d’un envoi ouvert, puis confirmer l’envoi à l’aide du point de terminaison Confirmer un envoi ouvert et finalement, utiliser le point de terminaison Obtenir les résultats d’un envoi ouvert pour récupérer les résultats de l’envoi ouvert confirmé pour la demande réussie.

Envoi ouvert multipièces

Un envoi ouvert multipièces se compose d’au moins deux colis expédiés à une même adresse de destination. Le premier colis de la demande d’envoi est considéré comme le colis principal.

Pour créer un envoi multipièce :

  • Fournissez les renseignements concernant l’envoi tels que le type de service, le type d’emballage, le poids total, le nombre total de colis et les détails demandés de l’élément LineItems du colis au sujet du colis principal.
    Remarque : La valeur du numéro de séquence du colis principal doit être égale à 1.
  • Ajoutez tous les colis à l’envoi.
  • Confirmez l’envoi.

Une fois l’envoi confirmé, l’une des options de traitement ci-dessous est utilisée :

Traitement d’envoi synchrone

Le traitement synchrone, qui est l’une des méthodes les plus efficaces, est utilisé en interne lorsqu’un envoi comprend 40 colis ou moins (nombre total de colis/groupPackagecount<=40), avec des marchandises en quantité limitée dans l’envoi.

Une demande d’envoi comptant 40 colis ou moins, une fois confirmée, est traitée de manière synchrone et les étiquettes, les documents ou rapports d’envoi sont générés instantanément. Ce processus est optimal pour les expéditeurs qui disposent de peu de temps et veulent imprimer les étiquettes immédiatement après la confirmation de l’envoi.

Remarque : La limite de 40 colis est donnée à titre indicatif et n’est pas une limite fixe. Elle dépend également de la combinaison entre le nombre de colis et les marchandises incluses dans l’envoi. Pour de plus amples renseignements, veuillez communiquer avec votre équipe de soutien de FedEx.

Exemple : votre demande d’envoi ouvert comporte 10 colis. Après confirmation de l’envoi suite à l’ajout des 10 colis, l’envoi sera traité de manière synchrone. Dans la réponse, 10 étiquettes seront créées et les URL d’étiquettes ou les étiquettes encodées seront fournies, selon la demande.

Le flux de travail général suivant illustre le traitement synchrone d’un envoi ouvert :

  1. Utilisez le point de terminaison Créer un envoi ouvert.
  2. Ajoutez de 1 à 40 colis en utilisant le point de terminaison Ajouter des colis à un envoi ouvert.
  3. Utilisez le point de terminaison Confirmer l’envoi ouvert pour valider ce dernier.
  4. Une demande réussie doit générer des étiquettes et la réponse de sortie indiquera les URL d’étiquettes ou les étiquettes encodées demandées.
  5. Si l’envoi comporte des erreurs, celles-ci seront détaillées dans la réponse.
  6. Une fois toutes les erreurs corrigées, utilisez le point de terminaison Confirmer l’envoi ouvert pour obtenir une réponse positive.

Remarque :

  • Avec cette méthode, si vous devez ajouter davantage de colis à un envoi existant, la limite est de 40 colis supplémentaires. 

Traitement d’envoi asynchrone

L’API traite en interne les envois de manière asynchrone lorsque le nombre total de colis dépasse 40 (c’est-à-dire totalPackageCount>40). C’est la méthode la plus pratique lorsque le nombre de colis est élevé et que vous voulez soumettre régulièrement des envois groupés. Cette soumission d’envois groupés utilise diverses ressources et opérations FedEx coûteuses lorsqu’elle est faite en une fois. Avec cette option de traitement, FedEx veille, en interne, à ce que ces envois groupés soient traités facilement, et vous pouvez également obtenir régulièrement les données des étiquettes.

Lorsque l’envoi est traité de manière asynchrone, la réponse confirme seulement que cette demande a été placée dans la file d’attente, mais il est possible que l’envoi ne soit pas traité et que l’Id tâche vous soit retourné pour récupérer ultérieurement le résultat.

Remarque : Avec ce processus, le traitement de l’envoi prend du temps avant que vous récupériez le résultat.

Pour récupérer les résultats des envois asynchrones, utilisez le point de terminaison Obtenir les résultats des envois ouverts et fournissez l’Id tâche et le numéro de compte dans la demande. La réponse à cette demande retournera les données de résultat avec les détails sur l’étiquette ou les détails sur les erreurs d’envoi.

Exemple : Votre envoi comprenant 45 colis seront traités de manière asynchrone une fois confirmée. La réponse comprendra un Id tâche. Vous devez ensuite utiliser le point de terminaison Obtenir les résultats des envois ouverts pour récupérer les résultats des envois et les données des étiquettes.

Le flux de travail général suivant illustre le traitement asynchrone d’un envoi :

  1. Utilisez le point de terminaison Créer un envoi ouvert.
  2. Ajoutez 40 colis ou plus en utilisant le point de terminaison Ajouter des colis à un envoi ouvert.
  3. Utilisez le point de terminaison Confirmer l’envoi ouvert pour valider ce dernier.
  4. La soumission réussie fournira un Id tâche.
  5. Utilisez l’Id tâche et le numéro de compte pour récupérer les résultats de sortie à l’aide du point de terminaison Obtenir les résultats des envois ouverts.
  6. La sortie correcte indiquera les données du résultat de l’envoi avec les détails de l’étiquette.
  7. Si le résultat comporte des erreurs, celles-ci seront détaillées dans la réponse.

Note :

  • Avec cette méthode, le maximum de colis autorisé dans une demande unique est de 300, ou jusqu’à 999 marchandises. 
  • Avec cette méthode également, une fois que la demande est soumise, vous ne pouvez plus ajouter, modifier ou supprimer des colis dans la demande originale. Si la réponse comporte des erreurs, vous pouvez les corriger en utilisant le point de terminaison Modifier des colis dans un envoi ouvert, confirmer l’envoi en utilisant Confirmer l’envoi ouvert, puis obtenir les résultats de la sortie en utilisant le point de terminaison Obtenir les résultats d’un envoi ouvert.

Étiquettes d’expédition FedEx

L’API FedEx prend en charge une grande variété d’étiquettes. L’API FedEx prend en charge trois types d’étiquettes, y compris thermosensible, papier ordinaire et personnalisable. Vous pouvez utiliser les points de terminaison de l’API d’envois ouverts pour produire une grande variété d’étiquettes.

FedEx offre deux formats d’étiquette pour les services d’expédition :

  • Étiquettes thermosensibles
  • Étiquettes laser

Étiquettes thermosensibles

L’API FedEx vous permet d’imprimer des étiquettes d’expédition pour tous les types d’envois, tels que FedEx ExpressMD, FedEx GroundMD et FedEx International GroundMD sur des imprimantes thermiques.

L’API FedEx prend en charge les formats d’étiquettes thermosensibles suivants :

  • 10,2 cm x 15,2 cm (4 po x 6 po) – sans onglet Doc configurable
  • 10,2 cm x 17,2 cm (4 po x 6,75 po) – avec ou sans onglet Doc
  • 10,2 cm x 20,3 cm (4 po x 8 po) – avec espace pour fichier graphique ou texte de votre choix
  • 10,16 cm x 21,59 cm (4 po x 8,5 po) – avec un onglet Doc configurable (spécifiquement inclus pour l’étiquette d’identification de pneus)
  • 10,2 cm x 22,9 cm (4 po x 9 po) – avec espace pour des graphiques ou du texte ainsi qu’un onglet Doc
  • 10,16 cm x 26,67 cm (4 po x 10,5 po) – avec un onglet Doc configurable (spécifiquement inclus pour l’étiquette d’identification de pneus)

Les types de stocks d’étiquettes de 10,16 x 21,59 cm et de 10,16 x 26,67 cm incluent un onglet Doc ajouté avec codes-barres identiques. Un code-barres est affiché sur l’étiquette principale et l’autre sur l’onglet Doc. Cette valeur de types de stocks d’étiquettes est utile pour les colis de pneus, car une étiquette peut être apposée sur la bande de roulement du pneu et l’étiquette additionnelle avec onglet Doc, copie dupliquée du code-barres et instructions pour l’utilisation, sur le flanc du pneu. L’utilisation de ces types de stocks d’étiquettes réduit le réétiquetage des pneus, et les balayages dimensionnels accrus optimisent la récupération. Pour de plus amples renseignements sur ce stock d’étiquettes, consultez Types de stocks d’étiquettes.

Remarque : L’onglet Doc est un onglet adhésif amovible comportant des renseignements supplémentaires que vous pouvez sélectionner pour un stock d’étiquettes d’expédition lorsque vous imprimez celles-ci sur une imprimante thermique.

Éléments des étiquettes thermosensibles

Les étiquettes d’expédition thermosensibles présentent trois éléments de base :

  • Contenu lisible par l’utilisateur : cette partie de l’étiquette comporte les renseignements sur l’envoi.
  • Le code-barres FedEx Ground lisible par l’utilisateur est crypté par défaut.
  • Code-barres bidimensionnel (2D) : le code-barres alphanumérique dimensionnel stocke les données des envois FedEx Express et FedEx Ground selon la norme MH10.8.3 de l’American National Standards Institute (ANSI). Le code-barres 2D est créé à l’aide de la symbologie Portable Data File (PDF) 417.
  • Code-barres spécifique à FedEx :
    • ASTRA (Advanced Sorting Tracking Routing Assistance) pour les envois FedEx Express jusqu’à l’adoption complète du code-barres FDX 1D; code-barres « 96 » pour les envois FedEx Ground et FedEx Home Delivery. FedEx Ground permet aussi l’utilisation du code-barres SSCC-18 « 00 ».
    • Le code-barres FedEx 1D (FDX1D) pour les envois FedEx Express est créé à l’aide de ANSI/AIM BC4-1995 (Uniform Symbology Specification CODE-128C).

Renseignements clés nécessaires pour générer une étiquette thermosensible

Les renseignements clés nécessaires à la génération d’une étiquette thermosensible sont les suivants :

  • Type de format d’étiquette : nécessaire pour recevoir l’image correcte de l’étiquette dans l’API de réponse à la demande d’envoi ouvert :
    • COMMON2D : Type de format d’étiquette pour recevoir une étiquette.
    • LABEL_DATA_ONLY : Valeur utilisée pour recevoir les données du code-barres si vous créez une étiquette personnalisée.
  • Valeurs valides :

  • Type d’image : Nécessaire pour formater l’étiquette thermosensible en fonction de l’imprimante utilisée; indique le type de flux de données ou table de bits à retourner.

    • EPL2 – Eltron (types de stocks d’étiquettes)
    • ZPLII – Zebra (types de stocks d’étiquettes)
  • Valeurs valides :

    Remarque : Toutes les étiquettes nécessaires pour un envoi sont générées et retournées dans un seul tampon.

Imprimantes thermiques prises en charge

Les imprimantes thermiques recommandées pour l’API FedEx sont les suivantes :

  • Unimark
  • Eltron
    • Orion (EPL2)
    • Eclipse (EPL2)
  • Zebra
    • LP2443 (EPL2)
    • LP2844 (EPL2)
    • Gk420 (ZPL)
    • LP2348 Plus (EPL2/ZPL)
    • Z4M Plus (ZPL ou EPL)
    • ZP500/ZP505 (EPL2/ZPL)
    • Z4M/Z4M+ (EPL2/ZPL)
    • ZM400 (EPL2/ZPL)
    • ZT410 (EPL2/ZPL)
    • Autres imprimantes de la série ZT4xx (EPL2/ZPL)

Remarque : Ces imprimantes sont toutes compatibles avec le mode de page ASCII Eltron Programming Language (EPL2). L’imprimante thermique est prise en charge de deux manières : comme imprimante raccordée à un port série du système pour écriture directe et comme imprimante native Windows installée pour les connexions LPT, série ou USB. Les versions micrologicielles des imprimantes fournies par FedEx peuvent varier selon la région.

Nombre d’étiquettes thermosensibles imprimées par service

Le tableau suivant indique le nombre d’étiquettes de chaque type nécessaires pour un service spécial particulier. Toutes les étiquettes nécessaires sont générées par un appel au serveur d’étiquettes commun (CLS) de FedEx, et le CSL les retourne dans un tampon, à l’exception des étiquettes de retour CR.

Nombre d’étiquettes thermosensibles imprimées par service aux États-Unis

Type de service

Étiquettes thermosensibles (le CLS FedEx retourne le nombre correct d’étiquettes dans la réponse)

FedEx Express aux É.-U.

1 étiquette d’expédition

FedEx Ground aux É.-U. / FedEx Home Delivery

1 étiquette d’expédition

Nombre d’étiquettes thermosensibles imprimées par service international d’exportation aux États-Unis

Type de service

Étiquettes thermosensibles (le CLS FedEx retourne le nombre correct d’étiquettes dans la réponse)

FedEx Express International pour exportation des É.-U.

1 étiquette d’expédition

2 étiquettes de destinataire

FedEx Express International pour exportation des É.-U. avec option Sélection du courtier

1 étiquette d’expédition

2 étiquettes de destinataire

FedEx Ground International pour exportation des É.-U.

1 étiquette d’expédition

FedEx Ground International pour exportation des É.-U. CR

1 étiquette d’expédition

2 étiquettes de retour CR

Nombre d’étiquettes thermosensibles imprimées par service à l’intérieur du Canada

Type de service

Étiquettes thermosensibles (le CLS FedEx retourne le nombre correct d’étiquettes dans la réponse)

FedEx Express à l’intérieur du Canada

Envoi de marchandises non dangereuses ou de glace sèche :

1 étiquette d’expédition

FedEx Ground à l’intérieur du Canada

1 étiquette d’expédition

FedEx Ground à l’intérieur du Canada CR

1 étiquette d’expédition

2 étiquettes de retour CR

Nombre d’étiquettes thermosensibles imprimées par service international d’exportation au Canada

Type de service

Étiquettes thermosensibles (le CLS FedEx retourne le nombre correct d’étiquettes dans la réponse)

FedEx Express International pour exportation du Canada

Envoi de marchandises non dangereuses ou de glace sèche :

1 étiquette d’expédition

2 étiquettes de destinataire

FedEx Express International pour exportation du Canada avec Sélection du courtier

Envoi de marchandises non dangereuses ou de glace sèche :

1 étiquette d’expédition

2 étiquettes de destinataire

FedEx Ground Canada (CA) International pour exportation

1 étiquette d’expédition

Nombre d’étiquettes thermosensibles imprimées par envoi entrant aux Philippines et en Thaïlande

Type de service

Étiquettes thermosensibles (le CLS FedEx retourne le nombre correct d’étiquettes dans la réponse)

Envois entrants aux Philippines

2 étiquettes d’expédition avec numéro de compte imprimé

1 étiquette de destinataire avec numéro de compte imprimé

3 copies de la facture commerciale

Envois de marchandises entrants en Thaïlande

3 étiquettes d’expédition avec numéro de compte imprimé

1 étiquette de destinataire avec numéro de compte imprimé

Envois de documents entrants en Thaïlande

2 étiquettes d’expédition avec numéro de compte imprimé

1 étiquette de destinataire avec numéro de compte imprimé

Onglet Doc

Si vous imprimez des étiquettes d’expédition sur une imprimante thermique, vous pouvez choisir le stock d’étiquettes comportant un onglet Doc, l’onglet adhésif amovible avec des renseignements supplémentaires sur l’envoi. Vous pouvez configurer ces renseignements à partir de vos données d’expédition ou choisir d’imprimer des données configurables spécifiques à vos besoins.

Étiquettes laser

L’API FedEx prend en charge l’impression des étiquettes sur une imprimante laser. Ces étiquettes sont généralement imprimées sur du papier au format Lettre É.-U. ou A4, puis pliées en deux pour entrer dans la pochette d’expédition FedEx standard. Les étiquettes imprimées sur une imprimante laser sont générées en format PDF et n’ont pas besoin d’être redimensionnées. Pour de plus amples renseignements sur ce stock d’étiquettes, consultez Types de stocks d’étiquettes.

Conditions préalables

Les étiquettes PDF doivent respecter les exigences suivantes :

  • Adobe Reader version 6.0 ou supérieure nécessaire pour le traitement des étiquettes.
  • Paramètre de mise à l’échelle réglé sur zéro dans le pilote d’imprimante.
  • Il n’est pas nécessaire d’utiliser un HTML wrapper pour afficher une étiquette PDF sur papier ordinaire dans un navigateur.
  • Pour l’affichage des documents PDF, Acrobat recommande les navigateurs suivants :
    • Microsoft Internet Explorer 10 ou version supérieure
    • Firefox 1.0 ou version supérieure
    • Mozilla 1.7 ou version supérieure

L’option d’étiquette PDF élimine la nécessité de spécifier le paramètre d’orientation de l’image (largeur et hauteur) ou la résolution d’écran pour que l’étiquette s’affiche correctement dans le navigateur.

Éléments des étiquettes laser

Les étiquettes d’expédition laser présentent trois éléments de base :

  • Contenu lisible par l’utilisateur – cette partie de l’étiquette comporte les renseignements sur l’envoi provenant de l’API d’expédition FedEx.
  • Le code-barres FedEx Ground lisible par l’utilisateur est crypté par défaut.
  • Code-barres bidimensionnel (2D) – le code-barres alphanumérique dimensionnel stocke les données des envois FedEx Express et FedEx Ground selon la norme MH10.8.3 de l’American National Standards Institute (ANSI).– Le code-barres 2D est créé à l’aide du format Portable Data File (PDF) 417.
  • Code-barres spécifique à FedEx :
    • ASTRA (Advanced Sorting Tracking Routing Assistance) pour les envois FedEx Express jusqu’à l’adoption complète du code-barres FDX 1D; code-barres « 96 » pour les envois FedEx Ground et FedEx Home Delivery. FedEx Ground permet aussi l’utilisation du code-barres SSCC-18 « 00 », le cas échéant.
    • Le code-barres FedEx 1D (FDX1D) pour les envois FedEx Express est créé à l’aide de ANSI/AIM BC4-1995 (Uniform Symbology Specification CODE-128C).

Renseignements clés nécessaires pour générer une étiquette laser

Les éléments de l’API FedEx nécessaires à la génération d’une étiquette laser sont les suivants :

  • Spécification de l’étiquette/Type de format d’étiquette : Nécessaire pour recevoir l’image correcte de l’étiquette dans l’API de réponse à la demande d’envoi ouvert : les valeurs valides sont :
    • COMMON2D – type de format d’étiquette pour recevoir une étiquette.
    • LABEL_DATA_ONLY – valeur utilisée pour recevoir les données du code-barres si vous créez une étiquette personnalisée.
  • Spécification de l’étiquette/Type d’image : Nécessaire pour indiquer le formatage de l’étiquette. Type de flux de données et de table de bits à retourner :

    Les valeurs valides sont :

    • PDF – papier ordinaire
    • PNG – papier ordinaire
  • Spécification de l’étiquette/Type de stock d’étiquettes : Nécessaire pour tous les types d’étiquettes. Indiquez si le stock d’étiquettes a un onglet Doc au début ou à la fin des étiquettes ou non. Lorsque vous utilisez un type d’image PDF ou PNG, ces valeurs affichent une étiquette de format laser :
    • PAPER_4X6
    • PAPER_4X8
    • PAPER_4X9
    • PAPER_4X675
      Ces valeurs affichent une étiquette d’expédition au format papier ordinaire :
    • PAPER_7X47
    • PAPER_85X11_BOTTOM_HALF_LABEL
    • PAPER_85X11_TOP_HALF_LABEL
    • PAPER_LETTER

Remarque : Si vous demandez une étiquette sur papier ordinaire, les données retournées présentent l’étiquette sous forme d’image encodée en Base64; vous devrez la décoder par Base64 avant de pouvoir afficher le fichier étiquette.

Imprimantes laser prises en charge

La plupart des imprimantes laser sont prises en charge pour ce type d’étiquette; toutefois, les étiquettes ne seront pas acceptées si elles sont imprimées sur une imprimante à jet d’encre.
Remarque : Si vous utilisez une imprimante laser couleur, la définition de la couleur doit être réglée sur noir, même si l’imprimante est équipée seulement d’une cartouche noire.

Nombre d’étiquettes laser exigées par service

Le tableau suivant indique le nombre d’étiquettes de chaque type nécessaires pour un service spécial particulier. Toutes les étiquettes nécessaires sont générées par un appel au serveur d’étiquettes commun (CLS) de FedEx, et le CSL les retourne dans un tampon, à l’exception des étiquettes de retour CR.

Nombre d’étiquettes laser imprimées par service aux États-Unis

Type de service

Étiquette laser – Format PDF

FedEx Ground / FedEx Home Delivery É.-U.

1 étiquette d’expédition

Nombre d’étiquettes laser imprimées par service international d’exportation aux États-Unis

Type de service

Étiquette laser – Format PDF

FedEx Express International pour exportation des É.-U.

1 étiquette d’expédition dans la réponse; au moins 3 étiquettes doivent être imprimées – 1 étiquette sur le colis et 2 dans la pochette pour documents.

FedEx Express International pour exportation des É.-U. avec Sélection du courtier

1 étiquette d’expédition dans la réponse; au moins 3 étiquettes doivent être imprimées – 1 étiquette sur le colis et 2 dans la pochette pour documents.

FedEx Ground International pour exportation des É.-U.

1 étiquette d’expédition

FedEx Ground International pour exportation des É.-U. CR

1 étiquette d’expédition

2 étiquettes de retour CR

Nombre d’étiquettes laser imprimées par service à l’intérieur du Mexique

Type de service

Étiquette laser – Format PDF

FedEx Express à l’intérieur du Mexique

FedEx Express à l’intérieur du Mexique

Envoi de marchandises non dangereuses ou de glace sèche :

1 étiquette d’expédition

Nombre d’étiquettes laser imprimées par service à l’intérieur du Canada

Type de service

Étiquette laser – Format PDF

FedEx Express à l’intérieur du Canada

FedEx Express à l’intérieur du Canada

Envoi de marchandises non dangereuses ou de glace sèche :

1 étiquette d’expédition

FedEx Ground à l’intérieur du Canada

1 étiquette d’expédition

FedEx Ground à l’intérieur du Canada CR

1 étiquette d’expédition

2 étiquettes de retour CR

Nombre d’étiquettes laser imprimées par service international d’exportation au Canada

Type de service

Étiquette laser – Format PDF

FedEx Express International pour exportation du Canada

FedEx Express International pour exportation du Canada

Envoi de marchandises non dangereuses ou de glace sèche :

1 étiquette d’expédition

2 étiquettes de destinataire

FedEx Express International pour exportation du Canada avec Sélection du courtier

FedEx Express International pour exportation du Canada avec Sélection du courtier

Envoi de marchandises non dangereuses ou de glace sèche :

1 étiquette d’expédition

2 étiquettes de destinataire

FedEx Ground Canada (CA) International pour exportation

1 étiquette d’expédition

Nombre d’étiquettes laser imprimées par service international d’exportation au Canada

Type de service

Étiquette laser – Format PDF

FedEx Express International pour exportation du Canada

FedEx Express International pour exportation du Canada

Envoi de marchandises non dangereuses ou de glace sèche :

1 étiquette d’expédition

2 étiquettes de destinataire

FedEx Express International pour exportation du Canada avec Sélection du courtier

FedEx Express International pour exportation du Canada avec Sélection du courtier

Envoi de marchandises non dangereuses ou de glace sèche :

1 étiquette d’expédition

2 étiquettes de destinataire

FedEx Ground Canada (CA) International pour exportation

1 étiquette d’expédition

Nombre d’étiquettes laser imprimées par envoi entrant aux Philippines et en Thaïlande

Type de service

Étiquettes thermosensibles (le CLS FedEx retourne le nombre correct d’étiquettes dans la réponse)

Envois entrants aux Philippines

2 étiquettes d’expédition avec numéro de compte imprimé

1 étiquette de destinataire avec numéro de compte imprimé

3 copies de la facture commerciale

Envois de marchandises entrants en Thaïlande

3 étiquettes d’expédition avec numéro de compte imprimé

1 étiquette de destinataire avec numéro de compte imprimé

Envois de documents entrants en Thaïlande

2 étiquettes d’expédition avec numéro de compte imprimé

1 étiquette de destinataire avec numéro de compte imprimé

Étiquette personnalisée

FedEx autorise la personnalisation des étiquettes générées par FedEx. Vous pouvez ajouter du texte relatif à votre entreprise et choisir le type de code-barres (symbologie) à utiliser sur les documents et les étiquettes FedEx dans la portion personnalisable des étiquettes thermosensibles.

Pour prendre en charge votre application d’expédition, l’API d’envoi ouvert FedEx offre deux options de personnalisation de votre étiquette :

  • Placez le graphique sur PAPIER PNG 17,8 cm (7 po) x 1 206,5 cm (4,75 po) sur votre stock d’étiquettes. Vous pouvez par exemple créer un bordereau d’expédition sur un formulaire de 21,6 cm x 27,9 cm (8,5 po x 11 po). Dans ce formulaire, vous pouvez aussi placer le graphique sur PAPIER PNG 17,8 cm (7 po) x 1 206,5 cm (4,75 po) au lieu de créer vous-même une étiquette personnalisée.
  • Ajoutez un fichier graphique ou texte sur l’étiquette thermosensible de 10,2 cm x 20,3 cm (4 po x 8 po) ou 10,2 cm x 22,9 cm (4 po x 9 po). Sur une étiquette de cette taille, vous disposez d’un espace de 5 cm ou 2 pouces pour votre graphique ou texte.

Remarque : Sur l’étiquette, le contenu lisible par l’utilisateur et le code-barres qui apparaît dans la portion personnalisée ne peuvent pas être modifiés.

Étiquette de validation personnalisée

Vous pouvez créer des étiquettes personnalisées de non-expédition au niveau du colis et au niveau de l’envoi en spécifiant quelle information personnalisée est désirée, comment formater cette information et où la placer sur l’étiquette personnalisée. Seules les étiquettes thermosensibles peuvent être personnalisées.

Personnaliser une étiquette thermosensible

L’API FedEx fournit deux formats d’étiquettes thermosensibles que vous pouvez personnaliser en y ajoutant un fichier graphique ou texte, afin de ne pas devoir créer une étiquette personnalisée. Ces étiquettes sont valides pour tous les services d’expédition FedEx. Ces formats sont :

  • Étiquette thermosensible de 10 cm x 20 cm (4 po x 8 po) sans onglet Doc
  • Étiquette thermosensible de 10 cm x 23 cm (4 po x 9 po) avec onglet Doc

Ces types d’étiquettes présentent une portion personnalisable de 5 cm (2 po). Cette fonction s‘applique à l‘étiquette thermique imprimée sur une imprimante thermique réglée sur 203 DPI ou 300 DPI.

Règles concernant les étiquettes personnalisées

Les règles d’utilisation des formats d’étiquettes sont les suivantes :

  • Seule l’étiquette d’expédition peut être personnalisée. Par exemple, si vous imprimez une étiquette d’expédition Express de 10 cm x 20 cm (4 po x 8 po) avec votre logo, celui-ci n’apparaîtra pas sur les étiquettes secondaires du destinataire.
  • Le graphique ou texte personnalisable ne doit pas dépasser 5 cm (2 po) de hauteur et 10 cm (4,5 po) de largeur.
  • FedEx ne fait aucune correction. Le graphique or le texte est imprimé tel que soumis dans le service d’expédition.
  • Si les données nécessaires pour imprimer le graphique ou le texte ne sont pas toutes fournies (par exemple les coordonnées X et Y), une étiquette d’expédition valide est retournée dans les données personnalisées. Vous devez annuler l’expédition représentée par cette étiquette si vous voulez essayer de recréer une autre étiquette avec le graphique ou le texte.
  • Pour une résolution d‘imprimante de 203 DPI (8 points/mm), concernant l‘emplacement sur les coordonnées X et Y, le point de référence de l‘insertion est l‘intersection des bords supérieur et gauche de l‘étiquette thermique de 10,16 cm x 17,15 cm (4 po x 6,75 po) avec l‘onglet inférieur du document. Pour l’étiquette thermosensible de 10 cm x 17,15 cm (4 po x 6,75 po) avec l’onglet doc dans le haut, augmentez les valeurs Y de coordonnée du point d’insertion par incrément de 164 points. Pour l’étiquette de 10 cm x 15 cm (4 po x 6 po) sans onglet doc, augmentez les valeurs Y de coordonnée du point d’insertion par incrément de 8 points. Les attributs des éléments de l’étiquette thermosensible sont basés sur la résolution d’imprimante de 203 PPP (8 points/mm).
  • Pour une résolution d‘imprimante de 300 DPI (12 points/mm), concernant le placement sur les coordonnées X et Y, le point de référence de l‘insertion est l‘intersection des bords supérieur et gauche de l‘étiquette thermique de 10,16 cm x 17,15 cm (4 po x 6,75 po) avec l‘onglet inférieur du document. Pour l’étiquette thermosensible de 10 cm x 17 cm (4 po x 6,75 po) avec l’onglet doc dans le haut, augmentez les valeurs Y de coordonnée du point d’insertion par incrément de 246 points. Pour l’étiquette de 10 cm x 15 cm (4 po x 6 po) sans onglet doc, augmentez les valeurs Y de coordonnée du point d’insertion par incrément de 12 points. Les attributs des éléments de l’étiquette thermosensible sont basés sur la résolution d’imprimante de 300 PPP (8 points/mm).Remarque :
    • Pour le code-barres FXD1D, la dimension X (largeur de la barre la plus étroite dans le symbole) est de 15 mil (3 points) pour une imprimante de 203 DPI, et de 13,3 mil (4 points) pour une imprimante de 300 DPI.
    • Pour le code-barres 2D PDF-417, la dimension X est de 10 mil (2 points) pour une imprimante de 203 DPI. Pour obtenir l‘équivalent le plus proche de la dimension X pour une imprimante de 300 DPI, il faut utiliser 9,99 mil (3 points).
    • Pour le bloc Expéditeur/Misc situé en haut de l‘étiquette et le bloc Référence de l‘expéditeur sous les informations du destinataire, où des polices très petites sont utilisées, les développeurs d‘étiquettes doivent consulter le guide de programmation ZPL pour croiser les caractéristiques de la police et sélectionner un jeu de polices équivalent performant pour diverses autres résolutions de tête d‘impression.
  • Le point d’insertion des caractères est le coin supérieur gauche du premier caractères de la chaîne, à la hauteur des majuscules.
  • Les restrictions de l’imprimante imposent que l’origine de position soit dans le quadrant supérieur gauche de la face avant. Par conséquent, il est possible que les données commencent dans la portion personnalisable de l’étiquette et débordent dans la portion FedEx de l’étiquette (données de l’étiquette thermosensible). Dans ce cas, votre logo ou texte s’imprimera par-dessus l’information de l’étiquette FedEx. Vous devez corriger ce positionnement pour pouvoir utiliser l’étiquette d’expédition.
  • L’ajout de l’information de l’onglet Doc sur l’étiquette de 10 cm x 23 cm (4 po x 9 po) doit être configuré de la même façon que pour une étiquette thermosensible standard de 10 cm x 15 cm (4 po x 6 po) avec onglet Doc.

Remarque : Seules les images couleur à bit unique doivent être ajoutées, car les étiquettes s’imprimeront en noir et blanc.

Personnaliser les éléments d’entrées du graphique d’étiquette

L’API fournit des images PNG (Portable Network Graphic) pour les étiquettes FedEx Express et FedEx Ground. Le graphique d’étiquette PNG est une réplique des étiquettes thermosensibles ou sur papier ordinaire prises en charge par l’API. L’option d’étiquette vous permet de placer le graphique PNG sur votre stock d’étiquettes pour vous éviter de devoir créer une étiquette personnalisée.

L’intégration d’un fichier graphique PNG de 10 cm x 15 cm (4 po x 6 po) dans un document d’expédition doit respecter les exigences suivantes :

  • Stock d’étiquette
  • Imprimante
  • Mise à l’échelle

Stock d’étiquette

Les étiquettes PNG 10 cm x 15 cm (4 po x 6 po) doivent être utilisées uniquement avec le matériel autocollant. Les équipes de certification des étiquettes de FedEx Ground et FedEx Express rejetteront les étiquettes PNG 10 cm x 15 cm (4 x 6 po) qui ne seront pas imprimées sur du matériel autocollant, y compris les étiquettes imprimées sur du papier ordinaire.

Imprimante

Il est recommandé d’imprimer les étiquettes sur des imprimantes laser. Les imprimantes à jet d’encre ne doivent pas être utilisées, car la qualité des codes-barres à numériser qu’elles produisent est inconstante. L’étiquette PNG de 10 po x 15 cm (4 po x 6 po) ne peut être imprimée sur une imprimante couleur que si la définition de la couleur est réglée sur noir, même si l’imprimante est équipée seulement d’une cartouche noire. Ce réglage est nécessaire pour obtenir la définition correcte pour le code-barres aux fins de balayage dans les centres de tri FedEx.

Mise à l’échelle

L’image retournée dans la transaction d’expédition est 200 points par pouce (PPP) et mesure 10 cm (4 po) (L) x 15 cm (6 po) (H) ou 800 x 1200 pixels. Cette étiquette a une orientation verticale et est conçue pour s’imprimer dans une section de 10 cm x 15 cm (4 po x 6 po). Une fois imprimée, l’étiquette doit mesurer 10 cm x 15 cm (4 po x 6 po).

Pour produire l’étiquette et les codes-barres dans le réglage PPP requis, vous devez mettre à l’échelle (ou redimensionner) l’image avant l’impression. La méthode de mise à l’échelle de l’image dépend de l’application utilisée pour visualiser et imprimer l’étiquette. Pour mettre à l’échelle l’image PNG pour une étiquette de 10 cm x 15 cm (4 po x 6 po), utilisez exactement la largeur de 10 cm (4 po) et la longueur de 15 cm (6 po).

Liste de contrôle pour la vérification des étiquettes

Tous les codes-barres

Exigences aux fins de validation :

  • Zone de silence : Doit avoir au moins 2,54 mm (0,1 po) d’espace blanc au-dessus et au-dessous du code-barres.
  • Zone de silence : Doit avoir au moins 5,08 mm (0,2 po) d’espace blanc à gauche et à droite du code-barres.
  • Validez que tous les codes-barres sont conformes aux exigences de hauteur minimale.

Qualité de l’impression

Problèmes courants entraînant le rejet d’étiquettes :

  • Barres de fractionnement
  • Impression pâle/espaces blancs
  • Espaces blancs répétés (problème de rouleau)
  • Bavures (transfert thermique)
  • Écaillage (laser) indiquant un problème de fusion de l’encre en poudre
  • Plissures dans l’impression (transfert thermique)
  • Le contraste d’impression doit être au moins 90 % pour les étiquettes thermosensibles directes

Détails lisibles par l’utilisateur pour les étiquettes Ground

Pour que les étiquettes FedEx Ground lisibles par l’utilisateur soient validées, elles doivent respecter les exigences suivantes :

  • Les données correspondent au code-barres
  • Logo FedEx Ground : Les logos peuvent être téléchargés depuis le site Web d’identité FedEx fedex.com.
  • Logo de FedEx Home Delivery : Les étiquettes doivent avoir un grand « H » dans un cadre à moins de 2,54 cm (1 po) de l’adresse de destination. Le « H » doit mesurer au moins 6 mm (0,25 po) x 18 mm (0,7 po).
  • Description du service
  • Renseignements sur l'expéditeur
  • Renseignements sur le destinataire
  • Code postal et acheminement
  • Date d'expédition
  • Poids réel
  • Renseignements sur les dispositifs d’automatisation en clientèle (système, application/système, version)
  • Dimensions
  • Divers renseignements de référence
  • Numéro de suivi et ID de formulaire (le numéro de suivi doit comporter 14 chiffres)
  • ID de piste d’aéroport
  • Code postal

Détails lisibles par l’utilisateur pour les étiquettes Express

Les éléments suivants doivent être imprimés sur l’étiquette aux fins de certification :

  • Logo FedEx Express : Les logos peuvent être téléchargés depuis le site Web d’identité FedEx fedex.com.
  • Description du service
  • Type d’emballage, si envoi international
  • Jour de la semaine de livraison (exemple : LUN pour lundi)
  • Date de livraison au plus tard
  • Numéro de système
  • Date d'expédition
  • Format du compte de pièces, notice de l’étiquette principale, notice de l’étiquette CRN sur tous les envois multipièces
  • ID de piste d’aéroport
  • Code postal et acheminement
  • Préfixe et suffixe d’acheminement URSA
  • Codes de manutention
  • Zone de service engagée
  • Numéros de téléphone de l’expéditeur et du destinataire
  • Poids
  • Dim, le cas échéant
  • Champ de référence si l’envoi contient de l’alcool
  • Numéro de suivi et ID de formulaire (le numéro de suivi doit comporter 14 chiffres)
  • Sur l’étiquette ASTRA, le numéro de suivi de 12 chiffres occupe les positions 17 à 28 inclus dans le code-barres de 32 caractères. Dans le nouveau code-barres FDX 1D, le numéro de suivi occupe les positions 21 à 34. Le numéro de suivi FedEx Express restera à 12 chiffres. Il sera précédé de deux zéros.

Règles opérationnelles

Les règles suivantes s’appliquent à l’API d’envois ouverts :

  • L’envoi ouvert peut également être créé et confirmé avec un seul colis.
  • Les envois ouverts seront purgés s’ils ne sont pas confirmés d’ici la fin du cinquième jour de la création de l’envoi.
  • Une fois l’envoi confirmé, aucun autre colis ne peut être ajouté à l’envoi ouvert.

Open Ship API (1.0)

Create Open Shipment

This endpoint helps you to create an openn shipment request with the required shipping information.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL
header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-createOpenShipment
  • MinimumSamplePayload-CreateOpenshipment
  • MinimumSamplePayload-CreateOpenshipmentAsynchronous
requestedShipment
required
object (OpenshipmentRequestedShipment)

The detailed transaction data for the requested Open Shipment.

accountNumber
required
object (AccountNumber)

The account number associated with the shipment.
Example: Your account number

openShipmentAction
string (OpenShipAction)
Enum: "STRONG_VALIDATION" "WEAK_VALIDATION" "CREATE_PACKAGE"

Indicates the optional actions that can be performed during the modification of packages in Open Shipment.

Here are the values:

  • CREATE_PACKAGE - Use CREATE_PACKAGE option to create Open Shipment.
  • STRONG_VALIDATION – Full shipment edits: any edit that fails will cause the transaction to fail. If the transaction is successful, a tracking number may be returned and the transaction will be saved to the database (committed).
  • WEAK_VALIDATION - Full shipment edits: any edit that fails will return errors but the transaction does not fail. The tracking number is returned and the transaction is saved in the database if the core edits are passed. Fix errors with the ModifyRequests transaction using the Index and returned tracking number.

index
string

This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number.
Note: If index is not provided while create open shipment then the master tracking id of create open ship will act as index for the shipment.
Example: Test1234

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/create

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/create

Production Server

https://apis.fedex.com/ship/v1/openshipments/create

Request samples - Create Open Shipment

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "requestedShipment":
    {
    },
  • "accountNumber":
    {
    },
  • "openShipmentAction": "CREATE_PACKAGE",
  • "index": "Test1234"
}

Response samples - Create Open Shipment

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "624dxxx6-b709-470c-8c39-4b55xxxxx492",
  • "customerTransactionId": "order123xxxx89",
  • "output":
    {
    }
}

Modify Open Shipment

This endpoint helps you to modify an Open shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL
header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-modifyOpenShipment
  • MinimumSamplePayload-modifyOpenShipment
index
required
string

This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number.
Example: Test1234

requestedShipment
required
object (OpenshipmentRequestedShipment)

The detailed transaction data for the requested Open Shipment.

openShipmentAction
string (OpenShipAction)
Enum: "STRONG_VALIDATION" "WEAK_VALIDATION" "CREATE_PACKAGE"

Indicates the optional actions that can be performed during the modification of packages in Open Shipment.

Here are the values:

  • CREATE_PACKAGE - Use CREATE_PACKAGE option to create Open Shipment.
  • STRONG_VALIDATION – Full shipment edits: any edit that fails will cause the transaction to fail. If the transaction is successful, a tracking number may be returned and the transaction will be saved to the database (committed).
  • WEAK_VALIDATION - Full shipment edits: any edit that fails will return errors but the transaction does not fail. The tracking number is returned and the transaction is saved in the database if the core edits are passed. Fix errors with the ModifyRequests transaction using the Index and returned tracking number.

accountNumber
required
object (AccountNumber)

The account number associated with the shipment.
Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/

Production Server

https://apis.fedex.com/ship/v1/openshipments/

Request samples - Modify Open Shipment

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "index": "Test1234",
  • "requestedShipment":
    {
    },
  • "openShipmentAction": "CREATE_PACKAGE",
  • "accountNumber":
    {
    }
}

Response samples - Modify Open Shipment

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "string",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

Confirm Open Shipment

Use this endpoint to validate and upload the Open Ship shipment data to FedEx Systems once all packages are added in the Shipment request.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL
header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-confirmOpenShipment
  • MinimumSamplePayload-confirmOpenShipment
labelResponseOptions
required
string (LABELRESPONSEOPTIONS)
Enum: "URL_ONLY" "LABEL"

Specify whether the encoded bytecode or the label URL to be returned in the response.

Valid values:

  • LABEL – Indicates request is for encoded bytecode.
  • URL_ONLY – Indicates label URL request.
Note: For asynchronous shipment (More than 40 packages) request only the value LABEL is suported.



Note: With URL_ONLY option, the URL once created will be active for 12 hours.

edtRequestType
string
Enum: "ALL" "NONE"

Indicate whether to have estimated duties and taxes provided with the rate quotes on this shipment. Only applies for International Shipment.

labelSpecification
required
object (LabelSpecification)

These are label specification details includes the image type, printer format, and label stock for label. Can also specify specific details such as doc-tab content, regulatory labels, and masking data on the label.

index
required
string

This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number.
Example: Test1234

shippingDocumentSpecification
object (ShippingDocumentSpecification)

Use this object to provide all data required for additional (non-label) shipping documents to be produced.

accountNumber
required
object (AccountNumber)

The account number associated with the shipment.
Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/

Production Server

https://apis.fedex.com/ship/v1/openshipments/

Request samples - Confirm Open Shipment

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "labelResponseOptions": "LABEL",
  • "edtRequestType": "ALL",
  • "labelSpecification":
    {
    },
  • "index": "Test1234",
  • "shippingDocumentSpecification":
    {
    },
  • "accountNumber":
    {
    }
}

Response samples - Confirm Open Shipment

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "string",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

Modify Open Shipment Packages

This endpoint helps you to modify packages in Open Shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL
header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-modifyPackageInOpenShipment
  • MinimumSamplePayload-modifyPackageInOpenShipment
requestedPackageLineItem
required
object

Contains the data for the package that is to be modified in the open shipment.

index
required
string

This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number.
Example: Test1234

shipAction
string
Enum: "STRONG_VALIDATION" "WEAK_VALIDATION" "CREATE_PACKAGE"

Allowed values are STRONG_VALIDATION

accountNumber
required
object (AccountNumber)

The account number associated with the shipment.
Example: Your account number

trackingId
required
object (TrackingId)

Indicates the tracking details for the package.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/packages

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages

Request samples - Modify Open Shipment Packages

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "requestedPackageLineItem":
    {
    },
  • "index": "Test1234",
  • "shipAction": "STRONG_VALIDATION",
  • "accountNumber":
    {
    },
  • "trackingId":
    {
    }
}

Response samples - Modify Open Shipment Packages

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

Add Open Shipment Packages

This endpoint helps you to add packages to Open Shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL
header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-addPackagesToOpenShipment
  • MinimumSamplePayload-addPackagesInOpenShipment
index
required
string

This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number.
Example: Test1234

shipAction
string
Enum: "CONFIRM" "TRANSFER"

There are Ship actions as part of processing the shipment.

accountNumber
required
object (AccountNumber)

The account number associated with the shipment.
Example: Your account number

requestedPackageLineItems
required
Array of objects (RequestedPackageLineItem)

These are package line item details in the shipment.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/packages

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages

Request samples - Add Open Shipment Packages

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "index": "Test1234",
  • "shipAction": "STRONG_VALIDATION",
  • "accountNumber":
    {
    },
  • "requestedPackageLineItems":
    [
    ]
}

Response samples - Add Open Shipment Packages

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

Delete Open Shipment Packages

This endpoint helps you to delete packages from Open Shipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL
header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-deletePackagesFromOpenShipment
  • MinimumSamplePayload-deletePackagesOpenShipment
index
required
string

This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number.
Example: Test1234

accountNumber
required
object (AccountNumber)

The account number associated with the shipment.
Example: Your account number

trackingIds
required
Array of objects (TrackingId)

One or more tracking IDs, for which the packages to be removed from the shipment.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/packages/delete

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages/delete

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages/delete

Request samples - Delete Open Shipment Packages

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "index": "Test1234",
  • "accountNumber":
    {
    },
  • "trackingIds":
    [
    ]
}

Response samples - Delete Open Shipment Packages

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

Retrieve Open Shipment Package

This endpoint helps the user to RETRIEVE specific package request details of the Open Shipment that is created.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL
header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-retrievePackageInOpenShipment
  • MinimumSamplePayload-retrievePackageInOpenShipment
index
required
string

This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number.
Example: Test1234

accountNumber
required
object (AccountNumber)

The account number associated with the shipment.
Example: Your account number

trackingId
required
object (TrackingId)

Indicates the tracking details for the package.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/packages/retrieve

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/packages/retrieve

Production Server

https://apis.fedex.com/ship/v1/openshipments/packages/retrieve

Request samples - Retrieve Open Shipment Package

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "index": "Test1234",
  • "accountNumber":
    {
    },
  • "trackingId":
    {
    }
}

Response samples - Retrieve Open Shipment Package

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

OpenShipmentDelete V1

This endpoint helps you to delete a Openshipment request with the required shipping information before the shipment is confirmed.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL
header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-deleteOpenShipment
  • MinimumSamplePayload-deleteOpenShipment
index
required
string

This is a unique value for the shipment (must be unique for stand-alone open shipments, or unique within consolidation if consolidation key is provide).
Example: Test1234

accountNumber
required
object (AccountNumber)

The account number associated with the shipment.
Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /ship/v1/openshipments/delete

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/delete

Production Server

https://apis.fedex.com/ship/v1/openshipments/delete

Request samples - OpenShipmentDelete V1

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "index": "Test1234",
  • "accountNumber":
    {
    }
}

Response samples - OpenShipmentDelete V1

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

Retrieve Open Shipment

This endpoint helps the user to RETRIEVE the entire shipment request details of the OpenShipment that is created.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL
header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-RetrieveOpenShipment
  • MinimumSamplePayload-RetrieveOpenShipment
index
required
string

This is a unique value assigned to the already created Open Shipment. If this isn’t available then provide the master tracking number.
Example: Test1234

accountNumber
required
object (AccountNumber)

The account number associated with the shipment.
Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

post /ship/v1/openshipments/retrieve

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/retrieve

Production Server

https://apis.fedex.com/ship/v1/openshipments/retrieve

Request samples - Retrieve Open Shipment

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "index": "Test1234",
  • "accountNumber":
    {
    }
}

Response samples - Retrieve Open Shipment

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "XXX_ORDERXXXX789",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

Get Open Shipment Results

This endpoint enables you to finalize the Open Shipment. Once an Open Shipment is confirmed, no further changes can be done.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL
header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-getOpenShipmentResults
  • MinimumSamplePayload-getConfirmOpenShipmentResults
  • MinimumSamplePayload-getCreateOpenShipmentResults
  • MinimumSamplePayload-getModifyOpenShipmentResults
resultMethodType
required
string
Enum: "CREATE" "MODIFY" "CONFIRM"

The use of this method is to retrieve the results of the CREATE, MODIFY and CONFIRM events of Asynchronous flow.

  • CREATE- Customer will create Async shipment and will get jobId. Using the generated jobId in Get OpenShipment Results endpoint customer can retrieve the result of Create OpenShipment.
  • MODIFY- Customer will modify Async shipment and will get jobId. Using the generated jobId in Get OpenShipment Results endpoint customer can retrieve the result of Modify OpenShipment.
  • CONFIRM- Customer will confirm Async shipment and will get jobId. Using the generated jobId in Get OpenShipment Results endpoint customer can retrieve the result of Confirm OpenShipment.

jobId
required
string

Indicates the job under which the deferred shipment artifacts must be identified in the subsequent retrieval request.
Example: '89sxxxxx233ae24ff31xxxxx'

accountNumber
required
object (AccountNumber)

The account number associated with the shipment.
Example: Your account number

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/openshipments/results

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/openshipments/results

Production Server

https://apis.fedex.com/ship/v1/openshipments/results

Request samples - Get Open Shipment Results

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "resultMethodType": "CREATE",
  • "jobId": "89sxxxxx233ae24ff31xxxxx",
  • "accountNumber":
    {
    }
}

Response samples - Get Open Shipment Results

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "624xxxxx-b709-470c-8c39-4b55112xxxxx",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}
CLOSE

Response

Copy