Fedex Logo
Developer Portal

Trade Documents Upload API
DOWNLOAD JSON SCHEMA

Introduction

L’API de téléversement des documents commerciaux est une solution de téléversement de documents d’expédition internationaux FedEx qui simplifie vos besoins d’expédition à l’échelle mondiale et permet de téléverser en ligne les documents de douane requis. Vous pouvez soumettre la plupart de vos documents commerciaux par voie électronique, ce qui vous évite d’imprimer ou de joindre des documents commerciaux à l’envoi.

Les douanes ainsi que d'autres agences reçoivent les documents électroniques plus rapidement que les copies papier jointes à votre envoi. Le processus de dédouanement est également optimisé, car les renseignements commerciaux importants sont partagés aux premiers stades de l’expédition.

Note :

  • Parfois, il faut tout de même joindre au colis les originaux de certains documents internationaux. Pour obtenir plus de détails, consultez la section Documents d’exportation.
  • Pour faciliter le dédouanement et éviter les retards, assurez-vous que les documents sont bien lisibles et que les caractères ne sont pas déformés.

Détails sur l’API de téléversement des documents commerciaux

Vous pouvez téléverser vos documents de douane ou utiliser les documents commerciaux générés par FedEx. Vous pouvez également personnaliser les documents commerciaux électroniques générés par FedEx en téléversant l’en-tête/le logo de votre entreprise ainsi que votre signature numérique. Grâce au téléversement des documents en ligne, vous n’avez plus besoin de signer, de plier, d’insérer ni de joindre manuellement des documents de douane à chaque envoi. Et en plus d’économiser du papier et de l’énergie, vous réduisez aussi les coûts d’impression.

Voici les fonctionnalités de cette API :

Téléverser un document

Vous pouvez téléverser un document à la fois avant de créer l’envoi ou après l’avoir créé à l’aide de l’API d’expédition.

Remarque : Le processus de création d’un envoi mentionné dans cette page se rapporte à l’API d’expédition, option Créer un envoi, Ouvrir à l’API d’expédition, option Créer un envoi ouvert et à l’API de fret LTL, option Envoi de fret en chargement partiel.

Téléverser plusieurs documents

Vous pouvez téléverser un maximum de cinq documents par demande de téléversement pour les conditions avant et après l‘envoi.

Téléverser plusieurs documents encodés

Vous pouvez téléverser des documents encodés en base64 (jusqu‘à cinq) en une seule fois avant de créer l‘envoi (avant l‘envoi) ou après la création de l‘envoi (après l‘envoi). Les documents téléversés à l‘aide de cette option offrent une sécurité supplémentaire aux données des documents en cas d‘interception improbable.

Télécharger les images

Cette fonctionnalité vous permet de téléverser des logos/en-têtes d’entreprise et des signatures numériques que vous pouvez utiliser dans les documents ou les rapports générés par FedEx. Tout d’abord, téléversez le logo/l’en-tête d’entreprise ainsi que la signature numérique sur les serveurs FedEx, puis indiquez ces références de téléversement dans votre demande d’envoi (créer le point de terminaison de l’envoi) pour chaque document à l’aide de l’élément customerImageUsages sous shippingDocumentSpecification.

Les signatures numériques ou les en-têtes/logos d’entreprise sont imprimés sur les documents et les rapports générés par FedEx suivants :

  • Facture commerciale
  • Certificat d'origine
  • OP900
  • Facture pro forma
  • Certificat d’origine de l’AEUMC
  • Facture commerciale de l’AEUMC et certificat d’origine

Note :

  • Signature numérique : la résolution limite est de 240 x 25 pixels et seuls les formats GIF et PNG sont acceptés.
  • En-tête/logo d’entreprise : la résolution limite est de 700 x 50 pixels et seuls les formats GIF et PNG sont acceptés.

Flux de travail de l’API de téléversement des documents commerciaux

Vous trouverez ci-dessous le flux qui peut être utilisé pour téléverser un document selon des scénarios avant l’envoi ou après l’envoi.

Téléversement des documents avant l’envoi :

Si vous souhaitez téléverser un ou des documents avant l’envoi, vous devez le faire via cette API avant la création de l’envoi. Après avoir téléversé le(s) document(s) avec succès, vous pouvez associer la référence du(des) document(s) téléversé(s) à la demande d‘envoi.

Il s’agit de la méthode standard de téléversement de vos documents commerciaux avant la confirmation de l’envoi.

