Fedex Logo
Developer Portal

Freight LTL API

Introduction

L’API de fret en chargement partiel (LTL) vous permet de créer des envois pour les chargements partiels. Le fret en chargement partiel est trop volumineux pour être expédié en tant que colis, mais ne remplit pas la totalité d’un camion.

Cette API vous permet d’obtenir des estimations de tarifs, de créer des étiquettes d’expédition uniques pour les unités de manutention individuelles et les connaissements (le cas échéant), de planifier les ramassages, de suivre le statut d’un envoi et de vérifier la disponibilité. Vous gagnez ainsi en efficacité pour vos envois dont le poids et le volume sont plus élevés.

Le service d’expédition de chargements partiels de FedEx Freight offre un suivi et une visibilité pour chaque unité de manutention des envois d’unités de manutention multiples ainsi que pour les envois intérieurs sans connaissement papier (CONN), dans la plupart des cas. Un connaissement peut être créé si nécessaire. Même si toutes les unités de manutention ont un numéro de suivi unique, l’envoi est transporté au moyen d’un seul connaissement et ne nécessite qu’un reçu de livraison et un relevé de facture.

Détails sur l’API de fret en chargement partiel (LTL)

L’API de fret en chargement partiel (LTL) permet de faire des envois en chargement partiel et de créer les documents nécessaires tels que le connaissement (le cas échéant), les étiquettes d’expédition FedEx Freight et d’autres documents d’expédition. L’étiquette principale des envois de fret en chargement partiel est placée sur la première unité de manutention, et une étiquette secondaire est placée sur la deuxième unité et les suivantes. Les étiquettes secondaires ont leur propre numéro de suivi, mais sont reliées au numéro de suivi principal. Un seul connaissement est créé par envoi et comprend toutes les pièces et les unités de manutention.

Chaque unité de manutention peut être associée à un numéro de suivi et l’étiquette est semblable à une étiquette FedEx Ground ou Express Parcel, à l’exception de la lettre F (qui désigne un envoi de fret).

Voici le nombre maximal d’unités de manutention et de pièces par unité de manutention :

  • Nombre maximal de pièces par unité de manutention : 9 999
  • Nombre maximal d’unités de manutention : 200 (lors de l’impression d’une étiquette d’unité de manutention à la fois)
  • Nombre maximal d’unités de manutention : 40 (lors de l’impression des étiquettes de toutes les unités de manutention simultanément) 

Les envois de fret en chargements partiels FedEx sont disponibles à destination des 50 États américains ainsi qu’à Porto Rico, aux îles Vierges américaines, au Canada et au Mexique. Certains envois nécessitent un connaissement en plus des étiquettes d’expédition, comme les envois qui contiennent des matières dangereuses.

FedEx FreightMD modifie l’industrie du transport de chargements partiels en facilitant l’expédition rapide et économique du fret au sein d’un réseau LTL rationalisé.

Les fonctionnalités disponibles pour cet API sont les suivantes :

  • Gérer le ramassage des envois en chargement partiel

    Cette fonctionnalité permet d’obtenir les lieux de ramassage du fret en chargement partiel, de planifier le ramassage d’un envoi de fret et d’annuler un ramassage déjà planifié.

  • Obtenir des estimations de tarif pour le fret en chargement partiel

    Cette fonctionnalité permet d’obtenir des estimations de tarifs pour un envoi de fret en chargement partiel en fonction des lieux et des options de service sélectionnés.

  • Expédier un envoi de fret en chargement partiel

    Cette fonctionnalité permet de créer un envoi de fret en chargement partiel.

