Developer Portal
Freight LTL API
Einleitung
Mit der Freight LTL-API können Sie Less-than-Truckload (LTL)-Sendungen erstellen. LTL-Fracht ist zu groß, um als Paket versendet zu werden, benötigt jedoch auch keinen kompletten Lkw.
Die API ermöglicht Ihnen, geschätzte Raten abzurufen, eindeutige Versandetiketten für einzelne Handling Units sowie Konnossements (falls erforderlich) zu erstellen, Abholungen zu vereinbaren und den Status der Sendung zu verfolgen sowie die Verfügbarkeit von Abholungen zu prüfen. Dadurch profitieren Sie bei größeren und schwereren Sendungen von höherer Effizienz.
Beim LTL-Versand mit FedEx Freight können Sie Sendungen auf Handling-Unit-Ebene verfolgen und erhalten eine Übersicht über Sendungen mit mehreren Handling Units. Außerdem ist beim nationalen Versand in der Regel kein Konnossement (Frachtbrief) erforderlich ist. Ein Konnessement kann bei Bedarf erstellt werden. Die einzelnen Handling Units haben eigene Sendungsverfolgungsnummern. Der Versand erfolgt jedoch mit einem gemeinsamen Konnossement, einem Zustellbeleg und auf eine Rechnung.
Details zur Freight LTL-API
Die Freight LTL-API ermöglicht den LTL-Versand und erstellt die notwendigen Unterlagen wie Konnossement (wenn angefordert), FedEx Freight Versandetiketten und weitere Versanddokumente. Bei Freight LTL-Sendungen erhält die erste Handling Unit das Master-Etikett und die nachfolgenden Handling Units erhalten Child-Etiketten. Die Child-Etiketten haben eine eigene eindeutige Sendungsverfolgungsnummer, verweisen jedoch auf die Master-Sendungsverfolgungsnummer. Pro Sendung kann ein Konnossement mit allen Handling Units und Teilsendungen erstellt werden.
Jede Handling Unit kann mit einer Sendungsverfolgungsnummer verknüpft werden und das Etikett entspricht im Wesentlichen dem von FedEx Ground bzw. Express Paketen, jedoch wird mit einem F angegeben, dass es sich um eine Frachtsendung handelt.
Maximale Anzahl von Handling Units und Teilsendungen pro Handling Unit:
- Höchstgrenze für Teilsendungen pro Handling Unit: 9.999
- Höchstgrenze für Handling Units: 200 (bei Einzeldruck von Handling-Unit-Etiketten).
- Höchstgrenze für Handling Units: 40 (bei gleichzeitigem Druck aller Handling-Unit-Etiketten).
FedEx Freight LTL-Sendungen sind in alle 50 US-Bundesstaaten sowie nach Puerto Rico, auf die Amerikanischen Jungferninseln, nach Kanada und Mexiko möglich. Für einige Sendungen ist zusätzlich zu den Versandetiketten ein Konnossement erforderlich. Das ist beispielsweise bei Sendungen der Fall, die Gefahrgut enthalten.
FedEx Freight® revolutioniert die LTL-Branche mit dem einfachen, schnellen und wirtschaftlichen Frachtversand in einem optimierten LTL-Netzwerk.
Im Folgenden sind die Funktionen aufgeführt, die mit dieser API verfügbar sind:
- Freight LTL-Abholung verwalten
Mit dieser Funktion können Sie die Stationen für Freight LTL-Abholungen abrufen, Frachtabholungen in Auftrag geben und eine bereits beauftragte Abholungen stornieren.
- Freight LTL-Ratenauskünfte abrufen
Diese Funktion ermöglicht das Abrufen von Ratenauskünften zu Freight LTL-Sendungen anhand der ausgewählten Stationen und Serviceoptionen.
- Freight LTL-Sendung versenden
Mit dieser Funktion können Sie eine Freight LTL-Sendung erstellen.
Im Folgenden sind die Funktionen der Freight LTL-API aufgeführt:
- Versenden von Einzelpaket- oder MPS-Sendungen für alle Service-Arten und Generieren der entsprechenden Versandetiketten oder eines Konnossements (falls erforderlich)
- Erstellen von Sendungen mit mehreren Handling Units und Verfolgen der einzelnen Handling Units
- Erstellen von LTL-Sendungen für FedEx Freight Priority und Freight Economy Services
- Geben Sie die Empfängerinformationen wie die Kundennummer, den Ansprechpartner und die Adresse an.
- Geben Sie den Zeitstempel, den Verpackungstyp, das Gesamtgewicht und andere erforderliche Details an, die im Endpunktschema genannt werden.
- Erstellen von FedEx Etiketten mit einem Standard-Branding und Unterstützung angegebener Größen für Thermoetiketten
- Benachrichtigungen per E-Mail oder SMS während der Versandtransaktion, darunter:
- Versandbenachrichtigung
- Voraussichtliche Zustellung
- Abholbenachrichtigung
- Generieren von Versanddokumenten wie:
- Versandetiketten für einzelne Handling Units
- Konnessement
- Handelsrechnung
- Kanadische Zollrechnung
- Erstellen von Sendungen und Drucken von Etiketten für jeweils eine Handling Unit oder gemeinsam für alle Handling Units
- Abrufen von Raten für eine Einzelpaket- oder MPS-Sendung für alle Service-Arten
- Prüfen der Verfügbarkeit von Abholungen, Vereinbaren von Frachtabholungen und Stornieren von Abholungen
- Erstellen und Buchen der Abholung mit einem externen Konto und alternativer Rechnungsadresse
Fracht Nachnahme: Ende des Supports
Der Frachtführer bietet Kund*innen keine Bezahlung per Nachnahme an. Der Frachtführer haftet nicht für die Einziehung des Nachnahmebetrags. Es handelt sich nicht um einen vom Frachtführer bereitgestellten Service. Für Sendungen, für die Bezahlung per Nachnahme angegeben ist, werden alle Lagerungs-, Weitersendungs- und Frachtzuschläge erhoben.
Freight LTL-Versandservices
Die folgenden Freight LTL-Versandservices sind verfügbar:
FedEx Freight® Priority
FedEx Freight® Priority stellt Ihre Sendungen mit branchenführender Pünktlichkeit und kurzen Laufzeiten schnell und zuverlässig zu. Unser regionaler Service übernimmt zuverlässig die flächendeckende Zustellung am nächsten und übernächsten Tag an Ihre Kunden mit kostenloser Geld-zurück-Garantie. *
Vorteile des FedEx Freight® Priority Service:
- Kurze Laufzeiten mit Next-Day Service bis zu 100 km (600 Meilen) und Second-Day Service bis zu 2500 km (1.600 Meilen)
- Direkte Zustellung an praktisch jede Postleitzahl in den USA, Kanada und Mexiko
- Jederzeit termingerechte Zustellung
- Kostenlose Geld-zurück-Garantie*
- Modernste Informationstechnologie mit End-to-End-Sendungsübersicht
- Ein engagiertes Team von Fachleuten, das Sie bei allen Angelegenheiten rund um den regionalen Frachtversand unterstützt
* Alle Services unterliegen den Geschäftsbedingungen des FXFR 100 Series Rules Tariff.
FedEx Freight Economy
FedEx Freight® Economy ermöglicht die wirtschaftliche Zustellung von LTL-Fracht (Less-than-Truckload) ohne besondere Anforderungen. Die FedEx LTL-Zustelldienste gewährleisten mit pünktlicher Zuverlässigkeit und vorsichtiger Handhabung ein herausragendes Kundenerlebnis.
Vorteile von FedEx Freight® Economy:
- Wirtschaftliche Frachtlösungen
- Günstigere Raten für Sendungen, die weniger zeitkritisch sind, jedoch zuverlässig zugestellt werden müssen
- Jederzeit termingerechte Zustellung
- Direkte Zustellung an praktisch jede Postleitzahl in den USA, Kanada, Mexiko und Puerto Rico
- Modernste Informationstechnologie mit End-to-End-Sendungsübersicht
- Bessere Übersicht mit End-to-End-Sendungsverfolgung
FedEx International Deferred Freight (FDF)
FedEx International Deferred Freight (FDF) ist ein globaler Luftfrachtversandservice für den Versand internationaler Luftfrachtsendungen mit erweiterten Zustell-/Laufzeiten zu günstigen Preisen. Die Zustellservices ATA (Airport-to-Airport – Flughafen-zu-Flughafen), Tür-zu-Flughafen, Flughafen-zu-Tür und Tür-zu-Tür sind im Rahmen von FDF ebenfalls verfügbar.
Hinweis:
- Derzeit ist dieser Service nur für ausgewählte Land-zu-Land-Wege verfügbar.
- Gefahrgut (GG) und Waren, die Beschränkungen unterliegen, sind nicht zulässig. Beispiel: Trockeneis, Lithium-Ionen-Batterien. Weitere Informationen erhalten Sie vom FedEx Kundendienst.
- Nationale Sendungen in den USA und außerhalb der USA sind nicht zulässig.
So funktioniert die Freight LTL-API
Dieser Abschnitt beschreibt die Endpunkte und wichtigen Elemente, die für die FedEx Freight LTL-API erforderlich sind.
Hinweis: Ihr FedEx Freight LTL-Konto muss zur Verwendung der FedEx Freight LTL-API eingerichtet sein. Die erforderlichen wichtigen Informationen zur Verarbeitung von LTL-Sendungen sind die FedEx Freight Kontonummer(n) und die korrekte mit dem Konto verknüpfte Postanschrift.
Im Folgenden sind die Endpunkte aufgeführt, die mit dieser API verfügbar sind:
Freight LTL-Versand
Verwenden Sie diesen Endpunkt, um FedEx Freight LTL-Sendungen zu prüfen und zu erstellen.
Die für diese Abfrage erforderlichen Eingabedaten sind:
- Frachtkontonummer
- Mit dem Konto verknüpfte Postanschrift
- Angeforderte Frachtsendung
- Optionen für die Etiketten-Bereitstellung: Bereitstellung von verschlüsselten Etiketten oder URLs
- Master-Sendungsverfolgungsdetails: nur für den Fall, dass die MPS-Sendung verarbeitet werden muss und die Etiketten einzeln gedruckt werden müssen und nicht gleichzeitig gedruckt werden können (wenn das Element singleShotMPS nicht angegeben oder mit dem Wert false hinzugefügt wird)
Ist die Anfrage erfolgreich, wird eine LTL-Sendung erstellt und Details zur Sendungsverfolgung sowie Hinweisdetails werden zurückgegeben. Schlägt die Abfrage fehl, werden Fehler und entsprechende Beschreibungen zurückgegeben.
Hinweis: Die Postanschrift kann von der tatsächlichen Versandadresse abweichen.
Verfügbarkeit von Freight LTL-Abholung prüfen
Verwenden Sie diesen Endpunkt, um eine Liste aller verfügbaren Stationen für Frachtabholungen mit Angaben zu den Abholterminen abzurufen, darunter Frachtführer, letzte verfügbare Zeit der Abholung, den standardmäßigen letztmöglichen Zeitpunkt, die Verfügbarkeit für die Abholung, den Zeitpunkt, zu dem das Paket zur Abholung bereit steht, die Angabe, ob es sich bei der Adresse um eine Privatadresse handelt, den letztmöglichen Abholtermin und den Zugang des Kuriers zur Abholung des Pakets.
Die für diese Abfrage erforderlichen Eingabedaten sind:
- Abholadresse/PLZ.
- Abholanfragetyp (z. B.: selber Tag/kommender Tag).
- Abholung im In- oder Ausland.
Hinweis: Verwenden Sie eine korrekte und gültige Abholadresse.
Ist die Anfrage erfolgreich, werden in der Antwort eine Liste aller verfügbaren Stationen für die Frachtabholung, der Zustelltag, die Verfügbarkeit (Markierung), das Abholdatum, der letztmögliche Termin, die Zugangszeit, die Verfügbarkeit für Privatadressen (Markierung), der Geschäftsschluss (Markierung), der Geschäftsschluss und die Ortszeit zurückgegeben. Schlägt die Abfrage fehl, werden Fehler und entsprechende Beschreibungen zurückgegeben.
Freight LTL-Abholung erstellen
Verwenden Sie diesen Endpunkt, um eine Freight LTL-Abholung zu prüfen und zu erstellen.
Die für diese Abfrage erforderlichen Eingabedaten sind:
- Frachtkundennummer, der die Abholung in Rechnung gestellt wird.
- Herkunftsangaben (Adresse, Ort und Abholadresstyp wie Kunde/Absender/Sonstiges).
- Adressdetails für den zugehörigen Kunden.
Ist die Abholanfrage erfolgreich, werden eine Abholbestätigungsnummer, eine Abholbenachrichtigung und ein Standortcode für die geplante Abholung zurückgegeben. Schlägt die Abfrage fehl, werden Fehler und entsprechende Beschreibungen zurückgegeben.
Hinweis: Verwenden Sie eine gültige Abholadresse sowie eine gültige Kundenadresse, um die Abholung zu planen. Bei der Planung einer Abholung darf weder ein Bereitstellungstermin/Datum eingegeben werden, welches in der Vergangenheit liegt, noch ein Datum, das zu weit in der Zukunft liegt. Anonyme Abholungen sind nicht zulässig. Sie können eine Abholung über ein externes Konto buchen, indem Sie eine alternative gültige Adressdaten angeben.
Freight LTL-Abholung stornieren
Verwenden Sie diesen Endpunkt, um eine bereits geplante Abholung eines LTL-Pakets zu stornieren. Ist die Stornierung der Abholung erfolgreich, werden eine Bestätigungsnummer und eine Benachrichtigung über die Stornierung der Abholung zurückgegeben.
Die für diese Abfrage erforderlichen Eingabedaten sind:
- Abholbestätigungscode (bei Übermittlung der Abholanfrage erhalten)
- Geplantes Datum (Datum des Sendungsabholung)
- Station (FedEx Express Station, die für die Bearbeitung der Abholanfrage zuständig ist)
Ist die Anfrage erfolgreich, werden eine Abholbestätigungsnummer, eine Abholbenachrichtigung und ein Stationscode für die geplante Abholung zurückgegeben. Schlägt die Abfrage fehl, werden Fehler und entsprechende Beschreibungen zurückgegeben.
Hinweis: Übermitteln Sie die Abholbestätigungsnummer und den entsprechenden Stationscode (gilt nur für FDXE), um die geplante Abholung zu stornieren. Die Abholbestätigungsnummer und der zugehörige Stationscode (gilt nur für FDXE) werden bei der Übermittlung einer Abholanfrage abgerufen. Verwenden Sie bei der Stornierung der Abfrage außerdem die korrekte Kundenadresse. Es wird eine Fehlermeldung gesendet, wenn Sie versuchen, eine Abholung zu stornieren und der FedEx Kurier bereits unterwegs zum Abholort ist.
Freight LTL-Rate
Verwenden Sie diesen Endpunkt, um eine Liste anzufordern, die alle Frachtratenauskünfte sowie optionale Laufzeitinformationen enthält, die anhand der Eingabedaten ermittelt wurden. Die abgerufenen Raten basieren auf dem Ursprungs- und dem Bestimmungsort sowie weiteren Eingaben zur Sendung. Zusätzliche Informationen wie Frachtführercode, Servicetyp oder Service können verwendet werden, um die Ergebnisse zu präzisieren.
Die für diese Abfrage erforderlichen Eingabedaten sind:
- Frachtkontonummer
- Angeforderte Frachtsendung
Ist die Anfrage erfolgreich, werden eine Liste aller verfügbaren Raten und ein Stationscode für die geplante Abholung zurückgegeben. Schlägt die Abfrage fehl, werden Fehler und entsprechende Beschreibungen zurückgegeben.
Freight LTL-Mehrpaketsendung (MPS)
Eine Mehrpaketsendung (MPS) besteht aus zwei oder mehr Handling Units, die an dieselben Empfängeradressen versendet werden. Die erste Handling Unit im Sendungsauftrag ist das Master-Paket.
So erstellen Sie eine Mehrpaketsendung:
- Geben Sie Sendungsinformationen wie serviceType, packagingType, totalWeight, totalPackageCount, freightShipmentDetail und requestedPackageLineItems an. [Hinweis: Die sequenceNumber für Master-Paket muss 1 sein.]
- Fügen Sie die Master-Sendungsverfolgungsdetails bei allen nachfolgenden Handling Units im Element masterTrackingId ein, um ein Etikett pro Handling Unit zu drucken.
Im Folgenden sind die mit dieser API verfügbaren Optionen für die Verarbeitung der Mehrpaketsendungen aufgeführt:
Handling-Unit-Etikett einzeln drucken
Mit dieser API können Sie MPS-Sendungen verarbeiten und Etiketten einzeln abrufen.
Ist dies für Ihre Sendung erforderlich, geben Sie zusammen mit den erforderlichen MPS-Elementen das Element oneLabelAtATime als „true“ in der Anfrage an.
Die erste Anfrage gibt das generierte Etikett und die Master-Sendungsverfolgungsnummer zurück. Geben Sie diese Master-Sendungsverfolgungsnummer im Element masterTrackingId an, um nachfolgende Versandaufträge zu verarbeiten und Etiketten mit Sendungsverfolgungsnummern (Child-Sendungsverfolgungsnummern) für die angegebene Gesamtzahl an Paketen (totalPackageCount) zu generieren.
Hinweis: Es sind maximal 200 Handling Units zulässig.
Alle Handling-Unit-Etiketten gleichzeitig drucken
Mit dieser API können Sie Mehrpaketsendungen verarbeiten und alle Etiketten gleichzeitig abrufen. Diese Verarbeitungsmethode wird verwendet, wenn eine Sendung maximal 40 Handling Units (totalPackageCount <= 40) enthält und an dieselbe Empfängeradresse zugestellt werden soll.
Setzen Sie im Sendungsauftrag mit 40 oder weniger Handling Units oneLabelAtATime auf „false“, um die Etiketten unmittelbar zu generieren.
Hinweis: Der Maximalwert von 40 Handling Units ist ein Richtwert und keine feste Grenze. Neben der Anzahl der Handling Units ist der Höchstwert zudem davon abhängig, welche Waren enthalten sind. Weitere Informationen hierzu erhalten Sie von Ihrem FedEx Kundenberater.
Beispiel:: Ihr Sendungsauftrag besteht aus 10 Handling Units. Sobald Sie den Auftrag übermitteln, werden 10 Etiketten generiert und wie angefordert entweder Etiketten-URLs oder Etikettendateien zurückgegeben.
FedEx Freight Direct
Dieser Service ermöglicht Kund*innen ein hervorragendes Erlebnis bei der Zustellung von großen und palettierten Waren, einschließlich der Zustellung von schweren, sperrighen Sendungen innerhalb der Wohnung, des Hauses oder des Unternehmens der Kund*innen.
Der Service bietet Optionen wie proaktive Kommunikation, flexible Zustelloptionen und gebündelte Preise inklusive Servicezuschlägen.
Im Folgenden sind einige der Funktionen aufgeführt, die in diesem Service enthalten sind:
- Erstellen von FedEx Freight Direct Basic-Sendungen, Basic-Sendungen mit Terminzustellung, Standard-Sendungen und Sendungen mit Premium-Zustellung sowie Basic-Rücksendungen/-Abholungen innerhalb der kontinentalen Vereinigten Staaten, Alaska und Hawaii.
- Die Möglichkeit, den voraussichtlichen Preis für eine FedEx Freight Direct Sendung unter Verwendung einer FedEx Freight Direct Kundennummer abzurufen, sowie die Möglichkeit, eine FedEx Freight Direct Abholung zu stornieren.
- Für Alaska und Hawaii werden keine geschätzten Versandraten zurückgegeben. Kund*innen können telefonisch beim FedEx Kundendienst ein Angebot für diese Bundesstaaten erfragen.
- Kund*innen müssen, sofern sie eine für denselben Tag geplante Abholung stornieren möchten, den FedEx Kundendienst anrufen.
- Senden von E-Mail-Benachrichtigungen an den*die ursprüngliche*n Versender*in/Empfänger*in. Kund*innen können dann Folgendes:
- Eine Zustellung planen
- Zustellungs- und/oder Abholungsbestätigungen erhalten
- „In Zustellung“- und/oder Abholbenachrichtigungen erhalten
- Benachrichtigungen während der Zustellung erhalten
- An Kundenumfragen über zugestellte Sendungen teilnehmen
- Die Geschäftsregeln für die Überprüfung der Postleitzahl, für Abmessungen, das Stückgewicht und das Gewicht der Handling Unit werden auf FedEx Freight Direct angewendet, um die richtige Kombination von Line-Haul- und First-/Last-Miles-Services zu bestimmen.
FedEx Freight Direct bietet verschiedene Servicearten zur Auswahl an.
Diese API stellt folgende Funktionen beim Freight Direct-Service bereit:
Freight Direct-Versandkosten abrufen
Verwenden Sie diesen Endpunkt, um die Freight Direct-Versandkosten und -Zuschläge für die folgenden Special-Service-Optionen von Freight Direct abzurufen: Basic Service, Basic Service nach Vereinbarung, Standard Service, Premium Service.
Im Folgenden finden Sie die erforderlichen Angaben, die zusammen mit der Versandkostenanfrage über den Endpunkt „Freight LTL-Rate“ gesendet werden müssen:
- Freight Direct-Typ (BASIC, BASIC_BY_APPOINTMENT, PREMIUM, STANDARD)
- Freight Direct Transportation-Typ (DELIVERY, PICKUP)
- Telefonnummer-Typ, sofern eine Telefonnummer bereitgestellt wird (HOME, MOBILE, WORK)
- Gewicht
- Abmessungen (nicht negative Länge, Breite und Höhe)
Freight Direct-Sendung erstellen
Verwenden Sie diesen Endpunkt, um eine Einpaket- oder Mehrpaketsendung für die folgenden Special-Service-Optionen von Freight Direct zu versenden: Basic Service, Basic Service nach Vereinbarung, Standard Service, Premium Service. Sie erhalten ein Versandetikett oder einen Frachtbrief, einschließlich der erforderlichen Dokumentation für die Bearbeitung einer Freight Priority-Sendung.
Im Folgenden finden Sie die erforderlichen Angaben, die zusammen mit der Sendungsanfrage über den Endpunkt „Freight LTL-Versand“ gesendet werden müssen:
- Freight Direct-Typ (BASIC, BASIC_BY_APPOINTMENT, PREMIUM, STANDARD)
- Freight Direct Transportation-Typ (DELIVERY, PICKUP)
- E-Mail-Adresse, Telefonnummer und Telefontyp
- Gewicht
- Abmessungen (nicht negative Länge, Breite und Höhe)
Auf dem ausgehenden Frachtbrief stehen die Freight Direct-Servicenamen. Im Folgenden sind die Werte aufgeführt, die je nach Serviceauswahl auf dem Frachtbrief stehen:
- DIRECT BASIC DELIVERY
- DIRECT BASIC BY APPOINTMENT DELIVERY
- DIRECT PREMIUM DELIVERY
- DIRECT STANDARD DELIVERY
- DIRECT BASIC PICKUP
- DIRECT BASIC BY APPOINTMENT PICKUP
- DIRECT PREMIUM PICKUP
- DIRECT STANDARD PICKUP
Freight Direct-Abholung
Verwenden Sie diesen Endpunkt, um die Verfügbarkeit des Abholservice von Freight LTL Freight Direct zu prüfen, eine Abholanfrage für ein abzuholendes Paket zu erstellen oder eine bestehende Abholanfrage zu stornieren.
Im Folgenden finden Sie die erforderlichen Angaben, die zusammen mit der Abholanfrage über die Endpunkte „Verfügbarkeit von Freight LTL-Abholung prüfen“, „Freight LTL-Abholung erstellen“ und „Freight LTL-Abholung stornieren“ gesendet werden müssen.
- Freight Direct-Typ (BASIC, BASIC_BY_APPOINTMENT, PREMIUM, STANDARD)
- Freight Direct Transportation-Typ (DELIVERY, PICKUP)
- E-Mail-Adresse (Abholanfrage erstellen)
- Telefonnummer und Telefontyp (Abholanfrage erstellen)
- Gewicht
Geschäftsregeln
- Der ersten Handling Unit einer Freight LTL-Sendung wird eine Master-Sendungsverfolgungsnummer (Pro) zugewiesen und alle nachfolgenden Handling Units erhalten eine Child-Sendungsverfolgungsnummer.
- Jede Handling Unit in der Sendung kann einzeln oder als Teil der gesamten Sendung verfolgt werden.
- Für bestimmte Sendungen sind u. U. weitere Dokumente erforderlich (z. B. bei Gefahrgut [Hazardous Materials, HazMat] und internationalen Frachtsendungen).
- Dem FedEx Developer Portal können nur LTL Fracht-Kundenkonten, nicht jedoch Rechnung an LTL Fracht-Kundenkonten hinzugefügt werden.
- Kund*innen können für Freight Direct-Services entweder die langfristige Kundennummer für einzelne LTL-Sendungen oder die FedEx Freight Direct-Kundennummer verwenden.
- FedEx Freight Direct-Versandkostenfunktionen sind nur in der regulären LTL-API verfügbar.
- Sämtliche neue Fehler/Nachrichten stehen nur auf Englisch zur Verfügung.
- E-Mail-Adresse und Telefonnummer sind beim Erstellen von Sendungen erforderlich, wenn die Serviceoption FedEx Freight Direct genutzt wird.
JSON API-Sammlung
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
- FullSchema
- MinimumSamplePayload
| accountNumber required | object (LTLRootAccountNumber) This is the Account number details.
|
| 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
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "accountNumber": {
- "value": "XXX61073"
- "rateRequestControlParameters": {
- "returnTransitTimes": false,
- "servicesNeededOnRateFailure": true,
- "variableOptions": "FREIGHT_GUARANTEE",
- "rateSortOrder": "SERVICENAMETRADITIONAL"
- "freightRequestedShipment": {
- "shipper": {
- "address": {
- "streetLines": [
- "1550 Union Blvd",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "TN",
- "postalCode": "65247",
- "countryCode": "US",
- "residential": false
- "recipient": {
- "address": {
- "streetLines": [
- "1550 Union Blvd",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "TN",
- "postalCode": "65247",
- "countryCode": "US",
- "residential": false
- "serviceType": "FEDEX_FREIGHT_PRIORITY",
- "preferredCurrency": "USD",
- "shippingChargesPayment": {
- "payor": {
- "responsibleParty": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": "phone extension",
- "companyName": "Fedex",
- "faxNumber": "fax number"
- "accountNumber": {
- "value": "123456789"
- "paymentType": "SENDER"
- "rateRequestType": [
- "LIST"
- "shipDateStamp": "2019-09-06",
- "requestedPackageLineItems": [
- {
- "subPackagingType": "BAG",
- "groupPackageCount": 1,
- "contentRecord": [
- {
- "itemNumber": "string",
- "receivedQuantity": 0,
- "description": "string",
- "partNumber": "string"
- "declaredValue": {
- "amount": "100",
- "currency": "USD"
- "weight": {
- "units": "KG",
- "value": 68.25
- "dimensions": {
- "length": 10,
- "width": 8,
- "height": 2,
- "units": "IN"
- "associatedFreightLineItems": [
- {
- "id": "string"
- "totalPackageCount": 3,
- "totalWeight": 87,
- "freightShipmentDetail": {
- "role": "CONSIGNEE",
- "accountNumber": {
- "value": "XXXXX6789"
- "declaredValueUnits": "string",
- "shipmentDimensions": {
- "length": 10,
- "width": 8,
- "height": 2,
- "units": "IN"
- "lineItem": [
- {
- "handlingUnits": 0,
- "nmfcCode": "string",
- "subPackagingType": "BAG",
- "description": "string",
- "weight": {
- "units": "KG",
- "value": 68.25
- "pieces": 0,
- "volume": {
- "units": "CUBIC_FT",
- "value": 0
- "freightClass": "CLASS_050",
- "purchaseOrderNumber": "string",
- "id": "string",
- "hazardousMaterials": "HAZARDOUS_MATERIALS",
- "dimensions": {
- "length": 10,
- "width": 8,
- "height": 2,
- "units": "IN"
- "clientDiscountPercent": 0,
- "fedExFreightBillingContactAndAddress": {
- "address": {
- "streetLines": [
- "string",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "string",
- "postalCode": "string",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "person name",
- "emailAddress": "email address",
- "phoneNumber": "phone number",
- "phoneExtension": "phone extension",
- "companyName": "company name",
- "faxNumber": "fax number"
- "aliasID": "string",
- "hazardousMaterialsOfferor": "string",
- "declaredValuePerUnit": {
- "amount": "100",
- "currency": "USD"
- "totalHandlingUnits": 0,
- "alternateBillingParty": {
- "address": {
- "streetLines": [
- "1550 Union Blvd",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "TN",
- "postalCode": "65247",
- "countryCode": "US",
- "residential": false
- "accountNumber": {
- "value": "XXX61073"
- "freightShipmentSpecialServices": {
- "freightGuaranteeDetail": {
- "freightGuaranteeType": "GUARANTEED_DATE",
- "guaranteeTimestamp": "string"
- "specialServiceTypes": [
- "FREIGHT_GUARANTEE"
- "freightDirectDetail": {
- "freightDirectDataDetails": [
- {
- "type": "STANDARD",
- "transportationType": "DELIVERY",
- "emailAddress": "abc@def.com",
- "phoneNumberDetails": [
- {
- "phoneNumberType": "MOBILE",
- "phoneNumber": "XXXXXXXXX12"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "transactionId": "63a21b84-ad5c-4da2-b788-f615e5cafaa3",
- "output": {
- "alerts": [
- {
- "code": "MIXED.MEASURING.UNITS.INCLUDED",
- "message": "Package 1 - Mixed measuring units are provided for weight and dimensions.",
- "alertType": "WARNING",
- "parameterList": [
- {
- "key": "Package Index",
- "value": "1"
- "rateReplyDetails": [
- {
- "serviceType": "FEDEX_FREIGHT_PRIORITY",
- "commit": {
- "dateDetail": {
- "dayOfWeek": "Fri",
- "dayFormat": "2020-12-04T17:00:00-06:00"
- "transitDays": {
- "minimumTransitTime": "TWO_DAYS",
- "description": "2 Business Days"
- "saturdayDelivery": false
- "ratedShipmentDetails": [
- {
- "quoteNumber": "1100739606",
- "rateType": "ACCOUNT",
- "freightChargeBasis": "MINIMUM",
- "ratedWeightMethod": "FREIGHT_MINIMUM",
- "totalDiscounts": 0,
- "totalBaseCharge": 805,
- "totalNetCharge": 996.59,
- "totalNetFedExCharge": 996.59,
- "shipmentLegRateDetails": [
- {
- "rateScale": "*FXF PZONE 01/04/21 LD 11122",
- "totalBaseCharge": 0,
- "totalNetCharge": 996.59
- "shipmentRateDetail": {
- "dimDivisor": 0,
- "fuelSurchargePercent": 23.8,
- "totalSurcharges": 191.59,
- "totalFreightDiscount": 0,
- "surCharges": [
- {
- "type": "FUEL",
- "description": "Fuel Surcharge",
- "level": "SHIPMENT",
- "amount": 191.59
- "totalBillingWeight": {
- "units": "LB",
- "value": 331
- "totalDimWeight": {
- "units": "LB",
- "value": 0
- "currency": "USD",
- "rateScale": "*FXF PZONE 01/04/21 LD 11122"
- "currency": "USD"
- "operationalDetail": {
- "originLocationNumbers": [ ],
- "deliveryDate": "2020-12-04T17:00:00-06:00",
- "deliveryDay": "FRI",
- "commitDate": "2020-12-04T17:00:00-06:00",
- "commitDays": [
- "FRI"
- "transitTime": "TWO_DAYS",
- "ineligibleForMoneyBackGuarantee": true
- "freightTransitLocationDetail": {
- "originLocation": {
- "contactAndAddress": {
- "contact": {
- "personName": "DAWN THIELHART",
- "phoneNumber": "800-218-6293"
- "address": {
- "streetLines": [
- "6952 E HILLSBOROUGH AVE",
- ""
- "city": "TAMPA",
- "stateOrProvinceCode": "FL",
- "postalCode": "33610-4136",
- "countryCode": "US",
- "residential": false
- "locationId": "TPA"
- "destinationLocation": {
- "contactAndAddress": {
- "contact": {
- "personName": "TED CLAY",
- "phoneNumber": "214-333-4544"
- "address": {
- "streetLines": [
- "1501 N WALTON WALKER BLVD",
- ""
- "city": "DALLAS",
- "stateOrProvinceCode": "TX",
- "postalCode": "75211",
- "countryCode": "US",
- "residential": false
- "locationId": "SDA"
- "distance": {
- "units": "MI",
- "value": 1139
- "quoteDate": "2020-12-02",
- "encoded": false
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
- 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.
|
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "freightRequestedShipment": {
- "shipDatestamp": "2019-10-14",
- "pickupType": "USE_SCHEDULED_PICKUP",
- "serviceType": "FEDEX_FREIGHT_ECONOMY",
- "packagingType": "YOUR_PACKAGING",
- "totalWeight": 20,
- "preferredCurrency": "USD",
- "shipper": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": 91,
- "companyName": "Fedex",
- "faxNumber": "1234567",
- "stateTaxId": "1234567",
- "fedralTaxId": "11-N-1745"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "recipient": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": 91,
- "companyName": "Fedex",
- "faxNumber": "1234567",
- "stateTaxId": "1234567",
- "fedralTaxId": "11-N-1645"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "deliveryInstructions": "delivery instructions"
- "soldTo": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneExtension": "91",
- "phoneNumber": "1234567890",
- "companyName": "Fedex"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "accountNumber": {
- "value": "XXXXX6789"
- "origin": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "person name",
- "emailAddress": "email address",
- "phoneNumber": "phone number",
- "phoneExtension": "phone extension",
- "companyName": "company name",
- "faxNumber": "fax number"
- "shippingChargesPayment": {
- "paymentType": "SENDER",
- "payor": {
- "responsibleParty": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": "phone extension",
- "companyName": "Fedex",
- "faxNumber": "fax number",
- "stateTaxId": "state tax identifier",
- "fedralTaxId": "11-N-1745"
- "accountNumber": {
- "value": "801472842"
- "billingDetails": {
- "billingCode": "123876",
- "billingType": "billingType",
- "aliasId": "aliasId",
- "accountNickname": "accountNickname",
- "accountNumber": "801472842",
- "accountNumberCountryCode": "US"
- "freightShipmentSpecialServices": {
- "specialServiceTypes": [
- "THIRD_PARTY_CONSIGNEE",
- "PROTECTION_FROM_FREEZING"
- "freightGuaranteeDetail": {
- "freightGuaranteeType": "GUARANTEED_DATE",
- "guaranteeTimestamp": "2009-12-04"
- "freightDirectDetail": {
- "freightDirectDataDetails": [
- {
- "type": "STANDARD",
- "transportationType": "DELIVERY",
- "emailAddress": "abc@def.com",
- "phoneNumberDetails": [
- {
- "phoneNumberType": "MOBILE",
- "phoneNumber": "XXXXXXXXX12"
- "customDeliveryWindowDetail": {
- "requestDate": "2023-05-15",
- "requestTime": "10:00:00",
- "requestRange": {
- "begins": "12-01-2020",
- "ends": "22-01-2020"
- "type": "AFTER"
- "emailNotificationDetail": {
- "aggregationType": "PER_PACKAGE",
- "emailNotificationRecipients": [
- {
- "name": "Joe Smith",
- "emailNotificationRecipientType": "SHIPPER",
- "emailAddress": "jsmith3@aol.com",
- "notificationFormatType": "TEXT",
- "notificationType": "EMAIL",
- "locale": "en_US",
- "notificationEventType": [
- "ON_PICKUP_DRIVER_ARRIVED",
- "ON_SHIPMENT"
- "personalMessage": "your personal message here"
- "freightShipmentDetail": {
- "role": "CONSIGNEE",
- "specialServicePayments": [
- {
- "specialService": "Special Service",
- "paymentType": "COLLECT"
- "liabilityCoverageDetail": {
- "coverageType": "USED_OR_RECONDITIONED",
- "coverageAmount": {
- "amount": 12.45,
- "currency": "USD"
- "fedExFreightAccountNumber": {
- "value": "Your account number"
- "declaredValueUnits": "LBS",
- "printedReferences": [
- {
- "printedReferenceType": "BILL_OF_LADING",
- "value": "1"
- "hazardousMaterialsEmergencyContactNumber": {
- "areaCode": "901",
- "localNumber": "3575012",
- "extension": "200",
- "countryCode": "US",
- "personalIdentificationNumber": "98712345"
- "lineItem": [
- {
- "handlingUnits": 12,
- "nmfcCode": "nmfcCode",
- "subPackagingType": "BUNDLE",
- "description": "description",
- "weight": {
- "units": "KG",
- "value": 68.25
- "pieces": 12,
- "volume": {
- "units": "CUBIC_FT",
- "value": 9.965781217890562
- "freightClass": "CLASS_050",
- "purchaseOrderNumber": "50",
- "id": "123",
- "hazardousMaterials": "HAZARDOUS_MATERIALS",
- "dimensions": {
- "length": 25,
- "width": 10,
- "height": 12,
- "units": "IN"
- "classProvidedByCustomer": true
- "clientDiscountPercent": 5.12,
- "coupons": [
- "coupons"
- "fedExFreightBillingContactAndAddress": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "person name",
- "emailAddress": "email address",
- "phoneNumber": "phone number",
- "phoneExtension": "phone extension",
- "companyName": "company name",
- "faxNumber": "fax number"
- "aliasID": "981234",
- "collectTermsType": "NON_RECOURSE_SHIPPER_SIGNED",
- "hazardousMaterialsOfferor": "offeror",
- "declaredValuePerUnit": {
- "amount": 12.45,
- "currency": "USD"
- "totalHandlingUnits": 12,
- "alternateBillingParty": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneExtension": "000",
- "phoneNumber": "XXX2345671",
- "companyName": "Fedex"
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "variableHandlingChargeDetail": {
- "rateType": "PREFERRED_CURRENCY",
- "percentValue": 12.45,
- "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
- "fixedValue": {
- "amount": 24.45,
- "currency": "USD"
- "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
- "customsClearanceDetail": {
- "regulatoryControls": [
- "NOT_IN_FREE_CIRCULATION",
- "USMCA"
- "brokers": [
- {
- "broker": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": 91,
- "companyName": "Fedex",
- "faxNumber": 1234567
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "number",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "deliveryInstructions": "deliveryInstructions"
- "type": "IMPORT"
- "commercialInvoice": {
- "originatorName": "originator Name",
- "comments": [
- "optional comments for the commercial invoice"
- "customerReferences": [
- {
- "customerReferenceType": "INVOICE_NUMBER",
- "value": "3686"
- "taxesOrMiscellaneousCharge": {
- "amount": 12.45,
- "currency": "USD"
- "taxesOrMiscellaneousChargeType": "COMMISSIONS",
- "freightCharge": {
- "amount": 12.45,
- "currency": "USD"
- "packingCosts": {
- "amount": 12.45,
- "currency": "USD"
- "handlingCosts": {
- "amount": 12.45,
- "currency": "USD"
- "declarationStatement": "declarationStatement",
- "termsOfSale": "FCA",
- "specialInstructions": "specialInstructions\"",
- "shipmentPurpose": "REPAIR_AND_RETURN",
- "emailNotificationDetail": {
- "emailAddress": "neena@fedex.com",
- "type": "EMAILED",
- "recipientType": "SHIPPER"
- "freightOnValue": "OWN_RISK",
- "dutiesPayment": {
- "payor": {
- "responsibleParty": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": "phone extension",
- "companyName": "Fedex",
- "faxNumber": "fax number"
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "number",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- {
- "number": "number",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "billingDetails": {
- "billingCode": "billingCode",
- "billingType": "billingType",
- "aliasId": "aliasId",
- "accountNickname": "accountNickname",
- "accountNumber": "Your account number",
- "accountNumberCountryCode": "US"
- "paymentType": "SENDER"
- "commodities": [
- {
- "unitPrice": {
- "amount": 12.45,
- "currency": "USD"
- "additionalMeasures": [
- {
- "quantity": 12.45,
- "units": "KG"
- "numberOfPieces": 12,
- "quantity": 125,
- "quantityUnits": "Ea",
- "customsValue": {
- "amount": 12.45,
- "currency": "USD"
- "countryOfManufacture": "US",
- "cIMarksAndNumbers": "87123",
- "harmonizedCode": "0613",
- "description": "description",
- "name": "non-threaded rivets",
- "weight": {
- "units": "KG",
- "value": 68.25
- "exportLicenseNumber": "26456",
- "exportLicenseExpirationDate": "2025-04-07T07:47:31Z",
- "partNumber": "167",
- "purpose": "BUSINESS",
- "usmcaDetail": {
- "originCriterion": "A"
- "isDocumentOnly": true,
- "recipientCustomsId": {
- "type": "PASSPORT",
- "value": "123"
- "customsOption": {
- "description": "Description",
- "type": "COURTESY_RETURN_LABEL"
- "importerOfRecord": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneExtension": "000",
- "phoneNumber": "XXXX345671",
- "companyName": "Fedex"
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "generatedDocumentLocale": "en_US",
- "exportDetail": {
- "destinationControlDetail": {
- "endUser": "dest country user",
- "statementTypes": "DEPARTMENT_OF_COMMERCE",
- "destinationCountries": [
- "USA",
- "India"
- "b13AFilingOption": "NOT_REQUIRED",
- "exportComplianceStatement": "12345678901234567",
- "permitNumber": "12345"
- "totalCustomsValue": {
- "amount": 12.45,
- "currency": "USD"
- "partiesToTransactionAreRelated": true,
- "declarationStatementDetail": {
- "usmcaLowValueStatementDetail": {
- "countryOfOriginLowValueDocumentRequested": true,
- "customsRole": "EXPORTER"
- "insuranceCharge": {
- "amount": 12.45,
- "currency": "USD"
- "labelSpecification": {
- "labelFormatType": "COMMON2D",
- "labelOrder": "SHIPPING_LABEL_FIRST",
- "customerSpecifiedDetail": {
- "maskedData": [
- "[\"CUSTOMS_VALUE\",\"TOTAL_WEIGHT\"]"
- "regulatoryLabels": [
- {
- "generationOptions": "CONTENT_ON_SHIPPING_LABEL_ONLY",
- "type": "ALCOHOL_SHIPMENT_LABEL"
- "additionalLabels": [
- {
- "type": "CONSIGNEE",
- "count": 1
- "docTabContent": {
- "docTabContentType": "BARCODED",
- "zone001": {
- "docTabZoneSpecifications": [
- {
- "zoneNumber": 0,
- "header": "string",
- "dataField": "string",
- "literalValue": "string",
- "justification": "RIGHT"
- "barcoded": {
- "symbology": "UCC128",
- "specification": {
- "zoneNumber": 0,
- "header": "string",
- "dataField": "string",
- "literalValue": "string",
- "justification": "RIGHT"
- "printedLabelOrigin": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "person name",
- "emailAddress": "email address",
- "phoneNumber": "phone number",
- "phoneExtension": "phone extension",
- "companyName": "company name",
- "faxNumber": "fax number"
- "labelStockType": "PAPER_85X11_TOP_HALF_LABEL",
- "labelRotation": "UPSIDE_DOWN",
- "imageType": "PDF",
- "labelPrintingOrientation": "TOP_EDGE_OF_TEXT_FIRST",
- "returnedDispositionDetail": true,
- "resolution": 300
- "shippingDocumentSpecification": {
- "generalAgencyAgreementDetail": {
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "op900Detail": {
- "customerImageUsages": [
- {
- "id": "IMAGE_5",
- "type": "SIGNATURE",
- "providedImageType": "LETTER_HEAD"
- "signatureName": "Signature Name",
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "usmcaCertificationOfOriginDetail": {
- "customerImageUsages": [
- {
- "id": "IMAGE_5",
- "type": "SIGNATURE",
- "providedImageType": "LETTER_HEAD"
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "certifierSpecification": "EXPORTER",
- "importerSpecification": "UNKNOWN",
- "producerSpecification": "SAME_AS_EXPORTER",
- "producer": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneExtension": "000",
- "phoneNumber": "XXXX345671",
- "companyName": "Fedex"
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "blanketPeriod": {
- "begins": "12-01-2020",
- "ends": "22-01-2020"
- "certifierJobTitle": "Manager"
- "usmcaCommercialInvoiceCertificationOfOriginDetail": {
- "customerImageUsages": [
- {
- "id": "IMAGE_5",
- "type": "SIGNATURE",
- "providedImageType": "LETTER_HEAD"
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "certifierSpecification": "EXPORTER",
- "importerSpecification": "UNKNOWN",
- "producerSpecification": "SAME_AS_EXPORTER",
- "producer": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "90210",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "emailAddress": "sample@company.com",
- "phoneExtension": "000",
- "phoneNumber": "XXXX345671",
- "companyName": "Fedex"
- "accountNumber": {
- "value": "Your account number"
- "tins": [
- {
- "number": "123567",
- "tinType": "FEDERAL",
- "usage": "usage",
- "effectiveDate": "2000-01-23T04:56:07.000+00:00",
- "expirationDate": "2000-01-23T04:56:07.000+00:00"
- "certifierJobTitle": "Manager"
- "shippingDocumentTypes": [
- "RETURN_INSTRUCTIONS",
- "DANGEROUS_GOODS_SHIPPERS_DECLARATION"
- "certificateOfOrigin": {
- "customerImageUsages": [
- {
- "id": "IMAGE_5",
- "type": "SIGNATURE",
- "providedImageType": "LETTER_HEAD"
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "commercialInvoiceDetail": {
- "customerImageUsages": [
- {
- "id": "IMAGE_5",
- "type": "SIGNATURE",
- "providedImageType": "LETTER_HEAD"
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "freightAddressLabelDetail": {
- "copies": 25,
- "documentFormat": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "startingPosition": "BOTTOM_LEFT"
- "freightBillOfLadingDetail": {
- "format": {
- "provideInstructions": true,
- "optionsRequested": {
- "options": [
- "SUPPRESS_ADDITIONAL_LANGUAGES",
- "SHIPPING_LABEL_LAST"
- "stockType": "PAPER_LETTER",
- "dispositions": [
- {
- "eMailDetail": {
- "eMailRecipients": [
- {
- "emailAddress": "email@fedex.com",
- "recipientType": "THIRD_PARTY"
- "locale": "en_US",
- "grouping": "NONE"
- "dispositionType": "CONFIRMED"
- "locale": "en_US",
- "docType": "PDF"
- "rateRequestType": [
- "LIST",
- "PREFERRED"
- "totalPackageCount": 25,
- "masterTrackingId": {
- "formId": "0201",
- "trackingIdType": "EXPRESS",
- "uspsApplicationId": "92",
- "trackingNumber": "49092000070120032835"
- "requestedPackageLineItems": [
- {
- "sequenceNumber": "1",
- "subPackagingType": "BUCKET",
- "customerReferences": [
- {
- "customerReferenceType": "INVOICE_NUMBER",
- "value": "3686"
- "declaredValue": {
- "amount": 12.45,
- "currency": "USD"
- "weight": {
- "units": "KG",
- "value": 68.25
- "dimensions": {
- "length": 100,
- "width": 50,
- "height": 30,
- "units": "CM"
- "physicalPackaging": "class line",
- "groupPackageCount": 25,
- "itemDescriptionForClearance": "description",
- "contentRecord": [
- {
- "itemNumber": "2876",
- "receivedQuantity": 256,
- "description": "Description",
- "partNumber": "456"
- "itemDescription": "item description for the package",
- "variableHandlingChargeDetail": {
- "rateType": "PREFERRED_CURRENCY",
- "percentValue": 12.45,
- "rateLevelType": "INDIVIDUAL_PACKAGE_RATE",
- "fixedValue": {
- "amount": 24.45,
- "currency": "USD"
- "rateElementBasis": "NET_CHARGE_EXCLUDING_TAXES"
- "associatedFreightLineItems": [
- {
- "id": "98712345"
- "labelResponseOptions": "LABEL",
- "accountNumber": {
- "value": "Your account number"
- "oneLabelAtATime": true
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b55xxxxx492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "transactionShipments": [
- {
- "serviceType": "FEDEX_FREIGHT_ECONOMY",
- "shipDatestamp": "2010-03-04",
- "serviceCategory": "FREIGHT",
- "shipmentDocuments": [
- {
- "contentKey": "content key",
- "copiesToPrint": 10,
- "contentType": "COMMERCIAL_INVOICE",
- "trackingNumber": "794953535000",
- "docType": "PDF",
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
- "encodedLabel": "encoded label",
- "pieceResponses": [
- {
- "netChargeAmount": 21.45,
- "transactionDetails": [
- {
- "transactionDetails": "transactionDetails",
- "transactionId": "12345"
- "packageDocuments": [
- {
- "contentKey": "content key",
- "copiesToPrint": 10,
- "contentType": "COMMERCIAL_INVOICE",
- "trackingNumber": "794953535000",
- "docType": "PDF",
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
- "encodedLabel": "encoded label",
- "acceptanceTrackingNumber": "794953535000",
- "serviceCategory": "EXPRESS",
- "listCustomerTotalCharge": "listCustomerTotalCharge",
- "deliveryTimestamp": "2012-09-23",
- "trackingIdType": "FEDEX",
- "additionalChargesDiscount": 621.45,
- "netListRateAmount": 1.45,
- "baseRateAmount": 321.45,
- "packageSequenceNumber": 215,
- "netDiscountAmount": 121.45,
- "masterTrackingNumber": "794953535000",
- "acceptanceType": "acceptanceType",
- "trackingNumber": "794953535000",
- "successful": true,
- "customerReferences": [
- {
- "customerReferenceType": "INVOICE_NUMBER",
- "value": "3686"
- "serviceName": "FedEx Freight® Economy",
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
- "completedShipmentDetail": {
- "completedPackageDetails": [
- {
- "sequenceNumber": 256,
- "operationalDetail": {
- "astraHandlingText": "astraHandlingText",
- "barcodes": {
- "binaryBarcodes": [
- {
- "type": "COMMON-2D",
- "value": "string"
- "stringBarcodes": [
- {
- "type": "ADDRESS",
- "value": "1010062512241535917900794953544894"
- "operationalInstructions": [
- {
- "number": 17,
- "content": "content"
- "signatureOption": "DIRECT",
- "trackingIds": [
- {
- "formId": "0201",
- "trackingIdType": "EXPRESS",
- "uspsApplicationId": "92",
- "trackingNumber": "49092000070120032835"
- "groupNumber": 567,
- "oversizeClass": "OVERSIZE_1, OVERSIZE_2, OVERSIZE_3",
- "packageRating": {
- "effectiveNetDiscount": 0,
- "actualRateType": "PAYOR_ACCOUNT_PACKAGE",
- "packageRateDetails": [
- {
- "ratedWeightMethod": "DIM",
- "totalFreightDiscounts": 44.55,
- "totalTaxes": 3.45,
- "minimumChargeType": "minimumChargeType",
- "baseCharge": 45.67,
- "totalRebates": 4.56,
- "rateType": "PAYOR_RETAIL_PACKAGE",
- "billingWeight": {
- "units": "KG",
- "value": 68
- "netFreight": 4.89,
- "surcharges": [
- {
- "amount": null,
- "surchargeType": "APPOINTMENT_DELIVERY",
- "level": "PACKAGE, or SHIPMENT",
- "description": "description"
- "totalSurcharges": 22.56,
- "netFedExCharge": 12.56,
- "netCharge": 121.56,
- "currency": "USD"
- "dryIceWeight": {
- "units": "KG",
- "value": 68
- "hazardousPackageDetail": {
- "regulation": "IATA",
- "accessibility": "ACCESSIBLE",
- "labelType": "II_YELLOW",
- "containers": [
- {
- "qvalue": 2,
- "hazardousCommodities": [
- {
- "quantity": {
- "quantityType": "GROSS",
- "amount": 24.56,
- "units": "Kg"
- "options": {
- "quantity": {
- "quantityType": "GROSS",
- "amount": 24.56,
- "units": "Kg"
- "innerReceptacles": [
- {
- "quantity": {
- "quantityType": "NET",
- "amount": 34.56,
- "units": "Kg"
- "options": {
- "labelTextOption": "APPEND",
- "customerSuppliedLabelText": "Customer Supplied Label Text."
- "description": {
- "sequenceNumber": 9812,
- "processingOptions": [
- "INCLUDE_SPECIAL_PROVISIONS"
- "subsidiaryClasses": [
- "Subsidiary Classes"
- "labelText": "labelText",
- "technicalName": "technicalName",
- "packingDetails": {
- "packingInstructions": "packing Instructions",
- "cargoAircraftOnly": true
- "authorization": "authorization",
- "reportableQuantity": true,
- "percentage": 12.45,
- "id": "123",
- "packingGroup": "I",
- "properShippingName": "properShippingName",
- "hazardClass": "hazard Class"
- "description": {
- "sequenceNumber": 876,
- "packingInstructions": "packingInstructions",
- "subsidiaryClasses": [
- "Subsidiary Classes"
- "labelText": "labelText",
- "tunnelRestrictionCode": "UN2919",
- "specialProvisions": "specialProvisions",
- "properShippingNameAndDescription": "properShippingNameAndDescription",
- "technicalName": "technicalName",
- "symbols": "symbols",
- "authorization": "authorization",
- "attributes": [
- "attributes"
- "id": "1234",
- "packingGroup": "packingGroup",
- "properShippingName": "properShippingName",
- "hazardClass": "hazardClass"
- "netExplosiveDetail": {
- "amount": 10,
- "units": "units",
- "type": "NET_EXPLOSIVE_WEIGHT"
- "massPoints": 2
- "cargoAircraftOnly": true,
- "referenceId": "123456",
- "radioactiveTransportIndex": 2.45
- "operationalDetail": {
- "originServiceArea": "A1",
- "serviceCode": "010",
- "airportId": "DFW",
- "postalCode": "38010",
- "scac": "scac",
- "deliveryDay": "TUE",
- "originLocationId": "678",
- "countryCode": "US",
- "astraDescription": "SMART POST",
- "originLocationNumber": 243,
- "deliveryDate": "2001-04-05",
- "deliveryEligibilities": [
- "deliveryEligibilities"
- "ineligibleForMoneyBackGuarantee": true,
- "maximumTransitTime": "SEVEN_DAYS",
- "destinationLocationStateOrProvinceCode": "GA",
- "astraPlannedServiceLevel": "TUE - 15 OCT 10:30A",
- "destinationLocationId": "DALA",
- "transitTime": "TWO_DAYS",
- "stateOrProvinceCode": "GA",
- "destinationLocationNumber": 876,
- "packagingCode": "03",
- "commitDate": "2019-10-15",
- "publishedDeliveryTime": "10:30A",
- "ursaSuffixCode": "Ga",
- "ursaPrefixCode": "XH",
- "destinationServiceArea": "A1",
- "commitDay": "TUE",
- "customTransitTime": "ONE_DAY"
- "carrierCode": "FDXE",
- "completedHoldAtLocationDetail": {
- "holdingLocationType": "FEDEX_STAFFED",
- "holdingLocation": {
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false
- "contact": {
- "personName": "John Taylor",
- "tollFreePhoneNumber": "6127812",
- "emailAddress": "sample@company.com",
- "phoneNumber": "1234567890",
- "phoneExtension": "91",
- "faxNumber": "1234567890",
- "pagerNumber": "6127812",
- "companyName": "Fedex",
- "title": "title"
- "completedEtdDetail": {
- "folderId": "0b0493e580dc1a1b",
- "type": "COMMERCIAL_INVOICE",
- "uploadDocumentReferenceDetails": [
- {
- "documentType": "PRO_FORMA_INVOICE",
- "documentReference": "DocumentReference",
- "description": "PRO FORMA INVOICE",
- "documentId": "090927d680038c61"
- "packagingDescription": "description",
- "masterTrackingId": {
- "formId": "0201",
- "trackingIdType": "EXPRESS",
- "uspsApplicationId": "92",
- "trackingNumber": "49092000070120032835"
- "serviceDescription": {
- "serviceType": "FEDEX_1_DAY_FREIGHT",
- "code": "80",
- "names": [
- {
- "type": "long",
- "encoding": "UTF-8",
- "value": "F-2"
- "operatingOrgCodes": [
- "FXE"
- "astraDescription": "2 DAY FRT",
- "description": "description",
- "serviceId": "EP1000000027",
- "serviceCategory": "freight"
- "usDomestic": true,
- "hazardousShipmentDetail": {
- "hazardousSummaryDetail": {
- "smallQuantityExceptionPackageCount": 10
- "adrLicense": {
- "licenseOrPermitDetail": {
- "number": "12345",
- "effectiveDate": "2019-08-09",
- "expirationDate": "2019-04-09"
- "dryIceDetail": {
- "totalWeight": {
- "units": "KG",
- "value": 68
- "packageCount": 10,
- "processingOptions": {
- "options": [
- "options"
- "shipmentRating": {
- "actualRateType": "PAYOR_LIST_SHIPMENT",
- "shipmentRateDetails": [
- {
- "rateZone": "US001O",
- "ratedWeightMethod": "ACTUAL",
- "totalDutiesTaxesAndFees": 24.56,
- "pricingCode": "LTL_FREIGHT",
- "totalFreightDiscounts": 1.56,
- "totalTaxes": 3.45,
- "totalDutiesAndTaxes": 6.78,
- "totalAncillaryFeesAndTaxes": 5.67,
- "taxes": [
- {
- "amount": 10,
- "level": "level",
- "description": "description",
- "type": "type"
- "totalRebates": 1.98,
- "fuelSurchargePercent": 4.56,
- "currencyExchangeRate": {
- "rate": 25.6,
- "fromCurrency": "Rupee",
- "intoCurrency": "USD"
- "totalNetFreight": 9.56,
- "totalNetFedExCharge": 88.56,
- "shipmentLegRateDetails": [
- {
- "rateZone": "rateZone",
- "pricingCode": "pricingCode",
- "taxes": [
- {
- "amount": 10,
- "level": "level",
- "description": "description",
- "type": "type"
- "totalDimWeight": {
- "units": "KG",
- "value": 68
- "totalRebates": 2,
- "fuelSurchargePercent": 6,
- "currencyExchangeRate": {
- "rate": 25.6,
- "fromCurrency": "Rupee",
- "intoCurrency": "USD"
- "dimDivisor": 6,
- "rateType": "PAYOR_RETAIL_PACKAGE",
- "legDestinationLocationId": "legDestinationLocationId",
- "dimDivisorType": "dimDivisorType",
- "totalBaseCharge": 6,
- "ratedWeightMethod": "ratedWeightMethod",
- "totalFreightDiscounts": 9,
- "totalTaxes": 12.6,
- "minimumChargeType": "minimumChargeType",
- "totalDutiesAndTaxes": 17.78,
- "totalNetFreight": 6,
- "totalNetFedExCharge": 3.2,
- "surcharges": [
- {
- "amount": null,
- "surchargeType": "APPOINTMENT_DELIVERY",
- "level": "PACKAGE, or SHIPMENT",
- "description": "description"
- "totalSurcharges": 5,
- "totalBillingWeight": {
- "units": "KG",
- "value": 68
- "freightDiscounts": [
- {
- "amount": 8.9,
- "rateDiscountType": "COUPON",
- "percent": 28.9,
- "description": "description"
- "rateScale": "6702",
- "totalNetCharge": 253,
- "totalNetChargeWithDutiesAndTaxes": 25.67,
- "currency": "USD"
- "dimDivisor": 0,
- "rateType": "RATED_ACCOUNT_SHIPMENT",
- "surcharges": [
- {
- "amount": null,
- "surchargeType": "APPOINTMENT_DELIVERY",
- "level": "PACKAGE, or SHIPMENT",
- "description": "description"
- "totalSurcharges": 9.88,
- "totalBillingWeight": {
- "units": "KG",
- "value": 68
- "freightDiscounts": [
- {
- "amount": 8.9,
- "rateDiscountType": "COUPON",
- "percent": 28.9,
- "description": "description"
- "rateScale": "00000",
- "totalNetCharge": 3.78,
- "totalBaseCharge": 234.56,
- "totalNetChargeWithDutiesAndTaxes": 222.56,
- "currency": "USD"
- "documentRequirements": {
- "requiredDocuments": [
- "COMMERCIAL_OR_PRO_FORMA_INVOICE",
- "AIR_WAYBILL"
- "prohibitedDocuments": [
- "CERTIFICATE_OF_ORIGIN"
- "generationDetails": [
- {
- "type": "COMMERCIAL_INVOICE",
- "minimumCopiesRequired": 3,
- "letterhead": "OPTIONAL",
- "electronicSignature": "OPTIONAL"
- "exportComplianceStatement": "12345678901234567",
- "accessDetail": {
- "accessorDetails": [
- {
- "password": "password",
- "role": "role",
- "emailLabelUrl": "emailLabelUrl",
- "userId": "userId"
- "shipmentAdvisoryDetails": {
- "regulatoryAdvisory": {
- "commodityClarifications": [
- {
- "commodityIndex": 25,
- "suggestions": [
- {
- "description": "description",
- "harmonizedCode": "harmonized Code"
- "prohibitions": [
- {
- "derivedHarmonizedCode": "01",
- "advisory": {
- "code": "code",
- "text": "Text",
- "parameters": [
- {
- "id": "message ID",
- "value": "Message value"
- "localizedText": "localizedText"
- "commodityIndex": 12,
- "source": "source",
- "categories": [
- "categories"
- "type": "type",
- "waiver": {
- "advisories": [
- {
- "code": "code",
- "text": "Text",
- "parameters": [
- {
- "id": "message ID",
- "value": "Message value"
- "localizedText": "localizedText"
- "description": "description",
- "id": "id"
- "status": "status"
- "masterTrackingNumber": "794953535000"
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
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
- 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. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "pickupAddress": {
- "streetLines": [
- "123 Ship Street"
- "urbanizationCode": "URB FAIR OAKS",
- "city": "Memphis",
- "stateOrProvinceCode": "TN",
- "postalCode": "38017",
- "countryCode": "US",
- "residential": false,
- "addressClassification": "MIXED"
- "packageReadyTime": "15:30:00",
- "customerCloseTime": "18:00:00",
- "shipmentAttributes": {
- "serviceType": "FEDEX_FREIGHT_PRIORITY",
- "weight": {
- "units": "KG",
- "value": 20
- "packagingType": "YOUR_PACKAGING",
- "dimensions": {
- "length": 7,
- "width": 8,
- "units": "CM",
- "height": 9
- "freightPickupSpecialServiceDetail": {
- "shipmentSpecialServicesRequested": {
- "freightGuaranteeDetail": {
- "time": "10:00"
- "freightDirectDetail": {
- "freightDirectDataDetails": [
- {
- "type": "BASIC",
- "transportationType": "DELIVERY",
- "emailAddress": "a@fedex.com",
- "phoneNumberDetails": [
- {
- "phoneNumber": "XXXXXXXX43",
- "phoneNumberType": "WORK"
- "specialServiceTypes": [
- "FOOD",
- "POISON",
- "OVER_LENGTH",
- "EXTREME_LENGTH",
- "LIFTGATE_PICKUP",
- "LIFTGATE_DELIVERY"
- "dispatchDate": "2019-10-14",
- "numberOfBusinessDays": 1
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "closeTime": "12:00:00-05:00",
- "closeTimeType": "DEFAULT",
- "localTime": "19:20",
- "options": [
- {
- "carrier": "FXFR",
- "available": true,
- "pickupDate": "2019-01-20",
- "cutOffTime": "18:30:00",
- "accessTime": {
- "hours": 1,
- "minutes": 30
- "residentialAvailable": true,
- "scheduleDay": "SAME_DAY"
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
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
- 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. |
| remarks | string This is a placeholder for any message to be passed to the FedEx pickup. courier. |
| countryRelationships | string Enum: "DOMESTIC" "INTERNATIONAL" Describes the country relationship among the shipments being picked up. |
| trackingNumber | string This is a tracking number for FedEx packages used for tracking a single package or group of packages. |
| commodityDescription | string Description of the commodity being shipped. |
| 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
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "associatedAccountNumber": {
- "value": "Your account number"
- "originDetail": {
- "pickupAddressType": "ACCOUNT",
- "pickupLocation": {
- "contact": {
- "companyName": "Fedex",
- "personName": "John Taylor",
- "phoneNumber": "7194446666",
- "phoneExtension": "phone extension"
- "address": {
- "streetLines": [
- "123 Ship Street",
- "Suite 302"
- "urbanizationCode": "URB FAIR OAKS",
- "city": "Memphis",
- "stateOrProvinceCode": "TN",
- "postalCode": "38017",
- "countryCode": "US",
- "residential": false,
- "addressClassification": "MIXED"
- "accountNumber": {
- "value": "XXX289837"
- "deliveryInstructions": "deliveryInstructions"
- "readyDateTimestamp": "2020-04-02T11:00:00Z",
- "customerCloseTime": "18:00:00",
- "pickupDateType": "SAME_DAY",
- "packageLocation": "FRONT",
- "buildingPart": "APARTMENT",
- "buildingPartDescription": "111",
- "earlyPickup": false,
- "suppliesRequested": "Supplies requested by customer",
- "geographicalPostalCode": "geographicalPostalCode"
- "totalWeight": [
- {
- "units": "LB",
- "value": 1
- "packageCount": 5,
- "remarks": "Please ring bell at loading dock.",
- "countryRelationships": "DOMESTIC",
- "trackingNumber": "795803657326",
- "commodityDescription": "This field contains CommodityDescription",
- "freightPickupDetail": {
- "accountNumber": {
- "value": "Freight Account Number"
- "role": "SHIPPER",
- "payment": "SENDER",
- "submittedBy": {
- "companyName": "Fedex",
- "personName": "John Taylor",
- "phoneNumber": "7194446666",
- "phoneExtension": "string",
- "emailAddress": "sample@company.com"
- "lineItems": [
- {
- "trackingNumber": {
- "trackingNumber": "123456789012",
- "trackingQualifier": "insightBest~200300400525~FDFR",
- "trackingCarrier": "FDXE",
- "trackingUniqueId": "245822~123456789012~FDEG"
- "service": "FEDEX_FREIGHT_PRIORITY",
- "sequenceNumber": 2,
- "totalHandlingUnits": 2,
- "justOneMore": false,
- "description": "strings",
- "packaging": "BUNDLE",
- "pieces": 4,
- "weight": {
- "units": "KG",
- "value": 68.25
- "dimensions": {
- "length": 7,
- "width": 8,
- "height": 9,
- "units": "CM"
- "destination": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false
- "shipmentSpecialServicesRequested": {
- "freightGuaranteeDetail": {
- "time": "10:00"
- "freightDirectDetail": {
- "freightDirectDataDetails": [
- {
- "type": "BASIC",
- "transportationType": "DELIVERY",
- "emailAddress": "a@fedex.com",
- "phoneNumberDetails": [
- {
- "phoneNumber": "XXXXXXXX43",
- "phoneNumberType": "WORK"
- "specialServiceTypes": [
- "FOOD",
- "POISON",
- "OVER_LENGTH",
- "EXTREME_LENGTH",
- "LIFTGATE_PICKUP",
- "LIFTGATE_DELIVERY"
- "alternateBilling": {
- "contact": {
- "companyName": "Fedex",
- "personName": "John Taylor",
- "phoneNumber": "7194446666",
- "phoneExtension": "phone extension"
- "address": {
- "streetLines": [
- "10 FedEx Parkway",
- "Suite 302"
- "urbanizationCode": "URB FAIR OAKS",
- "city": "Beverly Hills",
- "stateOrProvinceCode": "CA",
- "postalCode": "38127",
- "countryCode": "US",
- "residential": false,
- "addressClassification": "MIXED"
- "accountNumber": {
- "value": "Alternate Billing Account Number"
- "deliveryInstructions": "deliveryInstructions"
- "userMessage": "This is the user message"
- "oversizePackageCount": 2,
- "pickupNotificationDetail": {
- "emailDetails": [
- {
- "address": "sample@gmail.com",
- "locale": "en_US"
- "format": "HTML",
- "userMessage": "This is the user message"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "pickupConfirmationCode": "20201012COS455402",
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
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
- FullSchema-CancelFreightPickup
- MinimumSamplePayload-FreightCancel
| associatedAccountNumber required | object (AccountNumber_2) Specify the FedEx Account number. |
| pickupConfirmationCode required | string The confirmation number provided by FedEx to the customer when the pickup was scheduled or requested. |
| 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. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "associatedAccountNumber": {
- "value": "Your account number"
- "pickupConfirmationCode": "20201007MEM628005",
- "remarks": "This is my remarks",
- "reason": "This is my reason",
- "contactName": "This is my contactName",
- "scheduledDate": "2019-10-15"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "pickupConfirmationCode": "20201007MEM628005",
- "cancelConfirmationMessage": "Requested pickup has been cancelled Successfully.",
- "alerts": [
- {
- "code": "SHIP.RECIPIENT.POSTALCITY.MISMATCH",
- "alertType": "NOTE",
- "message": "Recipient Postal-City Mismatch."