Voici comment procéder pour téléverser des documents avant un envoi :

  • Utilisez l‘un des points de terminaison suivants selon vos besoins
    • Téléverser un document
    • Téléverser plusieurs documents
    • Téléverser des documents encodés
  • Indiquez la valeur ETDPreShipment dans workflowName pour préciser qu’il s’agit d’un téléversement avant l’envoi.
  • Fournir le(s) fichier(s) réel(s) ou le(s) document(s) encodé(s) en base64 à téléverser.
  • Donnez des détails sur le document (facture commerciale, certificat d’origine, déclaration d’exportation, etc.), y compris le type de document et les métadonnées d‘envoi associées au document.
  • Une demande réussie téléversera les documents sur les serveurs de FedEx et renverra un identifiant unique, c‘est-à-dire docId, pour chaque document téléversé en tant que jeton de réussite.
  • Utilisez le point de terminaison Créer un envoi/créer un envoi ouvert/envoi de fret LTL.
  • Dans le point de terminaison d‘expédition que vous avez choisi, sélectionnez envoideServicesSpéciaux/typesdeServicesSpéciaux comme DOCUMENTS ÉLECTRONIQUES DE COMMERCE et transmettez la ou les valeurs de docId à l‘élément d‘envoi ServicesSpeciaux/etdDetail/Documentsjoints/Iddudocument.
    • Remarque : Pour les envois multipièces, indiquez le docId généré par le téléversement des documents pour tous les colis de l’envoi.
  • Une demande d’envoi sans erreur confirme l’envoi de DCE à FedEx et génère les détails de suivi et d’étiquette. De plus, l’objet completedEtdDetail renvoie le type de document téléversé et l’identifiant du (des) document(s) comme référence.
  • Si vous téléversez des documents avant l‘envoi, vous pouvez téléverser tous les documents un par un ou jusqu‘à 5 documents ensemble, puis fournir les identifiants de tous les documents à l‘envoi en une seule fois.

Téléversement de documents après l’envoi (PSDU) :

Le téléversement des documents après l’envoi (PSDU) vous permet de téléverser un ou des documents une fois l’envoi créé et les étiquettes de suivi générées. Dans ce cas, lorsque l’envoi aura été créé et que le numéro de suivi aura été généré, associez ce dernier à votre demande de téléversement de documents.

Cette méthode est pratique pour les clients qui génèrent leurs factures commerciales et dont des tiers ou des bureaux à distance créent des documents de douane.

Voici quelques points importants à retenir lorsque vous utilisez cette méthode :

  • Vous devez avoir sous la main le numéro de suivi et la date de l’envoi avant la demande de téléversement.
  • Vous devez connaître les heures limites de ramassage à l’emplacement de l’expéditeur pour soumettre la documentation à temps.

Cette API prend également en charge la soumission de documents de douane pour les envois à venir et ceux du jour.

Voici comment procéder pour téléverser des documents après un envoi :

  • Utilisez le point de terminaison Créer un envoi/créer un envoi ouvert/envoi de fret LTL.
  • Dans le point de terminaison Créer un envoi, spécifiez les détails ci-dessous en fonction de votre sélection,
    • Indiquez shipmentSpecialServices/specialServiceTypes dans ELECTRONIC_TRADE_DOCUMENTS.
    • Indiquez shipmentSpecialServices/etdDetail/attributesdans POST_SHIPMENT_UPLOAD_REQUESTED.
  • Une demande d’envoi sans erreur confirme l’envoi à FedEx et génère les détails de suivi et d’étiquette.
  • Utilisez l‘un des points de terminaison suivants selon vos besoins.
    • Téléverser un document
    • Téléverser plusieurs documents
    • Téléverser plusieurs documents encodés.
  • Indiquez la valeur ETDPostShipment dans workflowName pour préciser qu’il s’agit d’un téléversement après l’envoi.
  • Fournir le(s) fichier(s) réel(s) ou le(s) document(s) encodé(s) en base64 à téléverser.
  • Donnez des détails sur le document (facture commerciale, certificat d’origine, déclaration d’exportation, etc.).
  • Indiquez numérodeSuivi de l‘envoi et dated‘Envoi déjà traités sous les éléments document/meta/numérodeSuivi et document/meta/dated‘Envoi.
    Remarque : Pour les envois multipièces, utilisez le numéro de suivi principal de l’envoi lors du téléversement des documents. Les détails des DCE fournis pour l’envoi principal sont aussi applicables à l’envoi secondaire.
  • Une demande sans erreur téléverse les documents sur les serveurs FedEx et associe les documents téléversés à l’envoi.

Vous trouverez ci-dessous les caractéristiques de l’API de téléversement des documents commerciaux, qui vous permet de téléverser des documents et des images en lien avec les documents d’envoi.

Fonctionnement de l’API de téléversement des documents commerciaux

Vous trouverez ci-dessous les caractéristiques de l’API de téléversement des documents commerciaux, qui vous permet de téléverser des documents et des images en lien avec les documents d’envoi

Téléverser un document

Utilisez ce point de terminaison pour téléverser des documents commerciaux pour les conditions avant et après l’envoi.

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

  • attachment : il s’agit du fichier à téléverser.
  • workFlowName : précisez l’élément ETDPreShipment pour le téléversement avant l’envoi et l’élément ETDPostShipment pour le téléversement après l’envoi.
  • document : donnez des détails sur le document et indiquez les métadonnées de l’envoi.
  • trackingNumber : indiquez le numéro de suivi PSDU de l’envoi pour lequel vous téléversez les documents. Cette option est facultative pour le téléversement de documents avant l’envoi.
  • shipmentDate : il s’agit de la date de l’envoi. Cette option est facultative pour le téléversement de documents avant l’envoi.