Voici les fonctionnalités de l’API de fret en chargement partiel (LTL) :

  • Faites un envoi constitué d’une seule pièce ou multipièce pour tous les types de services en générant une ou des étiquettes d’expédition ou un connaissement (si nécessaire).
  • Créez un envoi avec plusieurs unités de manutention et suivez chacune d’entre elles.
  • Créez des envois en chargements partiels en utilisant les services FedEx Freight Priority et Freight Economy.
    • Fournissez les renseignements sur le destinataire tels que le numéro de compte, les coordonnées du contact et l’adresse.
    • Indiquez l’horodatage, le type d’emballage, le poids total et tout autre détail nécessaire mentionné dans le schéma du point de terminaison.
  • Fournissez une étiquette de marque FedEx avec prise en charge d’étiquettes thermosensibles en différents formats.
  • Recevez des avis par courriel ou des messages texte lors de la transaction d’expédition, par exemple :
    • Avis d’expédition
    • Livraison prévue
    • Avis de ramassage
  • Générez des documents d’expédition, par exemple :
    • Étiquettes d’expédition par unité de manutention
    • Connaissement
    • Facture commerciale
    • Facture des douanes canadiennes
  • Créez des envois et imprimez des étiquettes pour chaque unité de manutention ou pour toutes les unités à la fois.
  • Obtenez les tarifs d’un envoi avec une seule pièce ou multipièce pour tous les types de services.
  • Vérifiez la disponibilité d’un ramassage, planifiez un ramassage de fret ou annulez un ramassage.
  • Créez et programmez le ramassage avec des comptes tiers pour une adresse de facturation alternative.

Fret de CR : fin du soutien

Le transporteur ne fournit pas le service CR (contre remboursement) aux clients. Le transporteur ne sera pas responsable de la collecte du montant de CR, car ce service n‘est pas offert par le transporteur. Tous les frais d‘entreposage de réacheminement et de transport s‘appliqueront aux envois étiquetés CR.

Services d’expédition de fret en chargement partiel

Les services d’expédition de fret en chargement partiel disponibles sont les suivants :

FedEx FreightMD Priority

Avec des délais de livraison parmi les plus courts et une ponctualité inégalée, FedEx FreightMD Priority livre vos colis rapidement et avec fiabilité. Vous pouvez compter sur notre service régional pour proposer une livraison le lendemain ou en deux jours à vos clients, le tout couvert par une garantie de remboursement sans frais*.

Le service FedEx FreightMD Priority offre :

  • des délais de livraison rapides avec livraison le lendemain jusqu’à 965 km (600 milles) et livraison en deux jours jusqu’à 2 570 km (1 600 milles)
  • une livraison directe vers pratiquement tous les codes postaux aux États-Unis, au Canada et au Mexique
  • fiabilité et ponctualité
  • une garantie de remboursement sans frais*
  • une technologie d’information de pointe avec une visibilité sur les envois de bout en bout
  • une équipe de professionnels spécialisée afin de répondre à vos besoins en matière d’expédition régionale de fret

* Tous les services sont assujettis aux modalités et conditions du Tarif général FXFR Série 100.

FedEx Freight Economy

FedEx FreightMD Economy offre une livraison économique de chargements partiels axée sur vos besoins de base en matière d’expédition de fret. Grâce à nos services de livraison de chargements partiels FedEx, à notre ponctualité et au soin de notre manutention, le service à la clientèle est assuré.

FedEx FreightMD Economy offre :

  • des solutions d’expédition de fret économiques
  • des économies supplémentaires pour les envois moins urgents avec livraison fiable
  • fiabilité et ponctualité
  • une livraison directe vers pratiquement tous les codes postaux aux États-Unis, au Canada, au Mexique et à Porto Rico
  • une technologie d’information de pointe avec une visibilité sur les envois de bout en bout
  • une meilleure visibilité avec un suivi de l’envoi de bout de bout

FedEx International DeferredMD fret (FDF)

FedEx International Deferred Freight (FDF) est un service mondial d‘envoi de fret aérien permettant d‘expédier des envois internationaux avec des délais de livraison/transit prolongés à des tarifs économiques. Le FDF est également offert pour les services de livraison d’aéroport à aéroport, de l‘expéditeur à l‘aéroport, d’aéroport à l‘expéditeur et de porte à porte.

Note :

  • Actuellement, ce service est uniquement offert pour des liaisons sélectionnées entre certains pays.
  • Les marchandises dangereuses (MD) et les produits à usage restreint ne sont pas autorisés. Exemple : glace sèche, batteries au lithium-ion. Veuillez communiquer avec le soutien à la clientèle de FedEx pour obtenir plus de renseignements.
  • Les envois intérieurs américains et les envois intérieurs non américains ne sont pas autorisés.

