Freight LTL API
Introduzione
L'API Freight TLT consente di creare spedizioni a carico parziale (LTL). Le spedizioni LTL Freight sono troppo grandi per essere spedite come pacchi ma non abbastanza per riempire un camion intero.
Qui potete ottenere stime sulle tariffe, creare etichette di spedizione per le singole unità di gestione e polizze di carico (ove richieste), prenotare ritiri e monitorare lo stato della spedizione, verificare la disponibilità al ritiro e prenotarne. Ciò significa una maggiore efficienza per le spedizioni più grandi e più pesanti.
Le spedizioni LTL con FedEx Freight offrono monitoraggio a livello di unità e visibilità per le spedizioni con più unità di gestione, ma anche per le spedizioni nazionali prive, nella maggior parte dei casi, di polizza di carico (BOL). Quando richiesto, può essere creata una polizza di carico. Anche se tutte le unità di gestione hanno un numero di tracciabilità univoco, la spedizione si muove su una polizza di carico, ricevuta di consegna ed estratto conto.
Dettagli dell'API Freight LTL
L'API Freight LTL consente di effettuare le spedizioni LTL e di creare i documenti necessari come polizze di carico (ove richiesto), etichette di spedizione FedEx Freight e altri documenti di spedizione di diverso tipo. Nelle spedizioni Freight LTL, l'etichetta principale va sulla prima unità di gestione mentre quella secondaria è applicata alla seconda e alle successive unità di gestione. Le etichette secondarie hanno il proprio numero di monitoraggio univoco, ma fanno riferimento a quello principale. È possibile creare un'unica polizza di carico per spedizione costituita da tutte le unità di gestione e dai colli.
Ogni unità di gestione può essere associata a un numero di monitoraggio; l'etichetta è simile a un'etichetta FedEx Ground o Express Parcel, con l'eccezione di una F, che indica spedizione Freight.
Massimi per unità di gestione e colli per unità di gestione:
- Il numero massimo di colli per unità di gestione è – 9.999
- Numero massimo colli – 200 (se si stampano le etichette una alla volta)
- Numero massimo colli – 40 (se si stampano le etichette contemporaneamente)
Le spedizioni FedEx LTL Freight sono disponibili in tutti i 50 stati, oltre che a Porto Rico, nelle Isole Vergini americane, in Canada e Messico. Alcune spedizioni richiedono una polizza di carico oltre alle etichette di spedizione. Un esempio di queste spedizioni sono quelle contenenti materiali pericolosi.
FedEx Freight® sta cambiando il settore delle LTL velocizzando le spedizioni di merci e rendendole più economiche servendosi di una rete LTL semplificata.
Di seguito vengono descritte le funzioni disponibili nell'API:
- Gestione ritiro LTL Freight
Questa funzione consente di ottenere i luoghi di ritiro di LTL, programmare il ritiro della spedizione e annullare eventuali ritiri già programmati.
- Calcolo delle tariffe Freight LTL
Questa funzione consente di calcolare la tariffa di una spedizione LTL sulla base dei luoghi e delle opzioni di servizio selezionate.
- Invio di spedizioni Freight LTL
Questa funzione consente di creare una spedizione LTL.
L'API Freight LTL presenta le seguenti funzioni:
- Spedizione di una singola unità di una spedizione multicollo per tutti i tipi di servizio, con conseguente creazione di etichette di spedizione o di una polizza di carico (se richiesta).
- Creare una spedizione con più unità di gestione e tenere traccia di ciascuna unità di gestione singolarmente.
- Creazione di spedizioni LTL per l'uso dei servizi FedEx Freight Priority e Freight Economy.
- Comunicazione al destinatario di informazioni come numero di account, referente e indirizzo.
- Comunicazione di marcatura oraria, tipo di imballaggio, peso totale e altri dettagli richiesti come da schema dell'endpoint.
- Fornitura di un'etichetta FedEx con marchio standard e supporto delle dimensioni specificate per le etichette termiche.
- Ricezione di notifiche via email o SMS durante le fasi di spedizione, ad esempio:
- Notifica di spedizione
- Consegna stimata
- Notifica di ritiro
- Generazione di documenti di spedizione come:
- Etichette di spedizione per le singole unità di gestione
- Polizza di carico
- Fattura commerciale
- Fattura per la dogana canadese
- Creazione di spedizioni e stampa di etichette un'unità di gestione alla volta o elaborazione di tutte le unità di gestione contemporaneamente.
- Recupero di tariffe per una spedizione con un unico collo o multicollo, per tutti i tipi di servizio.
- Verifica della disponibilità di ritiro, programmazione ed eventuale annullamento del ritiro.
- Creazione e programmazione del ritiro con Codici Cliente di terze parti per un indirizzo di fatturazione alternativo.
C.O.D. per spedizioni di merci pesanti o voluminose: cessazione del servizio
Il Vettore non fornisce più il servizio C.O.D. (Pagamento in contrassegno) ai Clienti. Il Vettore non è responsabile del ritiro dell'importo del C.O.D. poiché questo non è un servizio fornito dal Vettore. Tutte le spese di deposito, riconsegna e per spedizioni di merci pesanti o voluminose verranno applicate alle spedizioni contrassegnate con C.O.D.
Servizi di spedizione Freight LTL
Sono disponibili i seguenti servizi di spedizione Freight LTL:
FedEx Freight® Priority
Grazia alla puntualità e ai tempi di transito migliori della categoria, FedEx Freight® Priority consegna le vostre spedizioni in modo veloce e affidabile. Potete affidarvi al nostro servizio regionale per consegne ai vostri clienti entro il giorno successivo o due giorni successivi, garantite da una garanzia di rimborso gratuita. *
Funzioni del servizio FedEx Freight® Priority:
- Tempi di transito veloci e servizio con consegna il giorno successivo per destinazioni entro i 965 km ed entro due giorni per destinazioni entro i 2.500 km
- Consegna diretta verso ogni codice di avviamento postale negli Stati Uniti, in Canada e in Messico.
- Affidabilità costante in termini di puntualità
- Garanzia di rimborso gratuita*
- Tecnologia all'avanguardia con visibilità della spedizione dall'inizio alla fine
- Team dedicato di professionisti per dare assistenza nell'abito di tutte le spedizioni regionali
*Tutti i servizi sono soggetti ai termini e alle condizioni delle regole tariffarie della serie FXFR 100.
FedEx Freight Economy
FedEx Freight® Economy offre consegne a carico parziale (LTL) economiche, focalizzate sulle vostre esigenze di spedizione base. Grazie ai servizi di consegna FedEx LTL, il servizio clienti può contare su puntualità affidabile e e un'attenta gestione.
FedEx Freight® Economy offre:
- Soluzioni di spedizione economiche
- Maggiore risparmio per le consegne non urgenti che richiedono comunque una consegna affidabile
- Affidabilità costante in termini di puntualità
- Consegna diretta verso ogni codice di avviamento postale negli Stati Uniti, in Canada, Messico e Porto Rico.
- Tecnologia all'avanguardia con visibilità della spedizione dall'inizio alla fine
- Visibilità migliorata grazie a un monitoraggio della spedizione dall'inizio alla fine
FedEx International Deferred Freight (FDF)
FedEx International Deferred Freight (FDF) è un servizio di spedizione Air Freight globale per effettuare spedizioni internazionali Air Freight con tempi di consegna/transito prolungati a tariffe economiche. FDF è inoltre disponibile per i servizi di consegna Airport-to-Airport, Door-to-Airport, Airport-to-Door e Door-to-Door.
Nota:
- Attualmente, questo servizio è disponibile solo per tratte selezionate da Paese a Paese.
- Le Merci pericolose (MP) e le Merci soggette a restrizioni non sono consentite. Esempio: ghiaccio secco, batterie agli ioni di litio. Contattate l'assistenza clienti FedEx per ulteriori informazioni.
- Le spedizioni nazionali statunitensi e le spedizioni nazionali non statunitensi non sono consentite.
Funzionamento dell'API Freight LTL
Questa sezione descrive gli endpoint e gli elementi chiave richiesti dall'API FedEx Freight LTL.
Il vostro account FedEx Freight LTL deve essere abilitato all'utilizzo dell'API FedEx Freight LTL. Per elaborare le spedizioni LTL, le informazioni chiave richieste sono il/i numero/i di account FedEx Freight e l'indirizzo di posta corretto dell'account.
Di seguito vengono descritti gli endpoint disponibili nell'API:
Spedizioni Freight LTL
Usate questo endpoint per la convalida e la creazione di spedizioni FedEx Freight LTL.
Le informazioni di input richieste associate a questa richiesta sono:
- Codice account Freight
- Indirizzo di posta dell'account
- Spedizione Freight richiesta
- Opzioni per le etichette – Etichette fornite sotto forma di codice o URL.
- Dettagli di monitoraggio master – Solo in caso di elaborazione di spedizione multicollo e di stampa delle etichette una alla volta e non insieme (quando non compare l'elemento singleShotMPS oppure se compare con valore false).
L'esito positivo a questa richiesta genera una spedizione LTL, offre dettagli di monitoraggio e di allerta. In caso di anomalia, genera anche messaggi di errore e le relative descrizioni.
Nota: l'indirizzo di posta può essere diverso dall'indirizzo di spedizione effettivo.
Verifica della disponibilità del ritiro della spedizione LTL Freight
Questo endpoint viene utilizzato per richiedere l'elenco di tutti i luoghi di ritiro disponibili con i relativi dettagli di pianificazione del ritiro, come il vettore, l'ultimo orario disponibile per il ritiro, l'ultimo orario disponibile di default, la disponibilità di ritiro, l'orario in cui la spedizione è pronta al ritiro, l'indicazione di indirizzo di residenza, l'orario dopo il quale non è più possibile il ritiro e l'accesso al ritiro della spedizione da parte dell'autista.
Le informazioni di input richieste associate a questa richiesta sono:
- Indirizzo di ritiro/dettagli postali.
- Tipo di richiesta di ritiro (ad esempio stesso giorno/giorno futuro).
- Ritiro nazionale/internazionale.
Nota: usate un indirizzo di ritiro valido e corretto.
L'esito positivo di questa richiesta offrirà l'elenco di tutti i luoghi di ritiro disponibili, il giorno di consegna, la disponibilità (spunta), la data di ritiro, l'orario massimo di ritiro, la disponibilità di un indirizzo di residenza (spunta), l'orario di chiusura (spunta) e l'ora locale. In caso di anomalia, genera anche messaggi di errore e le relative descrizioni.
Creazione ritiro LTL Freight
Questo endpoint serve a creare e programmare il ritiro di una spedizione.
Le informazioni di input richieste associate a questa richiesta sono:
- Codice account Freight intestatario della fattura di ritiro.
- Dettagli sull'origine (indirizzo, luogo e tipo di indirizzo di ritiro, ad esempio account/mittente/altro).
- Dettagli dell'indirizzo dell'account associato.
L'esito positivo della richiesta di ritiro genera un numero di conferma per il ritiro, una notifica di ritiro e il codice del luogo di ritiro programmato. In caso di anomalia, genera anche messaggi di errore e le relative descrizioni.
Nota: usare un indirizzo valido e corretto per il ritiro e fornire anche l'indirizzo corretto del Codice Cliente per programmare il ritiro. L'orario e la data di programmazione del ritiro non possono essere un orario già passato o una data troppo avanti nel tempo. I ritiri anonimi non sono consentiti. È possibile programmare il ritiro per Codici Cliente di terze parti fornendo dettagli di indirizzo alternativi validi.
Annullamento ritiro LTL Freight
Questo endpoint serve ad annullare eventuali richieste di ritiro di una spedizione LTL già programmate. In caso di esito positivo dell'annullamento del ritiro, verrà fornito un numero di conferma e un messaggio di conferma dell'annullamento del ritiro.
Le informazioni di input richieste associate a questa richiesta sono:
- Codice di conferma del ritiro (si ottiene nell'ambito della richiesta di ritiro)
- Data programmata (data di ritiro della spedizione)
- Luogo (filiale FedEx Express responsabile dell'elaborazione della richiesta di ritiro)
L'esito positivo della richiesta genera un numero di conferma per il ritiro, una notifica di ritiro e il codice del luogo di ritiro programmato. In caso di anomalia, genera anche messaggi di errore e le relative descrizioni.
Nota: per annullare un ritiro programmato sono necessari il numero di conferma del ritiro e il codice del luogo corrispondente (solo per FDXE). Il numero di conferma di ritiro e il codice del luogo corrispondente (solo per FDXE) vengono comunicati all'invio di una richiesta di ritiro. Per annullare il ritiro, è necessario anche l'indirizzo corretto dell'account. Nel caso in cui si cerchi di annullare il ritiro dopo la partenza del vettore FedEX verso il luogo di ritiro, sarà inviata una notifica di errore
Tariffe LTL Freight
Questo endpoint serve per richiedere l'elenco di tutte le tariffe Freight e le informazioni di transito opzionali sulla base dei dettagli inseriti. Le tariffe ottenute si basano sull'origine, la destinazione e le altre informazioni relative alla spedizione. Le informazioni aggiuntive, come il codice vettore, il tipo o l'opzione di servizio, possono servire per ottenere risultati più accurati.
Le informazioni di input richieste associate a questa richiesta sono:
- Codice account Freight
- Spedizione Freight richiesta.
L'esito positivo della richiesta genera un elenco di tutte le tariffe disponibili e il codice del luogo del ritiro programmato. In caso di anomalia, genera anche messaggi di errore e le relative descrizioni.
Spedizione multicollo (MPS) Freight LTL
Una spedizione multicollo comprende due o più colli spediti allo stesso indirizzo destinatario. Il primo collo della richiesta di spedizione è considerato quello principale (master).
Per creare una spedizione multicollo effettuate la seguente procedura.
- Inserite le informazioni a livello di spedizione come serviceType, packagingType, totalWeight, totalPackageCount, freightShipmentDetail e requestedPackageLineItems. [Nota: il valore sequenceNumber del collo principale deve essere pari a 1.]
- Per stampare l'etichetta di ogni unità di gestione, indicate i dettagli di monitoraggio principale alla voce masterTrackingId per tutte le unità di controllo successive.
Di seguito vengono riportate le opzioni di elaborazione della spedizione multicollo disponibili in questa API.
Stampa singola delle etichette dell'unità di gestione
Quest'API permette di elaborare le spedizioni multicollo e ottenere le etichette una alla volta.
Quando è necessario usufruire di questa spedizione, oltre a tutti gli elementi MPS richiesti, fornite anche l'elemento oneLabelAtATime as true nell'ambito della richiesta.
L'output della prima richiesta dovrebbe generare l'etichetta e il numero di monitoraggio, che è il numero di monitoraggio principale. Indicate questo numero nella voce masterTrackingId per elaborare le successive richieste di spedizione e generare etichette con numeri di monitoraggio (numeri di monitoraggio figli) per il numero complessivo di colli (totalPackageCount).
Nota: il numero massimo di unità di gestione consentite è 200.
Stampa simultanea delle etichette dell'unità di gestione
Quest'API permette di elaborare le spedizioni multicollo e ottenere le etichette tutte insieme. Si tratta di un metodo di elaborazione ideale quando la spedizione è composta da massimo 40 unità di gestione (totalPackageCount<=40) destinate a un unico indirizzo di destinazione.
Impostate oneLabelAtATime as false nella richiesta di spedizione indicando al massimo 40 unità di gestione e generate le etichette istantaneamente.
Nota: il limite massimo di 40 unità di gestione è indicativo e non è un limite fisso. Il limite dipende anche dalla combinazione del numero di unità di gestione e dalle merci. Contattate il vostro referente FedEx per maggiori informazioni.
Esempio: se la richiesta di spedizione contiene 10 unità di gestione, una volta inoltrata creerà 10 etichette e verranno forniti gli URL delle etichette o le etichette codificate come richiesto.
FedEx Freight Direct
Questo servizio offre al cliente un'esperienza superiore per la consegna di merci di grandi dimensioni e pallettizzate, compresa la consegna di spedizioni pesanti e ingombranti all'interno delle case o delle aziende dei clienti.
Il servizio offre opzioni come comunicazioni proattive, opzioni di consegna flessibili e tariffe a pacchetto che includono supplementi di servizio.
Di seguito sono elencate alcune delle caratteristiche incluse in questo servizio:
- Consente la creazione di spedizioni FedEx Freight Direct di base, di base per appuntamento, di consegna standard e premium e di spedizioni/ritiri di base negli Stati Uniti continentali, in Alaska e nelle Hawaii.
- Include la possibilità di ottenere una stima completa delle tariffe per una spedizione FedEx Freight Direct utilizzando un codice cliente FedEx Freight Direct e la possibilità di annullare un ritiro FedEx Freight Direct.
- Le tariffe stimate per l'Alaska e le Hawaii non verranno restituite. Per richiedere un preventivo per questi stati, contattate il Servizio Clienti FedEx.
- Per annullare un ritiro programmato per lo stesso giorno, il cliente deve chiamare il servizio clienti FedEx.
- Consente di inviare notifiche via email al mittente/destinatario originale in modo che il cliente possa:
- Programmare una consegna
- Ricevere la conferma della consegna e/o del ritiro
- Ricevere la notifica della consegna e/o del ritiro
- Ricevere notifiche in itinere
- Consultare dei sondaggi tra i clienti per le spedizioni consegnate
- Le regole aziendali di convalida del CAP, dimensioni, peso del collo e peso dell'unità di gestione saranno applicabili a FedEx Freight Direct per determinare la corretta combinazione dei servizi di trasporto di linea e di first/last-mile.
FedEx Freight Direct offre diversi tipi di servizio tra cui scegliere.
Questa API offre le seguenti funzionalità con il servizio Freight Direct:
Calcolo delle tariffe Freight Direct
Utilizzate questo endpoint per ottenere le tariffe e i supplementi di Freight Direct per le seguenti opzioni speciali del servizio Freight Direct: Servizio di base, Servizio di base per appuntamento, Servizio standard, Servizio premium.
Di seguito sono riportati i dettagli necessari da allegare alla richiesta di tariffa utilizzando l'endpoint Rate Freight LTL:
- Tipo di Freight Direct (BASE, BASE_PER_APPUNTAMENTO, PREMIUM, STANDARD)
- Tipo di Trasporto Freight Direct (CONSEGNA, RITIRO)
- Tipo di numero di telefono se fornito (CASA, MOBILE, LAVORO)
- Peso
- Dimensioni (lunghezza, larghezza e altezza non negative)
Creare una spedizione Freight Direct
Utilizzate questo endpoint per spedire un collo singolo o una spedizione multicollo per le seguenti opzioni speciali del servizio Freight Direct: Servizio di base, Servizio di base per appuntamento, Servizio standard, Servizio premium e ottenete un'etichetta di spedizione o una bolla di carico, compresa la documentazione necessaria per l'elaborazione di una spedizione Freight Priority.
Di seguito sono riportati i dettagli necessari da allegare alla richiesta di spedizione tramite l'endpoint Ship Freight LTL:
- Tipo di Freight Direct (BASE, BASE_PER_APPUNTAMENTO, PREMIUM, STANDARD)
- Tipo di Trasporto Freight Direct (CONSEGNA, RITIRO)
- Indirizzo email, numero di telefono e tipo di telefono
- Peso
- Dimensioni (lunghezza, larghezza e altezza non negative)
La polizza di carico in uscita conterrà i nomi dei nuovi servizi Freight Direct. Di seguito sono riportati i valori stampati sulla polizza di carico a seconda della selezione del servizio:
- CONSEGNA DIRECT BASE
- CONSEGNA PER APPUNTAMENTO DIRECT BASE
- CONSEGNA DIRECT PREMIUM
- CONSEGNA DIRECT STANDARD
- RITIRO DIRECT BASE
- RITIRO PER APPUNTAMENTO DIRECT BASE
- RITIRO DIRECT PREMIUM
- RITIRO DIRECT STANDARD
Ritiro Freight Direct
Utilizzate questo endpoint per controllare la disponibilità del servizio di ritiro Freight LTL Freight Direct, creare una richiesta di ritiro per un collo da ritirare o annullare una richiesta di ritiro esistente.
Di seguito sono riportati i dettagli necessari da allegare alla richiesta di ritiro tramite l'endpoint Verifica disponibilità per il ritiro Freight LTL, Crea un ritiro Freight LTL e Annulla ritiro Freight LTL.
- Tipo di Freight Direct (BASE, BASE_PER_APPUNTAMENTO, PREMIUM, STANDARD)
- Tipo di Trasporto Freight Direct (CONSEGNA, RITIRO)
- Indirizzo email (Creazione di una richiesta di ritiro)
- Numero di telefono e tipo di telefono (Creazione di una richiesta di ritiro)
- Peso
Regole aziendali
- Un numero di monitoraggio principale (Pro) viene assegnato alla prima unità di gestione di una spedizione Freight LTL, mentre quelli secondari vengono assegnati a ciascuna unità di gestione successiva.
- È possibile tenere traccia di ciascuna unità di gestione della spedizione singolarmente o come parte dell'intera spedizione.
- Altri documenti possono essere applicati a spedizioni specifiche (ad es. Trasporto di materiali pericolosi [HazMat] e spedizioni internazionali).
- I Codici Cliente solo LTL Freight e con fatturazione a LTL Freight non possono essere aggiunti al FedEx Developer Portal.
- Il cliente può utilizzare il singolo codice cliente LTL a lungo termine o il codice cliente FedEx Freight Direct per utilizzare i servizi Freight Direct.
- Le funzionalità di valutazione di FedEx Freight Direct sono disponibili solo nella normale API LTL.
- Tutti i nuovi errori/messaggi saranno solo in lingua inglese.
- Durante la creazione delle spedizioni, l'indirizzo e-mail e il telefono sono richiesti come parte della richiesta dell'opzione di servizio FedEx Freight Direct.
Ritiro API JSON
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-03-14T22:33:50Z",
- "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."
Response