Si la réponse à une demande de téléversement avant l’envoi est sans erreur, le document est téléversé sur les serveurs FedEx et la valeur docId est renvoyée. La valeur docId est utilisée pour soumettre l’envoi et générer les étiquettes.

Si la réponse à une demande de téléversement après l’envoi est sans erreur, les documents sont téléversés sur les serveurs FedEx et associés à l’envoi déjà confirmé.

Téléverser les images

Utilisez ce point de terminaison pour téléverser une signature ou un en-tête/logo d’entreprise personnalisés, qui pourront ensuite être ajoutés aux documents d’expédition.

Vous trouverez ci-dessous les renseignements requis pour cette demande :

  • attachment – il s’agit du fichier image.
  • document : donnez des détails sur l’image tels que le nom du fichier, le type de contenu et les métadonnées du fichier.

Une demande sans erreur téléverse la signature et l’en-tête/le logo de l’entreprise sur les serveurs FedEx et renvoie la valeur imageIndex. Cet index est ensuite transmis dans votre demande d’envoi pour l’élément du document individuel customerImageUsages sous shippingDocumentSpecification afin d’assurer l’impression de la signature ou de l’en-tête/du logo sur le document d’envoi.

Téléverser plusieurs documents

Ce point d‘accès permet de téléverser des documents commerciaux (jusqu‘à cinq) pour les conditions avant et après l‘envoi. Vous trouverez ci-dessous les renseignements d’entrée requis pour cette demande :

  • Nomdufluxdetravail : précisez l’élément ETDPreShipment pour le téléversement avant l’envoi et l’élément ETDPostShipment pour le téléversement après l’envoi.
  • Nomdufichier‑ Indiquez les noms des documents ou des fichiers mis à jour ainsi que le type d‘extension. Exemple : COD.PDF
  • typedeContenu – Indiquez le type de fichier et le format à téléverser parmi les options disponibles.
  • Typededocumentd‘envoi – Indiquez les types de documents qui seront téléversés.

    Pour plus de renseignements sur les documents individuels, veuillez consulter la section Téléversement de documents sur cette page. Voici la liste des types de documents que vous pouvez choisir :

    • CERTIFICAT_D‘ORIGINE/FACTURE_COMMERCIALE
    • ÉTIQUETTE_DCE
    • CERTIFICATION_USMCA_D‘ORIGINE
    • CERTIFICAT_D‘ORIGINE_DE_LA_FACTURE_COMMERCIALE_DE_L‘USMCA
    • AUTRE
    • FACTURE_PRO_FORMA
  • codeTransporteur – Indiquez le code à quatre lettres des sociétés en exploitation FedEx. Exemple: FDXE
  • codePaysd‘Origine – Indiquez le code du pays d’origine de l’envoi.
  • destinationCountryCode – Indiquez le code du pays de destination de l’envoi.
    • Remarque : Consultez le Guide de Référence pour rechercher votre code pays. Exemple : ÉTATS-UNIS
  • Dated‘envoi‑ Pour le téléversement après l‘envoi, indiquez la date d‘envoi réelle.
  • Numérodesuivi‑ Pour le téléversement après l‘envoi, indiquez le numéro de suivi de l‘envoi. Exemple: 7825XXXXXXX.

Si la réponse à une demande de téléversement avant l’envoi est sans erreur, les documents sont téléversés sur les serveurs FedEx et la valeur d’identifiant du document (docId) est renvoyée. La valeur docId est utilisée pour soumettre l’envoi et générer les étiquettes.

Si la réponse à une demande de téléversement après l’envoi est sans erreur, les documents sont téléversés sur les serveurs FedEx et associés à l’envoi déjà confirmé.

Téléverser plusieurs documents encodés

Ce point d‘accès permet de téléverser des documents commerciaux codés en base64 (jusqu‘à cinq) pour les conditions avant et après l‘envoi.

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

  • workFlowName : précisez l’élément ETDPreShipment pour le téléversement avant l’envoi et l’élément ETDPostShipment pour le téléversement après l’envoi.
  • codeTransporteur – Indiquez le code à quatre lettres des sociétés en exploitation FedEx. Exemple: FDXE
  • typedeContenu – Indiquez le type de fichier et le format à téléverser parmi les options disponibles.
  • shipDocumentType – Indiquez les types de documents qui seront téléversés.

    Pour plus de renseignements sur les documents individuels, veuillez consulter la section Téléversement de documents sur cette page. Voici la liste des types de documents que vous pouvez choisir :

    • CERTIFICAT_D‘ORIGINE/FACTURE_COMMERCIALE
    • ÉTIQUETTE_DCE
    • CERTIFICATION_USMCA_D‘ORIGINE
    • CERTIFICAT_D‘ORIGINE_DE_LA_FACTURE_COMMERCIALE_DE_L‘USMCA
    • AUTRE
    • FACTURE_PRO_FORMA
  • originCountryCode – Indiquez le code du pays d’origine de l’envoi.
  • destinationCountryCode – Indiquez le code du pays de destination de l’envoi.
    • Remarque : Consultez le Guide de Référence pour rechercher votre code pays. Exemple : ÉTATS-UNIS
  • contenuFichierBase64 ‑ Spécifiez le contenu du bytecode pour le fichier base64 à téléverser.