Fonctionnement de l’API de fret en chargement partiel (LTL)

Cette section décrit les points de terminaison et les éléments clés requis pour l’API de fret en chargement partiel (LTL) de FedEx Freight.

Remarque : Votre compte de chargements partiels FedEx Freight doit être activé pour utiliser l’API de fret en chargement partiel (LTL) de FedEx Freight. Les principaux renseignements requis sont le ou les numéros de compte FedEx Freight et l’adresse de correspondance exacte du compte pour traiter les envois en chargements partiels.

Les points de terminaison disponibles pour cette API sont les suivants :

Expédier du fret en chargement partiel

Ce point de terminaison vous permet de valider et de créer l’envoi de fret en chargement partiel FedEx.

Voici les renseignements d’entrée requis pour cette demande :

  • Numéro de compte Freight
  • Adresse de correspondance du compte
  • Envoi de fret concerné par la demande
  • Options de réponse d’étiquette : étiquettes à renvoyer telles qu’encodées ou sous forme d’URL.
  • Détails de suivi principaux : dans ce cas uniquement, l’envoi multipièce doit être traité et les étiquettes doivent être imprimées individuellement plutôt qu’en une seule fois (lorsque l’élément singleShotMPS n’est pas fourni ou présent avec la valeur false).

Une réponse sans erreur à cette demande crée l’envoi en chargement partiel et fournit les détails du suivi et de l’alerte dans la réponse. Elle renvoie également les erreurs et leur description en cas d’échec.

Remarque : L’adresse de correspondance peut différer de l’adresse d’expédition réelle.

Vérifier la disponibilité du ramassage de fret en chargement partiel

Ce point de terminaison vous permet de demander une liste complète des points de ramassage du fret avec des détails sur la planification du ramassage tels que le transporteur, la dernière heure de disponibilité du ramassage, l’heure limite de disponibilité par défaut, la disponibilité du ramassage, l’heure à laquelle le colis est prêt à être ramassé, l’information indiquant si l’adresse est résidentielle, l’heure limite de ramassage et l’accès du chauffeur pour ramasser le colis.

Voici les renseignements d’entrée requis pour cette demande :

  • Détails sur l’adresse du ramassage.
  • Type de demande de ramassage (par exemple : même jour/date future).
  • Ramassage intérieur ou international.

Remarque : Utilisez une adresse de ramassage exacte et valide.

Une demande sans erreur renvoie dans la réponse une liste de tous les lieux de ramassage disponibles, le jour de livraison, la disponibilité (indicateur), la date du ramassage, l’heure limite de ramassage, l’heure d’accès, la disponibilité du service résidentiel (indicateur), l’heure de fermeture (indicateur) et l’heure locale. Elle renvoie également les erreurs et leur description en cas d’échec.

Créer un ramassage d’envoi en chargement partiel

Utilisez ce point de terminaison pour créer et planifier un ramassage de fret en chargement partiel.

Voici les renseignements d’entrée requis pour cette demande :

  • Numéro de compte Freight auquel le ramassage sera facturé.
  • Détails de l’emplacement d’origine (adresse, emplacement et type d’adresse du ramassage tel que compte/expéditeur/autre).
  • Détails de l’adresse pour le compte associé.

Une demande de ramassage sans erreur renvoie un numéro de confirmation de ramassage, un avis de ramassage et un code d’emplacement pour le ramassage planifié. Elle renvoie également les erreurs et leur description en cas d’échec.

Remarque : Utilisez une adresse exacte et valide pour le ramassage et indiquez également l’adresse exacte versée au compte pour planifier le ramassage. N’entrez pas une heure de disponibilité passée, une date passée ni une date trop éloignée dans le futur pour planifier un ramassage. Les ramassages anonymes ne sont pas autorisés.Vous pouvez programmer un ramassage pour des comptes tiers en fournissant une adresse alternative valide.

Annuler un ramassage d’envoi en chargement partiel

