Developer Portal
Freight LTL API
Giriş
Freight LTL Uygulama Programlama Arayüzü, kamyon yükünden daha az (LTL) gönderiler oluşturmanızı sağlar. LTL kargo, koliyle gönderilen ürünler için fazla büyüktür ancak bütün bir kamyon yükünden daha az yer kaplar.
Bu, fiyat tahminleri almanıza izin verir, bireysel gönderiler için benzersiz gönderi etiketleri ve Konşimentolar (gerekli olması durumunda) oluşturur. Alımları planlamanıza, gönderi durumlarını takip etmenize ve alım uygunluğunu kontrol etmenize olanak tanır. Daha büyük ve ağır gönderileriniz için yüksek verimlilik sağlar.
FedEx Freight'te LTL gönderileri, çoğu durumda kağıda basılı Konşimento (BOL) olmadan yurt içi gönderi yapmanın yanı sıra, birden fazla parçadan oluşan gönderileriniz için de parça başına takip ve görünürlük sunar. Gerekli olması durumunda Konşimento oluşturulabilir. Gönderi içerisindeki parçaların benzersiz bir takip numarası olmasına rağmen, gönderi tek bir Konşimento, Teslimat Makbuzu ve Fatura Beyanı ile gönderilir.
Freight LTL Uygulama Programlama Arayüzü Ayrıntıları
Freight LTL Uygulama Programlama Arayüzü, LTL gönderimini sağlar ve Konşimento (gerekli olması durumunda), FedEx Freight gönderi etiketleri ve diğer farklı gönderi belgeleri gibi gerekli belgeleri oluşturur. Freight LTL Gönderisinde ana etiket, ilk nakliye birimine uygulanır, alt etiket ise ikinci ve sonraki parçalara uygulanır. Alt etiketlerin kendi benzersiz takip numaraları bulunur ancak ana takip numarasına referans verir. Gönderi başına, tüm gönderi parçalarından oluşan tek bir Konşimento oluşturulabilir.
Her gönderi parçası bir takip numarası ile ilişkilendirilebilir ve etiket, bir Kargo gönderisini temsil eden F haricinde FedEx Ground veya Ekspres Koli etiketine benzerdir.
Elleçlenen birim parça adetleri ve bu adetler için maksimum rakamlar:
- Elleçlenen birim parça adeti başına maksimum parça sayısı limiti – 9.999
- Maksimum nakliye birim parça sayısı – 200 (Nakliye Birim Etiketleri tek seferde bir etiket yazdırıldığında).
- Maksimum nakliye birimi – 40 (Nakliye Birim Etiketleri tek seferde tamamı yazdırılırken)
FedEx LTL Kargo gönderileri, tüm 50 eyalette ve Porto Riko, USVI, Kanada ve Meksika'da kullanılabilir. Bazı gönderiler için gönderi etiketlerine ek olarak bir Konşimento gerekmektedir. Tehlikeli madde içeren gönderiler, bu gönderilere örnek olarak verilebilir.
FedEx Freight®, geliştirilmiş bir LTL ağında hızlı ve ekonomik kargo gönderimini kolaylaştırarak LTL sektöründe değişim yaratıyor.
Aşağıdaki özellikler bu Uygulama Programlama Arayüzü ile ilişkilidir:
- Freight LTL Alımını Yönetme
Bu özellik, Freight LTL alım konumlarını almaya, bir kargo Alımı planlamaya ve daha önceden planlanmış herhangi bir Alımı iptal etmeye izin verir.
- Freight LTL Fiyat Tekliflerini Alma
Bu özellik, seçilen konumlara ve hizmet seçeneklerine göre bir Freight LTL gönderisi için fiyat teklifleri almaya izin verir.
- Freight LTL Gönderisi Kargolama
Bu özellik, bir Freight LTL gönderisi oluşturmaya izin verir.
Aşağıda Freight LTL Uygulama Programlama Arayüzünün özellikleri verilmiştir:
- Tüm hizmet türleri için tek parça veya MPS gönderiler kargolayın ve gönderi etiketi/etiketleri veya Konşimento (gerekli olması durumunda) oluşturun.
- Çoklu parçalı gönderi oluşturun ve her bir parçayı ayrı olarak takip edin.
- FedEx Freight Priority ve Freight Economy hizmetlerini kullanmak için LTL gönderileri oluşturun.
- Hesap numarası, iletişim ve adres gibi alıcı bilgilerini sağlayın.
- Uç nokta planında bahsedildiği şekilde zaman damgasını, paketleme türünü, toplam ağırlığı ve diğer gerekli bilgileri sağlayın.
- Standart markalama ile FedEx Etiketi sağlayın ve termal etiketler için belirtilen boyutları destekleyin.
- Gönderi işlemi sırasında e-posta veya kısa mesaj ile bildirimler alın. Örneğin:
- Gönderi bildirimi
- Tahmini teslimat
- Alım bildirimi
- Gönderi Belgeleri Oluşturma; örneğin:
- Bireysel Parçalı Gönderi Etiketleri
- Konşimento
- Ticari Fatura
- Kanada Gümrük Faturası
- Her seferinde bir parça için gönderi oluşturun ve etiket yazdırın veya tüm parçaları aynı anda işleyin.
- Tüm hizmet türleri için tek parça veya MPS gönderi ücretlerini alın.
- Alım uygunluğunu kontrol edin, kargo alımı planlayın ve alımı iptal edin.
- Alternatif bir fatura adresi için üçüncü taraf hesaplarla alım oluşturun ve planlayın.
Kargo Teslimatta Nakit Ödeme: Destek Sonu
Taşıyıcı, Müşterilere Teslimatta Nakit Ödeme hizmeti sağlamamaktadır. Taşıyıcı, Teslimatta Nakit Ödeme. tutarının tahsilatından sorumlu olmayacaktır, çünkü bu hizmet Taşıyıcı tarafından sağlanmamaktadır. Tüm depolama, yeniden gönderim ve kargo ücretleri Teslimatta Nakit Ödeme işaretli gönderiler için geçerli olacaktır.
Freight LTL Gönderi Hizmetleri
Aşağıdaki Freight LTL gönderi hizmetleri mevcuttur:
FedEx Freight® Priority
Sektöründe lider zamanında performans ve hızlı teslimat süreleriyle FedEx Freight® Priority, gönderilerinizi hızlı ve güvenilir bir şekilde teslim eder. Müşterilerinize kapsamlı bir sonraki gün ve ikinci gün teslimat için bölgenizdeki hizmet birimimize güvenebilirsiniz. Ücretsiz para iade garantisi mevcuttur. *
FedEx Freight® Priority hizmet özellikleri:
- 600 mile kadar bir sonraki gün teslimat hizmeti ve 1.600 mile kadar ikinci gün teslimat hizmetiyle hızlı teslimat süreleri
- ABD, Kanada ve Meksika'da neredeyse her ZIP koduna doğrudan teslimat.
- Tutarlı, zamanında teslimat güvenilirliği
- Ücretsiz para iade garantisi*
- Uçtan uca gönderi görünürlüğü ile en güncel bilgi teknolojisi
- Tüm bölgesel kargo ihtiyaçlarınızda yardım alabileceğiniz özel uzman ekip
*Tüm hizmetler FXFR 100 Series Kural Tarifesi şart ve koşullarına tabidir.
FedEx Freight Economy
FedEx Freight® Economy temel kargo gönderi ihtiyaçlarınıza odaklanan, ekonomik LTL (kamyon yükünden daha az) teslimatı sunar. FedEx LTL teslimat hizmetleriyle, zamanında teslimat güvenilirliği ve dikkatli nakliye sayesinde müşteri hizmetleri doğru şekilde temin edilir.
FedEx Freight® Economy şunları sağlar:
- Ekonomik kargo çözümleri
- Zaman yönünden daha az hassas ancak güvenilir teslimat ihtiyacı olan gönderiler için yüksek tasarruf oranı
- Tutarlı, zamanında teslimat güvenilirliği
- ABD, Kanada, Meksika ve Porto Riko'da neredeyse her ZIP koduna doğrudan teslimat.
- Uçtan uca gönderi görünürlüğü ile en güncel bilgi teknolojisi
- Uçtan uca gönderi takibiyle yüksek görünürlük
FedEx International Ertelenen Kargo (FDF)
FedEx International Ertelenen Kargo (FDF), uluslararası hava kargo gönderilerinin uzun teslimat/transit süreleri ile ekonomik ücretlerle gönderilmesine olanak tanıyan global bir hava kargo gönderim hizmetidir. FDF ayrıca Havalimanından Havalimanına, Kapıdan Havalimanına, Havalimanından Kapıya ve Kapıdan Kapıya teslimat hizmetleri için de mevcuttur
Not:
- Şu anda bu hizmet yalnızca seçilen ülkeden ülkeye rotalar için mevcuttur.
- Tehlikeli Maddeler (DG) ve Kısıtlı Ürünlere izin verilmez. Örnek: Kuru Buz, lityum iyon piller. Daha fazla bilgi için lütfen FedEx müşteri desteğine ulaşınız.
- ABD yurt içi gönderilere ve ABD dışı yurt içi gönderilere izin verilmez.
Freight LTL Uygulama Programlama Arayüzü nasıl çalışır?
Bu bölümde FedEx Freight LTL Uygulama Programlama Arayüzü için gerekli uç noktalar ve temel ögeler açıklanmaktadır.
Not: FedEx Freight LTL hesabınız, FedEx Freight LTL Uygulama Programlama Arayüzünü kullanacak şekilde etkinleştirilmelidir. Gereken temel bilgiler, LTL gönderilerini işlemek üzere FedEx Freight hesap numarası/numaraları ve hesapla ilişkili doğru posta adresidir.
Aşağıda, bu Uygulama Programlama Arayüzü ile kullanılabilen uç noktalar verilmiştir:
Freight LTL Kargolama
FedEx Freight LTL gönderisini doğrulamak ve oluşturmak için bu uç noktayı kullanın.
Bu istekle ilişkili gerekli girdi bilgileri aşağıdaki gibidir:
- Kargo Hesap Numarası
- Hesabın posta adresi
- Kargo İstenen Gönderi
- Etiket Yanıt Seçenekleri – Kodlanmış veya URL olarak iade edilecek etiketler.
- Ana Takip ayrıntıları – Sadece MPS gönderisinin işleme alınması ve etiketlerin hepsinin tek seferde yazdırılması yerine her birinin ayrı olarak yazdırılması gereken durumlarda (singleShotMPS ögesi sağlanmadığında veya false değeriyle eklendiğinde).
Bu talebe verilen başarılı yanıt, LTL Gönderisini oluşturur, Takip ayrıntılarını ve uyarı ayrıntılarını yanıtta sağlar. Aynı zamanda başarısızlık durumunda hataları ve açıklamaları da verir.
Not: Posta adresi, asıl gönderi adresinden farklı olabilir.
Freight LTL Alım Uygunluğunu Kontrol Etme
Taşıyıcı, en son uygun alım saati, varsayılan en son uygun saat, alım uygunluğu, paketin alıma uygun olduğu saat, adresin ev adresi olup olmadığına dair bilgi, son alım saati ve sürücünün paketi alma erişimi gibi alım programı ayrıntılarıyla tüm uygun kargo alım konumlarının bir listesini talep etmek için bu uç noktayı kullanın.
Bu istekle ilişkili gerekli girdi bilgileri aşağıdaki gibidir:
- Alım adresi/posta bilgileri.
- Alım isteği türü (örn.: aynı gün/başka bir gün).
- Yurt içi/uluslararası alım olup olmadığı.
Not: Doğru ve geçerli alım adresini kullanın.
Bu talebe verilen başarılı yanıt tüm uygun kargo alım konumlarının, teslimat gününün, uygunluğun (işaret), Alım tarihinin, son alım zamanının, erişim zamanının, konut uygunluğunun (işaret), kapanış saatinin (işaret), kapanış saatinin ve yerel saatin listesini yanıtta verir. Aynı zamanda başarısızlık durumunda hataları ve açıklamaları da verir.
Freight LTL Alımını Oluşturma
Bir Freight LTL alımı oluşturmak ve planlamak için bu uç noktayı kullanın.
Bu istekle ilişkili gerekli girdi bilgileri aşağıdaki gibidir:
- Alım için faturalandırılacak Kargo Hesap Numarası.
- Menşe bilgileri (adres, konum ve hesap/gönderici/diğer gibi alım adresi türü).
- İlişkili hesapla ilgili adres ayrıntıları.
Başarılı alım isteği, planlanan alım için alım onay numarasını, alım bildirimini ve konum kodunu verecektir. Aynı zamanda başarısızlık durumunda hataları ve açıklamaları da verir.
Not: Alım için doğru ve geçerli adres kullanın ve aynı zamanda alımı planlamak için doğru kayıt hesap adresini belirtin. Geçmişteki hazırlık saati veya geçmiş tarih ya da çok ileri bir tarih, alım planlamak için girilmemelidir. İzinsiz teslim alımlara izin verilmez. Alternatif geçerli adres bilgilerini vererek üçüncü taraf hesaplar için alım planlayabilirsiniz.
Freight LTL Alımını İptal Etme
Bir parsiyel kamyon paketiyle ilgili zaten planlanmış bir alım isteğini iptal etmek için bu uç noktayı kullanın. Başarılı alım iptali, bir onay numarası ve alım iptali onay mesajı verir.
Bu istekle ilişkili gerekli girdi bilgileri aşağıdaki gibidir:
- Alım Onay Kodu (alım isteği gönderilirken alınır)
- Planlanmış Tarih (Alım sevkiyatının yapıldığı tarih)
- Şube (alım isteğini işleme almaktan sorumlu olan FedEx Express şubesi)
Başarılı talep, planlanan alım için alım onay numarasını, alım bildirimini ve konum kodunu verecektir. Aynı zamanda başarısızlık durumunda hataları ve açıklamaları da verir.
Not: Planlanmış alımı iptal etmek için alım onay numarasını ve ilgili şube kodunu (sadece FDXE için geçerlidir) gönderin. Alım onay numarası ve ilgili şube kodu (sadece FDXE için geçerlidir) bilgileri bir alım isteği gönderirken alınır. Aynı zamanda alımı iptal etmek için doğru kayıt hesap adresini kullanın. FedEx kuryesi alım şubesine sevkiyat yaptıktan sonra bir alımı iptal etmeye çalışırsanız bir hata bildirimi gönderilecektir.
Freight LTL Fiyatlandırması
Girdi ayrıntılarına göre tüm geçerli Kargo fiyat tekliflerinin ve isteğe bağlı taşıma bilgilerinin listesini talep etmek için bu uç noktayı kullanın. Alınan fiyatlar gönderideki menşe, varış yeri ve diğer çeşitli girdilere bağlıdır. Daha doğru sonuçlar almak için taşıyıcı kodu, hizmet türü veya hizmet seçeneği gibi ek bilgiler kullanılabilir.
Bu istekle ilişkili gerekli girdi bilgileri aşağıdaki gibidir:
- Kargo Hesap Numarası
- Kargo İstenen Gönderi.
Bu talebe verilen başarılı yanıt, planlanan alım için tüm geçerli fiyatların ve şube kodunun listesini verecektir. Aynı zamanda başarısızlık durumunda hataları ve açıklamaları da verir.
Freight LTL Çok Parçalı Gönderi (MPS)
Bir çok parçalı gönderi (MPS), aynı alıcı adresine iki veya daha fazla nakliye birimi içeren gönderilerdir. Gönderi isteğindeki ilk nakliye birimi, ana öğe olarak kabul edilir.
Çok parçalı bir gönderi oluşturmak için:
- Gönderi düzeyindeki bilgileri ekleyin. Örneğin: serviceType, packagingType, totalWeight, totalPackageCount, freightShipmentDetail ve requestedPackageLineItems ayrıntıları. [Not: Ana paket için sequenceNumber 1'e eşit olmalıdır.]
- Her nakliye birimi baskı etiketinde, sonraki tüm nakliye birimleri için masterTrackingId öğesine ana takip ayrıntılarını ekleyin.
Aşağıda bu Uygulama Programlama Arayüzü ile kullanılabilen Çok Parçalı Gönderi İşleme seçenekleri verilmiştir:
Tek Seferde Bir Nakliye Birimi Etiketi Yazdırma
Bu API, MPS gönderilerini işleme almanızı ve tek seferde bir etiket almanızı sağlar.
Tüm gerekli MPS ögeleriyle birlikte gönderileriniz için bu işleve ihtiyaç duyduğunuzda talepte oneLabelAtATime as true ögesini sağlayın.
İlk talebin çıktısı, ana takip numarası olan etiket ve takip numarasını oluşturmalıdır. Tanımlı toplam paket sayısına ilişkin olarak (totalPackageCount) takip numaralarıyla birlikte (alt takip numaraları) sonraki gönderi talebini işleme almak ve etiketleri oluşturmak için masterTrackingId ögesinde bu ana takip numarasını belirtin.
Not: İzin verilen maksimum nakliye birimi adedi 200'dür.
Tüm Nakliye Birimi etiketlerini Tek Seferde Yazdırma
Bu API, MPS gönderilerini işleme almanızı ve etiketleri tek seferde almanızı sağlar. Bu, gönderideki aynı alıcı adresine yönelik 40 veya daha az nakliye birimi (totalPackageCount<=40) olduğunda kullanılan ideal işleme yöntemlerinden biridir.
Gönderi isteğinde 40 veya daha az nakliye birimiyle oneLabelAtATime as false olarak ayarlama yapın ve anında etiketleri oluşturun.
Not: Maksimum nakliye birimi sınırı 40, gösterge amaçlıdır ve sabit bir limit değildir. Limit aynı zamanda nakliye birimleri ve emtiaların kombinasyonuna da bağlıdır. Bu konu hakkında daha fazla bilgi içni FedEx yöneticinizle iletişime geçin.
Örnek: Gönderi isteğiniz 10 nakliye biriminden oluşur; gönderildiğinde 10 etiket üretir ve etiket URL'leri veya kodlanmış etiketler istenildiği şekilde yanıtta sağlanır.
FedEx Freight Direct
Bu hizmet, müşterilerin evlerinde veya iş yerlerinde ağır, hacimli gönderilerin teslimi dahil olmak üzere büyük ve paletli ürünlerin teslimi için üstün bir müşteri deneyimi sağlar.
Hizmet; proaktif iletişim, esnek teslimat seçenekleri ve hizmet ek ücretlerini içeren paket fiyatlandırma gibi seçenekler sunar.
Bu hizmete dahil olan özelliklerden bazıları şunlardır:
- Amerika Birleşik Devletleri, Alaska ve Hawaii'de FedEx Freight Direct temel, randevu ile temel, standart ve premium teslimat gönderileri ve temel iade gönderileri/alımları işlemlerinin oluşturulmasını sağlar.
- Bir FedEx Freight Direct hesap numarası kullanılarak bir FedEx Freight Direct gönderisi için eksiksiz bir ücret tahmini alma ve bir FedEx Freight Direct alımını iptal etme olanağını içerir.
- Alaska ve Hawaii için ücret tahminleri yapılmaz. Müşteriler, bu eyaletler için fiyat teklifi istemek üzere FedEx müşteri hizmetlerini aramalıdır.
- Müşterinin, aynı gün için planlanan alım işlemini iptal etmek amacıyla FedEx müşteri hizmetlerini araması gerekir.
- Müşterinin şunları yapabilmesi için orijinal göndericiye/alıcıya e-posta bildirimleri göndermenizi sağlar:
- Teslimat programlama
- Teslimat ve/veya alım onayı alma
- Teslimat ve/veya alım bildirimi alma
- Yolda bildirim alma
- Teslim edilmiş gönderiler için müşteri anketi
- Posta kodu doğrulama, boyutlar, parça ağırlığı ve taşıma birimi ağırlığına ilişkin iş kuralları, hat taşımacılığı ve ilk/son mil hizmetlerinin doğru kombinasyonunu belirlemek için FedEx Freight Direct'te geçerlidir.
FedEx Freight Direct, aralarından seçim yapabileceğiniz farklı hizmet türleri sunar.
Bu API, Freight Direct hizmeti ile aşağıdaki özellikleri sunar:
Freight Direct Ücretlerini Alın
Aşağıdaki özel Freight Direct hizmet seçenekleri için Freight Direct Ücretleri ve ek ücretler almak istiyorsanız bu uç noktayı kullanın: Temel Hizmet, Uygulamaya Göre Temel Hizmet, Standart Hizmet, Premium Hizmet.
Uç nokta Freight Direct LTL'si kullanılarak Ücret talebine eşlik etmesi gereken gerekli ayrıntılar aşağıdadır:
- Freight Direct Türü (TEMEL, UYGULAMAYA GÖRE TEMEL, PREMİUM, STANDART)
- Freight Direct Türü (TAŞIMA, ALIM)
- Telefon numarası sağlanmışsa Telefon Numarası Türü (EV, CEP, İŞ)
- Ağırlık
- Boyutlar (Negatif Olmayan Uzunluk, Genişlik ve Yükseklik)
Freight Direct Gönderisi Oluşturun
Aşağıdaki özel Freight Direct hizmet seçenekleri için tek bir parça veya MPS gönderisi göndermek üzere bu uç noktayı kullanın: Temel Hizmet, Uygulamaya göre Temel Hizmet, Standart Hizmet, Premium Hizmet ve Freight Priority gönderilerini işlemek için gereken belgeler de dahil olmak üzere bir gönderi etiketi veya konşimento alın.
Uç nokta Ship Freight Direct LTL'si yoluyla gönderi talebine eşlik etmesi gereken gerekli ayrıntılar aşağıdadır:
- Freight Direct Türü (TEMEL, UYGULAMAYA GÖRE TEMEL, PREMİUM, STANDART)
- Freight Direct Türü (TAŞIMA, ALIM)
- E-posta Adresi, Telefon Numarası ve Telefon Türü
- Ağırlık
- Boyutlar (Negatif Olmayan Uzunluk, Genişlik ve Yükseklik)
Çıkış konşimentosu, yazdırılan yeni Freight Direct hizmet adları taşır. Hizmet seçimine bağlı olarak konşimentoya yazdırılan değerler şunlardır:
- DOĞRUDAN TEMEL TESLİM
- DOĞRUDAN TEMEL RANDEVU İLE TESLİM
- DOĞRUDAN PREMİUM TESLİM
- DOĞRUDAN STANDART TESLİM
- DOĞRUDAN TEMEL ALIM
- RANDEVU İLE ALIM İLE DOĞRUDAN TEMEL
- DOĞRUDAN PREMİUM ALIM
- DOĞRUDAN STANDART ALIM
Freight Direct Alım
Freight LTL Freight Direct alım hizmetinin kullanılabilirliğini kontrol etmek, paket alımı için bir paket alım talebi oluşturmak veya mevcut bir alım talebini iptal etmek için bu uç noktayı kullanın.
Aşağıda, uç nokta kullanılarak Alım talebine eşlik edecek gerekli ayrıntılar verilmiştir Freight LTL Alımının Kullanılabilirliğini Kontrol Et, Freight LTL Alımı Oluştur ve Freight LTL Alımını İptal Et.
- Freight Direct Türü (TEMEL, UYGULAMAYA GÖRE TEMEL, PREMİUM, STANDART)
- Freight Direct Türü (TAŞIMA, ALIM)
- E-posta Adresi (Alım Talebi Oluşturma)
- Telefon Numarası ve Telefon Türü (Alım Talebi Oluşturma)
- Ağırlık
İş Kuralları
- Bir Freight LTL gönderisinin ilk elleçlenen birim parçaya bir ana takip (Pro) numarası atanır ve sonraki her bir parça için alt takip numaraları atanır.
- Gönderideki her bir parça ayrı olarak veya tüm gönderinin bir parçası olarak takip edilebilir.
- Belirli gönderiler için başka belgeler geçerli olabilir (örneğin Tehlikeli Madde [HazMat] Kargosu ve uluslararası gönderiler).
- Yalnızca LTL Kargo ve LTL Kargo hesaplarına fatura et seçenekleri FedEx Developer Portal'a eklenemez.
- Müşteri, Freight Direct hizmetlerini kullanmak için uzun vadeli tek LTL hesap numarasını veya FedEx Freight Direct hesap numarasını kullanabilir.
- FedEx Freight Direct ücretlendirme özellikleri yalnızca normal LTL API'sinde mevcuttur.
- Tüm yeni hatalar/mesajlar yalnızca İngilizce gösterilir.
- Gönderiler oluşturulurken FedEx Freight Direct hizmet seçeneği talebinin bir parçası olarak e-posta adresi ve telefon numarası gerekir.
JSON API Koleksiyonu
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-13T17:55:29Z",
- "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."