Pour le téléversement avant l‘envoi, la réponse réussie téléversera les documents encodés vers les serveurs FedEx et renverra les documents Ids (docId). La valeur docId est utilisée pour soumettre l’envoi et générer les étiquettes.

Pour le téléversement après expédition, la réponse réussie téléversera les documents encodés vers les serveurs FedEx et associera les documents téléversés à l‘envoi déjà confirmé.

Télécharger les documents

Voici les documents qui peuvent être soumis avec cette API :

Certificat d’origine

Un certificat d’origine est un document international qui vérifie le pays/territoire de fabrication d’un produit. Certains pays restreignent les importations en provenance de pays en particulier, plusieurs autres limitent la quantité de marchandises importées et certains donnent la préférence aux marchandises fabriquées dans un pays précis.

Facture commerciale (FC)

Il s’agit d’un document fourni par le vendeur ou l’exportateur, qui décrit les parties concernées par la transaction d’expédition et les marchandises transportées. C’est le document principalement utilisé par les douanes. Il doit être préparé dans la langue officielle du pays/territoire du destinataire, si possible. La facture commerciale doit comprendre une description détaillée de tous les articles inclus dans l’envoi, y compris : une description appropriée des marchandises (Qu’est-ce que c’est? Quelle est sa composition? Quelle est son utilisation prévue?), la quantité, le pays/territoire de fabrication, le prix ou le coût, la devise utilisée, le numéro du Système harmonisé pour chaque marchandise et les conditions de livraison. Certains pays exigent qu’une facture originale soit signée sur le papier à en-tête de l’expéditeur. La facture doit toujours être signée et datée par l’exportateur certifiant que les détails fournis sont des représentations exactes et justes du contenu couvert par la facture commerciale.

Pour obtenir de plus amples renseignements, consultez notre Global Trade Manager.

ÉTIQUETTE DCE

Il s’agit de l’étiquette d’expédition générée pour l’envoi lorsque vous utilisez le service spécial DCE avec les critères de téléversement des documents après l'envoi. Cette étiquette peut également être téléversée avec l’envoi ainsi qu’avec d’autres documents.

Facture pro forma

La facture pro forma est émise avant que la vente ait lieu. Après avoir reçu la facture pro forma du fournisseur, l’acheteur envoie un bon de commande ou ouvre une lettre de crédit au fournisseur. Le vendeur prend les dispositions nécessaires pour expédier les marchandises à la date convenue.

Facture commerciale AEUMC et certification d’origine

Un certificat d’origine (CO) est requis pour les marchandises qui bénéficient d’une entrée à taxes réduites ou nulles en tant que produit de l’un des trois participants à l’ACCORD CANADA-ÉTATS-UNIS-MEXIQUE (ACEUM) : le Canada, le Mexique et les États-Unis. Le certificat est rempli par l’exportateur ou le fabricant des marchandises.

Certification d’origine de l’AEUMC

Une facture commerciale et un certificat d’origine (CO) de l’ACEUM sont requis pour les marchandises qui bénéficient d’une entrée à taxes réduites ou nulles en tant que produit de l’un des trois participants au CONTRACT CANADA-ÉTATS-UNIS-MEXIQUE (ACEUM) : le Canada, le Mexique et les États-Unis. Le certificat est rempli par l’exportateur ou le fabricant des marchandises et fourni avec la facture commerciale.

Autre

La section suivante décrit certains des documents courants classés dans la catégorie « autres documents ». Vous n’êtes pas tenus de téléverser ces documents pour un envoi, mais ils peuvent être exigés pour le dédouanement de votre envoi en particulier. Cela dépend du type d’envoi, du point d’origine, de la destination et d’autres facteurs.

  • Bordereau d'expédition

    • Un bordereau d’expédition est requis si plusieurs colis sont sous une même lettre de transport aérien ou si l’envoi pèse plus de 100 kg. Veuillez noter que cette exigence peut varier selon les marchés en fonction des marchandises expédiées. Le bordereau doit décrire correctement et précisément les marchandises, leur quantité et leur poids.

  • Formulaire 740 de la FCC (Statement Regarding the Importation of Radio Frequency Devices Capable of Causing Harmful Interference)

    • Le formulaire 740 de la Commission fédérale des communications (FCC) est requis pour expédier des articles électroniques contenant des appareils à radiofréquences susceptibles de causer des interférences nuisibles. Le formulaire comporte des informations telles que le nom du modèle ou du type d’appareil, le numéro tarifaire harmonisé ainsi que le nom et l’adresse du fabricant, du destinataire et de l’importateur.

  • Déclaration pour film vidéo

    • Déclaration pour les films et les vidéos : ce document est soumis pour déclarer que la vidéo ou le film expédié ne présente aucun contenu obscène ou immoral ni aucune matière prônant l’insurrection contre les États-Unis. Le document comporte des détails tels que la longueur du film ou de la vidéo, sa durée ainsi qu’un bref résumé du contenu.