Utilisez ce point de terminaison pour annuler une demande de ramassage de fret en chargement partiel déjà planifiée. Une annulation de ramassage sans erreur renvoie un numéro de confirmation et un message de confirmation d’annulation du ramassage.

Voici les renseignements d’entrée requis pour cette demande :

  • Code de confirmation de ramassage (obtenu lors de l’envoi d’une demande de ramassage)
  • Date prévue (date à laquelle le ramassage doit avoir lieu)
  • Emplacement (emplacement FedEx Express responsable du traitement de la demande de ramassage)

Une demande sans erreur renvoie un numéro de confirmation de ramassage, un avis de ramassage et un code d’emplacement pour le ramassage planifié. Elle renvoie également les erreurs et leur description en cas d’échec.

Remarque : Soumettez le code de confirmation du ramassage et le code d’emplacement correspondant (concerne uniquement FDXE) pour annuler le ramassage déjà planifié. Le numéro de confirmation de ramassage et le code d’emplacement correspondant (concerne uniquement FDXE) s’obtiennent lors de l’envoi d’une demande de ramassage. Indiquez également l’adresse exacte versée au compte pour annuler le ramassage. Vous recevrez un avis d’échec si vous tentez d’annuler un ramassage après que le messager FedEx a été envoyé sur les lieux du ramassage.

Tarifer un envoi de fret en chargement partiel

Ce point de terminaison vous permet de demander une liste de toutes les estimations de tarifs de fret possibles et des renseignements facultatifs sur le trajet en fonction des renseignements fournis. Les tarifs obtenus dépendent du point d’origine, de la destination et d’autres renseignements à propos de l’envoi. Vous pouvez utiliser d’autres renseignements tels que le code de transporteur, le type de service ou l’option de service pour affiner les résultats.

Voici les renseignements d’entrée requis pour cette demande :

  • Numéro de compte Freight
  • Envoi de fret concerné par la demande

Une demande sans erreur renvoie une liste de tous les tarifs possibles et le code d’emplacement du ramassage planifié. Elle renvoie également les erreurs et leur description en cas d’échec.

Envoi multipièce de fret en chargement partiel

Un envoi multipièce se compose d’au moins deux unités de manutention expédiées à une même adresse de destination. La première unité de manutention de la demande d’envoi est considérée comme l’élément principal.

Pour créer un envoi multipièce :

  • Fournissez les renseignements au niveau de l’envoi tels que serviceType, packagingType, totalWeight, totalPackageCount, freightShipmentDetail et les détails requestedPackageLineItems. [Remarque : la valeur sequenceNumber du colis principal doit être égale à 1.]
  • Pour imprimer une étiquette par unité de manutention, incluez les détails du suivi principal dans l’élément masterTrackingId pour toutes les unités de manutention suivantes.

Cette API contient les options de traitement des envois multipièces suivants :

Imprimer une étiquette d’unité de manutention à la fois

Cette API vous permet de traiter des envois multipièce et de générer chaque étiquette individuellement.

Lorsque vous avez besoin de cette fonctionnalité pour vos envois, définissez l’élément oneLabelAtATime as true ainsi que tous les éléments multipièces nécessaires dans la demande d’envoi.

La première demande doit aboutir à la génération d’une étiquette et d’un numéro de suivi (le numéro de suivi principal). Indiquez ce numéro de suivi principal dans l’élément masterTrackingId pour traiter la demande d’envoi suivante et générer les étiquettes avec les numéros de suivi (numéros de suivi secondaires) pour le nombre total de colis définis (totalPackageCount).

Remarque : Le nombre maximal d’unités de manutention autorisé est de 200.

Imprimer les étiquettes de toutes les unités de manutention simultanément

Cette API vous permet de traiter des envois multipièces et de générer les étiquettes en une seule fois. Il s’agit de l’une des méthodes de traitement les plus efficaces, utilisée lorsqu’un envoi comprend 40 unités de manutention ou moins (totalPackageCount<=40) et doit être livré à la même adresse de destination.

Définissez oneLabelAtATime comme false (faux) dans la demande d’envoi de 40 unités de manutention ou moins et générez les étiquettes instantanément.