Avis de non-responsabilité : Les renseignements ci-dessus peuvent changer.

Les autres documents ne sont requis et téléversés qu’en fonction des pays, des produits et d’autres exigences comme des documents de douane spéciaux. Pour afficher une liste de plusieurs autres documents couramment utilisés, cliquez sur Exporter des documents.

Documents de douanes et exigences

Il est important de joindre les bons documents aux envois intérieurs et internationaux. Chaque pays a des lois et des règlements particuliers en matière d’expédition internationale. Pour les exportations des États-Unis, les États-Unis et les pays de destination exigent différents types de documents.

Remarque : Les envois auxquels on doit joindre des documents supplémentaires en plus de la lettre de transport aérien internationale FedEx, de la lettre de transport aérien FedEx International Next Flight ou de la lettre de transport aérien FedEx International Mail Service (par exemple une facture commerciale) peuvent nécessiter un délai de livraison supplémentaire.

Marchandises contrôlées

Lorsque vous expédiez les marchandises suivantes à l’international, assurez-vous qu’elles sont acceptées par le service FedEx de votre choix en vue d’être livrées dans le pays et la ville de destination :

  • Marchandises dangereuses
  • International Traffic in Arms Regulations (ITAR ou Réglementation américaine sur le trafic d’armes au niveau international)
  • Marchandises dangereuses en quantités exemptées.
    Remarque : Pour expédier des marchandises dangereuses en quantités exemptées, utilisez l’option de service spécial SMALL_QUANTITY_EXCEPTION.
  • Colis radioactifs exemptés

Avis de non-responsabilité : Les renseignements ci-dessus peuvent changer. Pour plus de détails, consultez le Guide des services ou votre représentant FedEx.

Déclaration d’exportation pour les envois sortants canadiens

Une déclaration d’exportation est requise par l’Agence des services frontaliers du Canada (ASFC) pour déclarer les exportations du Canada, dans les conditions suivantes.

  • Tous les envois sortants canadiens contenant des marchandises non réglementées, lorsque les marchandises commerciales sont évaluées à 2 000 CAD ou plus et que la destination est un pays autre que les États-Unis, Porto Rico ou les îles Vierges américaines.
  • Tous les envois sortants canadiens qui comprennent des marchandises contrôlées, soumises à des restrictions ou réglementées, peu importe leur valeur.

Les transporteurs doivent obtenir le numéro de preuve de déclaration de la part de l’exportateur avant que les marchandises ne quittent le Canada. Un exportateur est tenu de soumettre la déclaration d’exportation avant de fournir un numéro de preuve de déclaration au transporteur.

Electronic Export Information (EEI)

La déclaration d’exportation électronique (EEI) est produite dans l’Automated Export System (AES) au moyen d’AESDirect au sein de l’environnement commercial automatisé (ACE). Le portail de données sécurisé ACE est un point d’accès centralisé qui permet à la communauté commerciale de se connecter au service des douanes et de la protection des frontières des États-Unis (U.S. Customs and Border Protection ou CBP).

L’EEI est la version électronique équivalente de la déclaration d’exportation de l’expéditeur (SED), le formulaire 7525-V du Département du commerce (Bureau du recensement) des États-Unis, qui ne peut plus être soumis au gouvernement américain. L’EEI fournit des statistiques et un contrôle des exportations, en rapportant toutes les données d’exportation pertinentes d’une transaction d’expédition internationale.

L’EEI est obligatoire et doit être soumise par voie électronique par l’exportateur ou son agent au moyen du Automated Export System (AES) pour les marchandises figurant sur la Liste de contrôle de commerce (CCL).

Si l’envoi provient des États-Unis, des îles Vierges américaines ou de Porto Rico et que le pays destinataire est la Chine, la Russie, le Venezuela ou Hong Kong, vous devez fournir les informations suivantes, quelle que soit la valeur de l’envoi :

  • Le numéro de transaction interne (ITN) de l’EEI produite
  • Le bon numéro de classification de contrôle d’exportation (ECCN) ou le numéro de classification EAR99 pour chaque article
  • Une exemption de production d’EEI applicable

Les exemptions sont autorisées si l’envoi

  • Est admissible à l’exemption de licence GOV
  • Est admissible aux exemptions prévues par les Export Administration Regulations et les Foreign Trade Regulations (FTR)
  • Se compose uniquement d’articles classés EAR99

Remarque : Pour les autres destinations, vous devez produire une EEI pour toutes les exportations américaines si une ou plusieurs marchandises (numéro de l’annexe B) totalisent plus de 2 500 $ US dans l’envoi groupé pour un jour donné.

Lettre d’instructions de l’expéditeur (SLI)

La SLI comprend des renseignements sur un envoi international pour les clients américains.

Note :

  • Le dédouanement est compris dans notre service de courtage inclus pour les envois vers le Canada (des frais s’appliquent). Le service de courtage inclus pourrait n’être disponible qu’avec certaines solutions d’expédition électronique.

Le service de distribution de colis FedEx International GroundMD permet à FedEx GroundMD de grouper les envois FedEx International GroundMD en une seule unité. Cette unité est dédouanée et traitée comme une seule déclaration en douane avec des frais de courtage uniques.

Avantages de l’API de téléversement des documents commerciaux

Voici quelques avantages associés à l’API/la fonctionnalité de téléversement de documents commerciaux :

  • Moins de problèmes de dédouanement, ce qui diminue les retards à la douane et augmente la fiabilité de l’expédition et la réputation du vendeur.
  • Davantage de temps pour développer l’entreprise, ce qui améliore sa productivité et ses bénéfices tout en éliminant la nécessité d’imprimer et de faire correspondre plusieurs copies de documents à des colis individuels.
  • Insertion de l’en-tête d’une entreprise et de l’image de signature sur la facture commerciale ou pro forma générée par FedEx.
  • Davantage de temps pour résoudre les éventuels problèmes concernant les documents de douane, tels que des renseignements manquants, avant l’arrivée de l’envoi.
  • Possibilité de soumettre votre facture commerciale par voie électronique pour les envois FedEx International Ground au Canada.
  • Soumission à FedEx des documents de douane pour vos prochains envois, jusqu’à 10 jours à l’avance.
  • Plus grande tranquillité d’esprit, car les renseignements sur les marchandises ne sont pas divulgués à des tiers, les factures ne figurant pas sur les emballages.
  • Réduction de l’empreinte carbone en diminuant la consommation de papier, d’encre en poudre et de matériel d’expédition et l’utilisation d’imprimantes.
  • Moins de risques de vol de vos envois, puisque les factures ne sont plus fixées sur les colis et que personne ne peut accéder aux renseignements sur les marchandises qu’ils contiennent.
  • Fait gagner du temps et limite les risques d’erreur lorsque vous faites des envois à l’international.
  • Cette fonctionnalité de téléversement de documents convient aux exportations comme aux importations. Consultez la liste des pays disponibles pour savoir si le téléversement de documents est accepté dans les pays d’origine et de destination.
  • Vous pouvez préparer, stocker et réutiliser les documents téléversés en ligne au moyen du Centre de préparation de documents FedEx et en consultant la section Aide sur les documents internationaux.

Règles opérationnelles

Voici quelques-unes des règles métier importantes associées à l’API/la fonctionnalité de téléversement de documents :

  • Les types de fichiers valides pour les documents téléversés sont les suivants : PDF, TXT, PNG, JPG, GIF, BMP, TIF, RTF, DOC, DOCX, XLS et XLSX.
  • Les documents peuvent être téléversés au maximum 10 jours avant l’envoi.
  • Les images ou les documents commerciaux téléversés ne peuvent excéder 5 Mo.
  • Pour les signatures numériques, la résolution limite est de 240 x 25 pixels et seuls les formats GIF et PNG sont acceptés.
  • Pour les en-têtes/logos d’entreprise, la résolution limite est de 700 x 50 pixels et seuls les formats GIF et PNG sont acceptés.
  • Il se peut que l’image de l’en-tête ne soit pas acceptée pour tous les emplacements d’origine et de destination, en fonction des réglementations douanières.
  • Les images seront téléversées telles quelles : aucune modification ne sera apportée par FedEx.
  • Les documents de douane peuvent être téléversés par voie électronique selon les options de traitement et de service spéciales suivantes :
    • Glace sèche
    • Marchandises dangereuses
    • Matières dangereuses
  • Obligatoire pour les envois TPC (destinataire tiers) en provenance des États-Unis, de l’Asie-Pacifique, du Canada et des pays de l’Union européenne où le téléversement est possible.
  • Tout envoi avec documents électroniques doit être créé et ramassé le jour d’expédition demandé, et les documents doivent également être téléversés le jour même.
  • Lorsque vous utilisez l’option de téléversement de documents après l’envoi (PSDU), assurez-vous de téléverser le ou les documents avant le ramassage du colis.

 

 

 

 

Documentation Powered by ReDoc

Trade Documents Upload API (1.0.2)

Upload Document

Use this endpoint to upload the trade documents electronically before (pre-shipment) and after (post-shipment) the shipment is created.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL

To learn more about how to get OAuth access token, refer to API Authorization documentation.

header Parameters
Content-Type
required
string
Default: "multipart/form-data"

Indicates the type of content
Example: "multipart/form-data"

Authorization
required
string
Default: "Bearer ****"