Remarque : La limite de 40 unités de manutention est donnée à titre indicatif et n’est pas une limite fixe. Elle dépend également de la combinaison entre le nombre d’unités de manutention et les marchandises. Communiquez avec votre directeur de compte FedEx pour obtenir un complément d’information sur le sujet.

Exemple : votre demande d’envoi comporte 10 unités de manutention, ce qui génèrera 10 étiquettes une fois soumise. Les URL d’étiquettes ou les étiquettes encodées requises seront indiquées dans la réponse.

FedEx Freight Direct

Ce service offre une expérience client de qualité supérieure pour la livraison de marchandises volumineuses et palettisées, y compris la livraison d’envois lourds et encombrants à l’intérieur du domicile ou de l’entreprise du client.

Le service offre des options telles que des communications proactives, des options de livraison flexibles et une tarification groupée qui inclut des suppléments pour les services.

Voici quelques-unes des caractéristiques de ce service :

  • Permet de créer des envois FedEx Freight Direct de base, des envois de base sur rendez-vous, des envois de livraison standard et premium et des envois de retour/ramassages de base à l’intérieur des États-Unis continentaux, de l’Alaska et d’Hawaï.
  • Comprend la possibilité d’obtenir une estimation tarifaire complète pour un envoi FedEx Freight Direct en utilisant un numéro de compte FedEx Freight Direct et la possibilité d’annuler un ramassage FedEx Freight Direct.
    • Des estimations de tarifs ne seront pas renvoyées pour l’Alaska et Hawaï. Les clients doivent appeler le service à la clientèle de FedEx pour demander une estimation pour ces États.
    • Pour annuler un ramassage prévu le jour même, le client doit appeler le service à la clientèle de FedEx.
  • Permet d’envoyer des avis par courriel à l’expéditeur/le destinataire initial afin que le client puisse :
    • planifier une livraison
    • recevoir une confirmation de livraison et/ou de ramassage
    • recevoir un avis de livraison en cours et/ou de ramassage
    • recevoir des avis lorsque le chauffeur est en route
    • Enquête auprès des clients pour les envois livrés
  • Les règles commerciales de validation du code postal, des dimensions, du poids de la pièce et du poids de l’unité de manutention s’appliqueront à FedEx Freight Direct pour déterminer la combinaison adéquate de services de transport de ligne et de services livraison initiale/finale.

FedEx Freight Direct propose différents types de services.

Cette API offre les fonctionnalités suivantes avec le service Freight Direct :

Obtenir des tarifs pour Freight Direct

Utilisez ce point de terminaison pour obtenir des tarifs et des suppléments pour Freight Direct pour les options de services spéciaux Freight Direct : service de base, service de base sur rendez-vous, service standard, service premium.

Les renseignements suivants sont nécessaires pour accompagner la demande de tarif utilisant le point de terminaison tarifaire Freight LTL :

  • Type d’envoi Freight Direct (BASIC, BASIC_BY_APPOINTMENT, PREMIUM, STANDARD)
  • Type de transport Freight Direct (DELIVERY, PICKUP)
  • Type de numéro de téléphone si le numéro de téléphone est fourni (HOME, MOBILE, WORK)
  • Poids
  • Dimensions (longueur, largeur et hauteur non négatives)

Créer un envoi Freight Direct

Utilisez ce point de terminaison pour expédier un envoi d’une seule pièce ou multipièces pour les options de services spéciaux Freight Direct : service de base, service de base sur rendez-vous, service standard, service premium. Obtenez une étiquette d’expédition ou un CONN, y compris les documents requis pour le traitement d’un envoi Freight Priority.

Les renseignements suivants doivent être joints à la demande d’expédition utilisant le point de terminaison Expédier du fret en chargement partiel :

  • Type d’envoi Freight Direct (BASIC, BASIC_BY_APPOINTMENT, PREMIUM, STANDARD)
  • Type de transport Freight Direct (DELIVERY, PICKUP)
  • Adresse courriel, numéro de téléphone et type de téléphone
  • Poids
  • Dimensions (longueur, largeur et hauteur non négatives)

Les noms des nouveaux services Freight Direct seront imprimés sur le CONN. Les valeurs suivantes sont imprimées sur le CONN en fonction de la sélection du service :

  • LIVRAISON DIRECTE DE BASE
  • LIVRAISON DIRECTE DE BASE SUR RENDEZ-VOUS
  • LIVRAISON DIRECTE PREMIUM
  • LIVRAISON DIRECTE STANDARD
  • RAMASSAGE DIRECTE DE BASE
  • RAMASSAGE DIRECTE DE BASE SUR RENDEZ-VOUS
  • RAMASSAGE DIRECT PREMIUM
  • RAMASSAGE DIRECT STANDARD

Ramassage Freight Direct

Utilisez ce point de terminaison pour vérifier la disponibilité du service de ramassage de fret LTL Freight Direct, créer une demande de ramassage pour un colis à ramasser ou annuler une demande de ramassage existante.

Les détails suivants doivent accompagner la demande de ramassage utilisant le point de terminaison : Vérifier la disponibilité d’un ramassage de fret en chargement partiel, Créer un ramassage de fret en chargement partiel et Annuler un ramassage de fret en chargement partiel.

  • Type d’envoi Freight Direct (BASIC, BASIC_BY_APPOINTMENT, PREMIUM, STANDARD)
  • Type de transport Freight Direct (DELIVERY, PICKUP)
  • Adresse courriel (création de la demande de ramassage)
  • Numéro de téléphone et type de téléphone (création de la demande de ramassage)
  • Poids

Règles opérationnelles

  • Un numéro de suivi principal (Pro) est attribué à la première unité de manutention d’un envoi de fret en chargement partiel et des numéros secondaires sont attribués aux unités suivantes.
  • Chacune des unités de manutention de l’envoi peut être suivie individuellement ou comme faisant partie intégrante de l’envoi.
  • D’autres documents peuvent être requis pour certains envois (par exemple les envois internationaux ou ceux qui contiennent des matières dangereuses [HAZMAT]).
  • Le fret en chargement partiel et la facturation des comptes de fret en chargement partiel ne peuvent pas être ajoutés au FedEx Developer Portal.
  • Pour utiliser les services Freight Direct, le client peut utiliser soit le numéro de compte LTL à long terme, soit le numéro de compte FedEx Freight Direct.
  • Les capacités de tarification de FedEx Freight Direct ne sont disponibles que dans l’API LTL habituelle.
  • Toutes les nouvelles erreurs et tous les nouveaux messages seront rédigés en anglais uniquement.
  • L’adresse courriel et le numéro de téléphone sont obligatoires dans le cadre de la demande d’option de service FedEx Freight Direct lors de la création d’envois.

Collection d’API JSON

Documentation Powered by ReDoc

Freight LTL API (1.0.0)

Rate Freight LTL

This endpoint providess the ability to retrieve rate quotes and optionall transitt informationnnn. The rate is calculated based on the origin and destination of the shipment. Additional information such as carrier code, service type, or service option can be used to filter the results. Applicable operating company is FedEx Freight.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

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
  • MinimumSamplePayload
accountNumber
required
object (LTLRootAccountNumber)

This is the Account number details.
Note:

  • In case if this is shipping account number, do use the account number used for creating Auth Token.

rateRequestControlParameters
object (LTLRateRequestControlParameters)

These are various parameters you can provide for filtering and sorting capability in the response, such as transit time and commit data, rate sort order etc.

freightRequestedShipment
required
object (LTLRequestedShipment)

This contains shipment data describing the shipment for which a freight rate quote (or rate-shopping comparison) is desired.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /rate/v1/freight/rates/quotes

Sandbox Server

https://apis-sandbox.fedex.com/rate/v1/freight/rates/quotes

Production Server

https://apis.fedex.com/rate/v1/freight/rates/quotes

Request samples

Content type
application/json
Example
FullSchema
Copy
 Expand all Collapse all
{
  • "accountNumber":
    {
    },
  • "rateRequestControlParameters":
    {
    },
  • "freightRequestedShipment":
    {
    }
}

Response samples

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