Indicates the JWE token to be used for authorizing the client request.
Example: "Bearer ****"

x-customer-transaction-id
string
Example: 771407-1

This is the customer transaction identifier.
Example: 771407-1

Request Body schema: multipart/form-data
One of
  • FullSchema-DocumentUploadInputVO
attachment
required
string <file>

Input the actual document/file to be uploaded.

document
required
object (ETDUploadRequest)

Provide all the document details and shipment meta data.

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /documents/v1/etds/upload

EDU Sandbox Server

https://documentapitest.prod.fedex.com/sandbox/documents/v1/etds/upload

EDU Production Server

https://documentapi.prod.fedex.com/documents/v1/etds/upload

Request samples - Upload Document

Content type
multipart/form-data
Example
Full-Schema
Copy
document: {"workflowName":"ETDPreshipment","carrierCode":"FDXE","name":"file.txt","contentType":"text/plain","meta":{"shipDocumentType":"COMMERCIAL_INVOICE","formCode":"USMCA","trackingNumber":"794791292805","shipmentDate":"2021-02-17T00:00:00","originLocationCode":"GVTKK","originCountryCode":"US","destinationLocationCode":"DEL","destinationCountryCode":"IN"}}
attachment: file.txt

Response samples - Upload Document

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

Upload Images

Use this endpoint to upload customized Company Letterhead/Logo and Digital signature images which can be used in the FedEx generated paperwork or reports.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL

To learn more about how to get OAuth access token, refer to API Authorization documentation.

header Parameters
Authorization
required
string
Example: Bearer XXX

Specifies the authorization token.
Example: Bearer XXX

x-customer-transaction-id
required
string
Example: 771407-1

Identifies the transaction ID of the request.
Example: "771407-1"

Request Body schema: multipart/form-data
attachment
required
string <file>

Input the actual image file to be uploaded.

document
required
object (Document)

Indicate the image reference metadata details.

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /documents/v1/lhsimages/upload

EDU Sandbox Server

https://documentapitest.prod.fedex.com/sandbox/documents/v1/lhsimages/upload

EDU Production Server

https://documentapi.prod.fedex.com/documents/v1/lhsimages/upload

Request samples - Upload Images

Content type
multipart/form-data
Copy
document: {"document": {"referenceId": "1234", "name": "LH2.PNG",    "contentType": "image/png",    "meta": { "imageType": "SIGNATURE","imageIndex": "IMAGE_1"}},"rules": {"workflowName": "LetterheadSignature" }}
attachment: file.PNG

Response samples - Upload Images

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

Upload Multiple Documents

Use this endpoint to upload multiple trade documents electronically before (pre-shipment) and after (post-shipment) the shipment is created


EXPAND ALLCOLLAPSE ALL

To learn more about how to get OAuth access token, refer to API Authorization documentation.

header Parameters
Content-Type
required
string
Default: "multipart/form-data"
Example: multipart/form-data

Type of content

Authorization
required
string
Default: "Bearer XXXXXX"
Example: Bearer XXXXXX

This indicates the authorization token for the input request.

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

Request Body schema: multipart/form-data
One of
  • FullSchema-MultiDocumentRequest
  • MinimumSamplePayload-MultiPreShipment
  • MinimumSamplePayload-MultiPostShipment
documentInformation
object (MultiETDUploadRequest)

Provide all the documents' details and shipment meta data

fileAttachments
Array of strings <binary> <= 5 items

Input the actual document/file to be uploaded.

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

INTERNAL.SERVER.ERROR

503

Service Unavailable

post /documents/v1/etds/multiupload

EDU Sandbox Server

https://documentapitest.prod.fedex.com/sandbox/documents/v1/etds/multiupload

EDU Production Server

https://documentapi.prod.fedex.com/documents/v1/etds/multiupload

Request samples - Upload Multiple Documents

Content type
multipart/form-data
Example
FullSchema-MultiDocumentRequest
Copy
documentInformation: {"workflowName": "ETDPreshipment","carrierCode": "FDXE","originCountryCode": "US","destinationCountryCode": "CA","shipmentDate": "2021-10-21T00:00:00","trackingNumber": "782514212510","metaData": [{"fileName":"file1.png","fileReferenceId":"inv_file1_ctx_02132021_5","contentType": "image/png","formCode": "USMCA","shipDocumentType":"COMMERCIAL_INVOICE"},{"fileName":"file2.txt", "fileReferenceId":"PI_2", "contentType":"text/plain", "formCode": "USMCA", "shipDocumentType":"PRO_FORMA_INVOICE"},{"fileName":"file3.txt", "fileReferenceId":"PI_2", "contentType":"text/plain", "formCode": "USMCA", "shipDocumentType":"PRO_FORMA_INVOICE"},{"fileName":"file4.txt", "fileReferenceId":"PI_2", "contentType":"text/plain", "formCode": "USMCA", "shipDocumentType":"PRO_FORMA_INVOICE"},{"file5.txt", "fileReferenceId":"PI_2", "contentType":"text/plain", "formCode": "USMCA", "shipDocumentType":"PRO_FORMA_INVOICE"}]
fileAttachments: 'file1.png'
fileAttachments: 'file2.txt'
fileAttachments: 'file3.txt'
fileAttachments: 'file4.txt'
fileAttachments: 'file5.txt'

Response samples - Upload Multiple Documents

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerTransactionId": "5678b975-ev0e-420b-8d7b-aa6ce65ec48n",
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "output":
    {
    }
}