Ship Freight LTL

This endpoint helps you to create a Freight LTL Shipment request with the required Freight LTL Shipment information, and to retrieve information for an already in process shipment. It also allows you to confirm and validate your shipment.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

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-FreightShipment
  • FreightShipment_ShipTo_Freight_Account
  • FreightShipment_BillTo_Freight_Account
  • FreightShipment_International_SingleShot_MPS_ShipTo_Freight_Account
  • FreightShipment_OneLabelAtATime_MPS_Master_ShipTo_Freight_Account
  • FreightShipment_OneLabelAtATime_MPS_Child_ShipTo_Freight_Account
freightRequestedShipment
required
object (FreightRequestedShipment_Freight2020)

The descriptive data for the FreightShipment being tendered to FedEx.

labelResponseOptions
required
string
Enum: "URL_ONLY" "LABEL"

If the value is LABEL, the encoded label will be included in the response and if the value is URL_ONLY, the response will include the URLs.

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

accountNumber
required
object (ShipperAccountNumber)

The account number associated with the shipment.

oneLabelAtATime
boolean

If the value is false, it uses single shot MPS shipments where in all the packages are processed in the same transaction and can generate number of labels for the handling units all at once. If the value is true, the MPS shipment processes packages and labels one at a time. Default value is false.
Example: true or false

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/freight/shipments

Sandbox Server

https://apis-sandbox.fedex.com/ship/v1/freight/shipments

Production Server

https://apis.fedex.com/ship/v1/freight/shipments

Request samples

Content type
application/json
Example
FullSchema-FreightShipment
Copy
 Expand all Collapse all
{
  • "freightRequestedShipment":
    {
    },
  • "labelResponseOptions": "LABEL",
  • "accountNumber":
    {
    },
  • "oneLabelAtATime": true
}

Response samples

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

Check Freight LTL Pickup Availability

This endpoint allows you to check the availability of an Freight LTL pickup service. The pickup availability depends on two factors, the cut off time and the access time.

Cut off time - The latest time allowed for a pickup to be scheduled. The time is local to the pickup postal code.

Access time - The time between the pickup ready time (when the package is ready to be picked) and the time when the driver is ready to pick up the package.

Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

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-FreightPickupAvailability
  • MinimumSamplePayload-FreightPickupAvailability
pickupAddress
required
object (PickupAddress)

The address for which pickup availability inquiry is made.

packageReadyTime
string

The time that the package will be ready for pickup. The time format is HH:MM:SS and it refers to the local timezone. The driver should pick up the package/shipment by the given pickup time.

customerCloseTime
string

The latest time the driver gets access to pick up the package. The time format is in HH:MM:SS and it refers to the local timezone. The driver should pick up the package by the given pickup time.

shipmentAttributes
object (ShipmentAttributes)

Indicates the shipment details such as service type, packaging type, weight and dimensions.

freightPickupSpecialServiceDetail
object (FullSchemaFreightPickupAvailability_freightPickupSpecialServiceDetail)
dispatchDate
string

Indicates the date, the package is to be picked up. The format is YYYY-MM-DD. If the field is left blank, the system considers current date as dispatch date.

numberOfBusinessDays
integer <int32>

Number of business days to consider when checking availability.
For example if you are indicating pickupDate as Saturday and you indicate 3, Saturday, Sunday and Monday will be considered.
Example: 3

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /pickup/v1/freight/pickups/availabilities

Sandbox Server

https://apis-sandbox.fedex.com/pickup/v1/freight/pickups/availabilities

Production Server

https://apis.fedex.com/pickup/v1/freight/pickups/availabilities

Request samples

Content type
application/json
Example
FullSchema-FreightPickupAvailability
Copy
 Expand all Collapse all
{
  • "pickupAddress":
    {
    },
  • "packageReadyTime": "15:30:00",
  • "customerCloseTime": "18:00:00",
  • "shipmentAttributes":
    {
    },
  • "freightPickupSpecialServiceDetail":
    {
    },
  • "dispatchDate": "2019-10-14",
  • "numberOfBusinessDays": 1
}

Response samples

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

Create Freight LTL Pickup

This endpoint helps you to create a freight pickup request for a package to be picked up.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

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-CreatePickup
  • MinimumSamplePayload-CreateFreightPickup
  • MinimumSamplePayload-FreightBillToPickup
associatedAccountNumber
required
object

The associated account number, which is invoiced for the freight pickup.

originDetail
required
object

The origin address if different than the one associated with the shipper account. This element value is required when the package is to be picked up from an address other than the shipper account address.

totalWeight
Array of objects (TotalWeight)

The total weight of the packages for the pickup. Unit of measure is LB and KG.

packageCount
integer <int32>

The total number of packages for the pickup.
Example: 5

remarks
string

This is a placeholder for any message to be passed to the FedEx pickup. courier.
Example: Please ring bell at loading dock.

countryRelationships
string
Enum: "DOMESTIC" "INTERNATIONAL"

Describes the country relationship among the shipments being picked up.
'DOMESTIC' indicates intra-country shipping; origin and destination country are the same.
'INTERNATIONAL' indicates inter-country shipping; origin and destination countries are different.
Not applicable for FedEx Ground shipments
Example: DOMESTIC

trackingNumber
string

This is a tracking number for FedEx packages used for tracking a single package or group of packages.
Example: XXXX0365XXXX

commodityDescription
string

Description of the commodity being shipped.
Example:This field contains CommodityDescription

freightPickupDetail
required
object

This provides the Freight LTL pickup detailed information.

oversizePackageCount
integer <int32>

The number of oversize packages that are tendered to FedEx Ground.

pickupNotificationDetail
object

This object allows user to request for pickup confirmation email. User can specify upto 5 email addresses.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /pickup/v1/freight/pickups/

Sandbox Server

https://apis-sandbox.fedex.com/pickup/v1/freight/pickups/

Production Server

https://apis.fedex.com/pickup/v1/freight/pickups/

Request samples

Content type
application/json
Example
FullSchema-CreatePickup
Copy
 Expand all Collapse all
{
  • "associatedAccountNumber":
    {
    },
  • "originDetail":
    {
    },
  • "totalWeight":
    [
    ],
  • "packageCount": 5,
  • "remarks": "Please ring bell at loading dock.",
  • "countryRelationships": "DOMESTIC",
  • "trackingNumber": "795803657326",
  • "commodityDescription": "This field contains CommodityDescription",
  • "freightPickupDetail":
    {
    },
  • "oversizePackageCount": 2,
  • "pickupNotificationDetail":
    {
    }
}

Response samples

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

Cancel Freight LTL Pickup

Use this endpoint to cancel the already scheduled freight pickup request. Note a failure notification will be sent if you attempt to cancel a pickup after the FedEx courier has been dispatched to the pickup location.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

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-CancelFreightPickup
  • MinimumSamplePayload-FreightCancel
associatedAccountNumber
required
object (AccountNumber_2)

Specify the FedEx Account number.
Example: Your account number

pickupConfirmationCode
required
string

The confirmation number provided by FedEx to the customer when the pickup was scheduled or requested.
Example: XXXX1007MEM62XXXX.

remarks
string

Specify the additional information to be passed on the pickup courier.

reason
required
string

Specify the reason for cancellation of pickup.

contactName
required
string

Specify the contact name.

scheduledDate
string

Specifies the date when pickup dispatch occurs.
Format YYYY-MM-DD
Example: 2019-10-15

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

put /pickup/v1/freight/pickups/cancel/

Sandbox Server

https://apis-sandbox.fedex.com/pickup/v1/freight/pickups/cancel/

Production Server

https://apis.fedex.com/pickup/v1/freight/pickups/cancel/

Request samples

Content type
application/json
Example
FullSchema-CancelFreightPickup
Copy
 Expand all Collapse all
{
  • "associatedAccountNumber":
    {
    },
  • "pickupConfirmationCode": "20201007MEM628005",
  • "remarks": "This is my remarks",
  • "reason": "This is my reason",
  • "contactName": "This is my contactName",
  • "scheduledDate": "2019-10-15"
}

Response samples

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

Response

Copy