Upload Multiple Encoded Documents

Use this endpoint to upload multiple trade documents as base64 electronically before (pre-shipment) and after (post-shipment) the shipment is created


EXPAND ALLCOLLAPSE ALL

To learn more about how to get OAuth access token, refer to API Authorization documentation.

header Parameters
Content-Type
required
string
Default: "application/json"
Example: application/json

Type of content

Authorization
required
string
Default: "Bearer XXXXXX"
Example: Bearer XXXXXX

This indicates the authorization token for the input request.

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

Request Body schema: application/json
One of
  • FullSchema-Base64MultiDocumentRequest
  • MinimumSamplePayload-Base64MultiPreShipment
  • MinimumSamplePayload-Base64MultiPostShipment
workflowName
required
string
Enum: "ETDPreshipment" "ETDPostshipment"

Indicate if the documents are being uploaded before or after shipment creation process

carrierCode
required
string
Enum: "FDXE" "FDXG"

Specify the four letter code of a FedEx operating company that meets your requirements
Examples of FedEx Operating Companies are:

  • FDXE - FedEx Express
  • FDXG - FedEx Ground

orginCountryCode
required
string

Origin country code for the shipment.

Example: US
Click here to see Country Codes

destinationCountryCode
required
string

Destination country code for the shipment.

Example: CA

shipmentDate
string

Specify the Shipment date. This is only required for Post Shipment document upload. This value is present in Create Shipment response & this should match the shipment date timestamp

trackingNumber
string

Specifies the tracking number of the shipment. This is only required for Post Shipment documentation upload.
Example: 782514212510

metaData
required
Array of objects (MultiMetaDataRequest_1) <= 5 items

Indicate the shipment metadata associated with the document to be uploaded

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

INTERNAL.SERVER.ERROR

503

Service Unavailable

post /documents/v1/etds/encodedmultiupload

EDU Sandbox Server

https://documentapitest.prod.fedex.com/sandbox/documents/v1/etds/encodedmultiupload

EDU Production Server

https://documentapi.prod.fedex.com/documents/v1/etds/encodedmultiupload

Request samples - Upload Multiple Encoded Documents

Content type
application/json
Example
FullSchema-Base64MultiDocumentRequest
Copy
 Expand all Collapse all
{
  • "workflowName": "ETDPreshipment",
  • "carrierCode": "FDXE",
  • "originCountryCode": "US",
  • "destinationCountryCode": "CA",
  • "shipmentDate": "2024-01-06T00:00:00",
  • "trackingNumber": "782514212510",
  • "metaData":
    [
    ]
}

Response samples - Upload Multiple Encoded Documents

Content type
application/json
Copy
 Expand all Collapse all
{
  • "customerTransactionId": "5678b975-ev0e-420b-8d7b-aa6ce65ec48n",
  • "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
  • "output":
    {
    }
}

Error Codes

  • 1001

    Requête non valide : saisie non valide : Détails du document non valides

  • 1001

    Requête non valide : saisie non valide : Nom du flux de travail

  • 1005

    Requête non valide : informations obligatoires manquantes pour le flux de travail spécifié

  • 1021

    Le type du fichier chargé est incorrect.

  • 1024

    Échec de la validation de l’envoi ETD : Veuillez saisir un type de document valide.

  • 1024

    Échec de la validation de l’envoi ETD : Code du pays d’origine non valide.

  • 1024

    Échec de la validation de l’envoi ETD : Code du pays de destination non valide.

  • 1024

    Échec de la validation de l’envoi ETD : Le fichier sélectionné ne peut pas être chargé. Veuillez choisir un fichier avec une extension prise en charge. (.doc, .xls, .txt, .rtf, .jpg, .jpeg, .gif, .bmp, .tif, .png et .pdf)

  • 1024

    Échec de la validation de l’envoi ETD : Code de transporteur manquant ou non valide

  • 1024

    Échec de la validation de l’envoi ETD : Le numéro de suivi est obligatoire

  • 1024

    Échec de la validation de l’envoi ETD : Horodatage de l’envoi manquant ou non valide

  • 1024

    Échec de la validation de l’envoi ETD : Le délai limite a été atteint pour le chargement de ces documents postexpédition. Le chargement de vos documents n’a pas été traité. Veuillez imprimer vos documents et les joindre à votre envoi.

  • Bad Request

    La partie de la demande requise « pièce jointe » n’est pas présente.

  • Bad Request

    La partie de la demande requise « document » n’est pas présente.
CLOSE

Response

Copy