Service Availability API

簡介

服務可用性 API 讓您能夠針對輸入寄件地和目的地位置詳細資料，判斷有哪些可用的 FedEx^® 服務、特殊服務，以及 FedEx Express^® 和 FedEx Ground^® 包裝類別。

服務可用性應用程式開發介面 (API) 詳細資料

以下為與服務可用性 API 相關的功能：

取得輸入寄件地和目的地之間所有可用的 FedEx Express^® 和 FedEx Ground^® 服務及相應的包裝類別組合。
取得寄件地和目的地之間所有可用的特殊服務選項，還有適用 FedEx Express 和 FedEx Ground 服務的簽收選項和回件類型。
取得寄件地和目的地提供之服務的運輸時間。

FedEx 服務可用性應用程式開發介面 (API) 的運作方式

使用此服務取得可用的 FedEx 服務、特殊服務 (服務選項) 和包裝類別。

取得服務與包裝選項

此請求會根據輸入詳細資料，回傳含有出口、退回和進口貨件類型可用的所有服務和包裝類別清單。

關於此請求的主要輸入資訊如下：

貨件詳細資料 (含地址)
收件人詳細資料 (含地址)
帳號及託運日期
待託運商品

此請求結果會針對提供的輸入資料列出所有可用的 FedEx 服務、服務選項和包裹選項。如果地址詳細資料無效，例如國家/地區、州/省，及郵遞區號的組合無效，請求就會失敗。

取得特殊服務選項

此請求會根據輸入詳細資料，回傳列有所有可用特殊服務的清單。關於此請求的主要輸入資訊如下：

貨件詳細資料 (含地址)
收件人詳細資料 (含地址)
帳號及託運日期
待託運商品

此請求的結果會列出寄件地和目的地之間所有可用的 FedEx 服務選項，以及簽收選項和回件類型。客戶可使用承運人代碼和/或服務類型來篩選結果，以檢視更多特定服務的可用性。此服務對承運人代碼 FedEx Express (FDXE)、FedEx Ground (FDXG) 和 FedEx Ground^® Economy (先前稱為 FedEx SmartPost^® (FXSP)) 有效。

取得服務和運輸時間

此請求會根據輸入詳細資料，回傳含有出口、退回和進口貨件類型可用的所有服務和運輸時間清單。

關於此請求的主要輸入資訊如下：

貨件詳細資料 (含地址)
收件人詳細資料 (含地址)
帳號及託運日期
待託運商品

此請求結果會列出所有可用的 FedEx 服務和運輸時間的詳細資料。如果地址詳細資料無效，例如國家/地區、州/省，及郵遞區號的組合無效，請求就會失敗。

FedEx 服務

FedEx 提供各式各樣的託運服務，透過完整的服務選項及健全的支援系統來配合不同的時程和預算，讓包裹運送更有效率。

以下為 FedEx 提供的服務：

FedEx Express^®

FedEx Express 速度快，提供特定時間的遞送承諾–保證準時，否則退費，且隨附白色的快遞包裹和箱子。

在美國，可為重量最高達 150 磅的文件和包裹指定於 1、2 或 3 個工作天的特定時間送達。

FedEx Ground^®

這項服務對企業和住宅而言都是相當實惠的陸運快遞，視與目的地的距離而定，可於 1 到 7 個工作天內為美國境內的所有美國企業地址 (阿拉斯加和夏威夷則需要 3 到 7 個工作天) 提供指定日期的陸運服務。若為國際遞送，FedEx Ground 為加拿大所有企業和居住地址提供 2 到 7 個工作天的指定日期陸運服務，確切天數視與目的地的距離而定。

FedEx Home Delivery^®

此服務提供一週 7 天的住宅遞送服務，週六和多數週日也能將貨件運送至大部分地點。

FedEx Home Delivery 貨件的託運重量上限為 150 磅。

FedEx Ground^® Economy (先前稱為 FedEx SmartPost^®)

此服務提供經濟實惠的輕量貨件集中託運和遞送服務，與美國郵政服務 (Postal Service^®) 合作，將包裹從企業交到顧客手中。

FedEx Office^®

專為企業和文件解決方案打造，也可使用 FedEx Express 和 FedEx Ground 託運服務。FedEx 服務站網路以電子化的方式連接各個地點，可以幫助您有效管理工作團隊和各地點的全方位企業服務需求，同時也有助您控管及降低成本。

FedEx Logistics

無論您偏好何種運輸方式或哪間貨運公司，這項服務都能提供可靠且高效率的點到點解決方案，有助於應對複雜的全球託運。

全面的報關行、關稅最低化和出口文件服務。
全球海運和空運貨物配送、貨物保險和多樣化配送。
提供直送貨件、配送中心直送及廠商/供應商管理計畫。

美國包裹服務

您的託運需求	FedEx 服務
首要貨件，隔天工作天早晨	FedEx First Overnight^®
隔天工作天早晨	FedEx Priority Overnight^®
隔天工作天下午	FedEx Standard Overnight^®
2 個工作天後的早晨	FedEx 2Day^® A.M.
2 個工作天	FedEx 2Day^®
3 個工作天	FedEx Express Saver^®
經濟陸運服務 (至企業)	FedEx Ground^®
經濟陸運服務 (至住宅)	FedEx Home Delivery^®
輕量包裹 (至住宅)	FedEx Ground^® Economy (先前稱為 FedEx SmartPost^®)
週一至週五隔夜 1 日運送	FedEx Extra Hours^®

國際包裹服務

您的託運需求	FedEx 服務
加急遞送至主要全球市場	FedEx 國際特早快遞服務^®
於 1、2 或 3 個工作天內運送至全球各地	FedEx 國際優先快遞服務^® FedEx 國際優先限時快遞服務 (2A) FedEx 國際優先快遞服務 (2P)
於 5 個工作天內運送至全球各地	FedEx 國際經濟快遞服務^®
5 到 10 個工作天送達貨件	FedEx^® International Deferred Freight
分送快遞服務	FedEx 國際優先分送快遞服務^® FedExFedEx 國際經濟分送快遞服務^SM
經濟陸運服務 (至加拿大)	FedEx International Ground^®

服務類型列舉值

可用的 FedEx 運輸服務清單。如需深入瞭解服務類型，請參閱「服務類型」

FedEx 服務選項

FedEx Express^® 國內 (美國、加拿大) 服務選項

酒精 (僅限美國) – FedEx 酒精託運規定適用於葡萄酒、烈酒和啤酒。各飲料類型適用於不同規定時，會分項列出。葡萄酒是唯一可為顧客直送的酒精類型，視選擇的託運服務而定。酒精可能屬於 FedEx Express 危險物品 (DG) 的範圍，視各液體容量酒精的百分比而定。此功能僅適用已註冊 FedEx 酒精飲料託運計畫的 FedEx 帳號持有者。
危險物品：含有危險物品的貨件必須根據目前的國際航空運輸協會 (IATA) 空運規定和 FedEx Express 條款與條件送交給 FedEx Express。無論路線及貨件的實體運輸方式最終是空運、陸上運輸或兩者皆採用，皆須遵守此規定。為求安心，請使用 FedEx DG Ready solution 來產生您的危險物品申報單。您的解決方案會將資訊傳送給 FedEx，讓您在將貨件提供給 FedEx Express 之前，預先驗證您的貨件。
乾冰：可託運含有乾冰的包裹，只要於運送交易時提供乾冰貨件的資料細節。乾冰是一種被視為危險物品的材料。
由服務站保管：若顧客想要於指定的 FedEx 服務站領取包裹，就可以使用 FedEx Express 的「由 FedEx 服務站保管 (HAL) 」服務。例如，顧客偏好在 FedEx 服務站或 FedEx Express 櫃台據點領取葡萄酒貨件時，經過核准的葡萄酒寄件人可能就會使用 FedEx Express 的「由 FedEx 服務站保管 (HAL) 」服務。
上門取件 (僅限美國)：要求前往您的家中取件。
上門遞送 (僅限美國)：要求將貨件遞送至收件人家中。
回件標籤 (僅限美國)：印出回件託運標籤的服務選項。
星期六取件/遞送：視服務、取件和遞送地點以及其他選項而定，FedEx 可於週六取件和遞送包裹。
簽收選項：視選取的特殊服務而定，清單中會列出適當的簽收選項。簽收選項適用於從加拿大寄出送往美國的貨件。可用的簽收選項如下：
- 無：不需要簽收。
- 免簽名之遞送。若為送往商業地點的包裹，寄件人必須將簽名發佈號碼存檔於 FedEx。若為送往住宅地址的包裹，寄件人則不須將簽名發佈號碼存檔於 FedEx。
- 須間接簽名。
- 須直接簽名。
- 須成人簽名 (僅限美國)。

貨件將依據所選託運類型的標準作業程序遞送。請參閱 FedEx 服務指南瞭解更多細節。

FedEx Ground^® 國內 (美國、加拿大) 服務選項

危險材料 (僅限美國)：如需危險材料託運的詳細資訊，請前往 fedex.com 的危險材料運輸頁面。

FedEx Home Delivery^® 特殊服務

重量上限 150 磅的美國貨件
指定送達 (僅限美國)
週一至週六上午 9:00 至晚上 8:00，適用所有美國住宅地址。
特定日期送達 (僅限美國)
週一至週六 (假日除外)，將包裹遞送至住宅地址。選擇的日期不能早於標準遞送日期，且須位於取件日期起 14 天內。
夜間送達 (僅限美國)
若您的收件人必須親自收件但白天無法取件，就可以使用此服務指定於安排送達日的下午 5 點至晚上 8 點送達。
7 日送達
FedEx Home Delivery^® 提供一週 7 天的住宅遞送服務，週六和多數週日也能將貨件運送至大部分地點。

非標準包裝
若您託運的包裹被 FedEx Ground 歸類為「非標準」，這件貨件就會自動適用額外處理附加費。
非標準 FedEx Ground 包裹的定義如下：

長度超過 60 吋，但等於或小於 108 吋
貨件未完全裝入外層託運容器內
裝在由金屬或木頭製成的外層託運容器內
任何未完全裝入瓦楞紙外層託運容器的鼓狀桶或提桶 (小於 5 加侖)

回件標籤
在您的電腦或託運系統中建立回件託運標籤。接著只要將標籤印出交給顧客，或是以電子郵件傳送即可。

簽收選項
FedEx 提供各種遞送選項以滿足 FedEx 顧客的需求。無論是否需要簽名以證明 FedEx 顧客的貴重物品安全送達，是成人簽名或者是完全不需簽名。
下列 FedEx 簽收選項的可用性，會視您貨件使用的特殊服務和託運類型而有所更動。

可用的簽收選項如下：

不須簽名：FedEx 會嘗試於遞送地址處取得簽名。如果沒有人可簽收，FedEx 會在未取得簽名的情況下，將包裹送至安全的地方。
須間接簽名：FedEx 會於遞送地址處取得代收件者的簽名，如鄰居或大樓管理員。如果沒有人可簽收，FedEx 會於改日重新遞送包裹。此選項僅適用於住宅遞送。
須直接簽名：FedEx 僅會請遞送地址處的人簽收。如果沒有人可簽收，FedEx 會嘗試於改日重新遞送包裹。
須成人簽名：FedEx 將於遞送地址處取得一位達到當地國家/地區法定成年收件者 (非未成年人) 的簽名。簽收人必須有政府核發具有照片的身分證件，或其他當地主管機關承認的身分證明文件。若該地址無符合條件的人可簽收，FedEx 得重新遞送。若為美國境內之遞送，收件人必須年滿 21 歲並出示政府核發具有照片的身分證件。

監控與介入 (MI) 及醫療保健識別碼 (HCID)

監控與介入 (MI) 及醫療保健識別碼 (HCID) 特殊服務選項協助主動監控重要醫療保健貨件、減輕風險，並提供介入支援，保護醫療保健貨件。HCID 特殊服務會識別有時效的醫療保健貨件，並提升其在 FedEx 網路中的優先順序。

醫療保健選項僅適用於高級快遞服務。您必須先選擇 M&I 特殊服務選項，才能託運這些醫療保健選項。請參閱 MI 和 HCID 特殊服務選項，檢視可用服務清單。

您在擷取特殊服務要求中指定此服務類型時，應用程式開發介面 (API) 會傳回您寄件地和目的地組合可用的所有醫療保健服務清單。API 也會在回應中傳回服務的 sequenceNumber 和 sequenceDisplay，決定標籤中醫療保健服務的序號和顯示順序。

陸運危險物品

陸運危險物品 (DG) 是包裹層級的特殊服務選項，可讓寄件人在歐洲境內根據 ADR 法規，透過陸運來託運危險物品包裹。將會在重要歐洲市場中提供陸運危險物品 (DG) 的服務，這是透過 FedEx Regional Economy、FedEx Regional Economy Freight 和 FedEx Express Domestics 等，在國內託運乾冰、鋰電池、限制數量的危險物品等等選項。

其中包括下方的特殊服務，以便讓陸運危險物品 (DG) 具備處理貨件的額外功能：

獨立鋰電池貨件
陸運全面管制的危險物品 (DG)
陸運數量限制貨件
基因改造 (微) 生物
生物物質 B 類
例外數量
放射性物質

附註：

必須在 specialServiceTypes 下具體列舉 STANDALONE_BATTERY，才可獲得在元素 standaloneBatteryDetails 下選取電池詳細資料的選項。這項特殊服務類型僅適用於歐洲境內的區域。
對於全面管制的危險物品 (FDG) 和限制數量的危險物品 (LDG) 貨件，您需要在貨件要求中的 dangerousGoodsDetail 物件下將法規指定為 ADR，才可成功處理。

服務選項列舉值

您可為貨件申請各種類型的特殊服務。如需進一步瞭解貨件特殊服務，請參閱「貨件層級特殊服務」類型。

FedEx 包裝

FedEx 提供特殊設計的包裝解決方案以符合顧客的文件、診斷、耐用、安全和溫度控管需求。包裝是貨件迅速遞送的關鍵角色，因此 FedEx 針對各種形狀和大小，開發了一系列已可供使用、能自行封口的包裝。

FedEx 統一費率

FedEx 統一費率是單一費率託運，50 磅以下的貨件不需要秤重或丈量尺寸。您可以選擇最符合運送物品尺寸的箱子或筒狀物，並將包裹裝滿，只要貨件不超過 50 磅。這為您的快遞包裹提供簡單又可預測的單一費率託運選項。FedEx 統一費率是根據六種快遞服務選項的託運組合，結合七種 FedEx 專有的 (白色) 包裝類型。

FedEx 統一費率包裝

可使用統一費率定價選項的 FedEx 包裝類型如下：

FEDEX 快遞封
FEDEX 小型快遞盒
FEDEX 中型快遞盒
FEDEX 大型快遞盒
FEDEX 特大型快遞盒
FEDEX 快遞袋
FEDEX 快遞筒

您自己的包裝不適用於統一費率定價選項。

如需深入瞭解包裝服務，請參閱「包裝類型」

商務規則

您無法指定多個承運人代碼。若想要查看多個承運人的結果，那就必須刪除此元素，或是傳送獨立的服務供應請求。
重量 151 磅以上的單個棧板，與超過 2,200 磅的棧板都需要預先核准。
若要針對您的寄件地/目的地組合尋找允許託運危險物品的 FedEx 服務，請使用服務可用性服務。
多件包裹貨件 (MPS) 請求中的包裹數量上限為 300 個。
必須啟用託運人帳號，才能使用陸運到府功能。帳號啟用後，顧客就能為低於 150 磅且要送至住宅地址的貨件指定陸運服務類型，而非 Ground 住宅遞送。
若您為參數選項指定 SATURDAY_DELIVERY，則所有可選擇星期六遞送的服務都能享有「星期六遞送」與「一般遞送」兩種選項。請勿為特殊服務指定 SATURDAY_DELIVERY，否則將只回傳任何適用的「星期六遞送」選項。

JSON 應用程式開發介面 (API) 集合

Service Availability API (1.0.0)

Retrieve Services and Transit Times

This endpoint gives the estimated transit times for a particular shipment.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 0e671149-016f-1000-941f-ef4dbabadd2e 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. It also helps you to track the transaction with APIF.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

Full_Schema_TransitTime
TransitTimes_Domestic
TransitTimes_International

requestedShipment	object (TransitTimeRequestedShipment) Provide shipment data details for which a transit time is desired.
carrierCodes	Array of strings Items Enum: "FDXE" "FDXG" "FXSP" Specify the four letter code of a FedEx operating company that meets your requirements Examples of FedEx Operating Companies are: FDXE - FedEx Express FDXG - FedEx Ground FXSP - FedEx SmartPost FXCC - FedEx Custom Critical.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

post /availability/v1/transittimes

Sandbox Server

https://apis-sandbox.fedex.com/availability/v1/transittimes

Production Server

https://apis.fedex.com/availability/v1/transittimes

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"requestedShipment":
{
- "shipper":
  {
  - "address":
    {
    "city": "Collierville",
    "stateOrProvinceCode": "TN",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    }
  },
- "recipients":
  [
  - {
    "address":
    {
    "city": "Collierville",
    "stateOrProvinceCode": "TN",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    }
    }
  ],
- "serviceType": "FEDEX_GROUND",
- "packagingType": "YOUR_PACKAGING",
- "shipDatestamp": "2019-09-01",
- "pickupType": "DROPOFF_AT_FEDEX_LOCATION",
- "shippingChargesPayment":
  {
  - "payor":
    {
    "responsibleParty":
    {
    "address":
    {
    "city": "Collierville",
    "stateOrProvinceCode": "TN",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "accountNumber":
    {
    "value": "60xxxxxx2"
    }
    }
    },
  - "paymentType": "COLLECT"
  },
- "requestedPackageLineItems":
  [
  - {
    "declaredValue":
    {
    "amount": 12,
    "currency": "USD"
    },
    "weight":
    {
    "units": "LB",
    "value": 68.25
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "packageSpecialServices":
    {
    "specialServiceTypes":
    [
    "DANGEROUS_GOODS",
    "COD"
    ],
    "codDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
    "dryIceWeight":
    {
    "units": "LB",
    "value": 10
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "ACCESSIBLE",
    "options":
    [
    "BATTERY"
    ]
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "retailer"
    },
    "pieceCountVerificationBoxCount": 2,
    "batteryDetails":
    {
    "batteryMaterialType": "LITHIUM_METAL",
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II"
    }
    }
    }
  ],
- "shipmentSpecialServices":
  {
  - "specialServiceTypes":
    [
    "BROKER_SELECT_OPTION"
    ],
  - "codDetail":
    {
    "codCollectionAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "codCollectionType": "PERSONAL_CHECK"
    },
  - "internationalControlledExportDetail":
    {
    "type": "DSP_LICENSE_AGREEMENT"
    },
  - "homeDeliveryPremiumDetail":
    {
    "homedeliveryPremiumType": "EVENING"
    },
  - "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationType": "FEDEX_ONSITE",
    "locationContactAndAddress":
    {
    "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "1234",
    "faxNumber": "1234567890",
    "companyName": "Fedex"
    },
    "address":
    {
    "city": "Collierville",
    "stateOrProvinceCode": "TN",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    }
    }
    },
  - "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "LB",
    "value": 10
    },
    "packageCount": 12
    }
  },
- "customsClearanceDetail":
  {
  - "commodities":
    [
    {
    "description": "DOCUMENTS",
    "quantity": 1,
    "unitPrice":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "weight":
    {
    "units": "LB",
    "value": 10
    },
    "customsValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "numberOfPieces": 1,
    "countryOfManufacture": "US",
    "quantityUnits": "PCS",
    "name": "DOCUMENTS",
    "harmonizedCode": "080211",
    "partNumber": "P1"
    }
    ]
  }
},
"carrierCodes":
[
- "FDXG"
]

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "alerts":
  [
  - {
    "code": "string",
    "alertType": "NOTE",
    "message": "string"
    }
  ],
- "transitTimes":
  [
  - {
    "transitTimeDetails":
    [
    {
    "serviceType": "GROUND_HOME_DELIVERY",
    "customerMessages":
    [
    {
    "code": "SERVICE.TYPE.INTERNATIONAL.MESSAGE",
    "message": "Rate does not include dities & taxes, clearance entry fees or other import fees. The payor of duties/taxes/fees will be responsible for any applicable Clearance Entry Fees"
    }
    ],
    "distance":
    {
    "units": "KM",
    "value": 1.2315135367772556
    },
    "commit":
    {
    "brokerCommitTimestamp": "2020-03-05T00:00:00-06:00",
    "cutOffTime": "18:30:00",
    "commodityName": "copper",
    "transitDays":
    {
    "description": "2-7 Business Days",
    "minimumTransitTime": "TWO_DAYS",
    "maximumTransitTime": "SEVEN_DAYS"
    },
    "commitMessageDetails": "string",
    "derivedDestinationDetail":
    {
    "serviceArea": "100015",
    "countryCode": "US",
    "locationId": "631278456",
    "airportId": "CA4562",
    "postalCode": "685423",
    "stateOrProvinceCode": "TN",
    "locationNumber": 7856
    },
    "dateDetail":
    {
    "dayOfWeek": "THU",
    "time": "09:30:00",
    "day": "Apr-13-2021"
    }
    },
    "destinationLocation":
    {
    "geoPositionalCoordinates": "{\"latitude\":5.637376656633329,\"longitude\":3.616076749251911}"
    },
    "serviceName": "FedEx Home Delivery"
    }
    ]
    }
  ],
- "encoded": false
}

}

Retrieve Services and Packaging Options

Use this endpoint to return a list of all FedEx Express or FedEx Ground services and packaging type combinations that are available between the input origin and destination and subpackaging information.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

Full_Schema_Package_And_Service_Options
Package_and_Service_Options_Domestic
Package_and_Service_Options_International

requestedShipment required	object The descriptive data for the requested shipment.
carrierCodes	Array of strings Items Enum: "FDXE" "FDXG" "FXFR" "FXSP" "Specify the four letter code of a FedEx operating company that meets your requirements Examples of FedEx Operating Companies are: FDXE - FedEx Express FDXG - FedEx Ground FXSP - FedEx SmartPost FXCC - FedEx Custom Critical. "
accountNumber	object This is a Payor account number associated with the shipment. Account number is required, for SmartPost shipments (i.e. Carrier code: FXSP)
systemOfMeasureType	string Enum: "IMPERIAL" "METRIC" This is system measurement type, such as Imperial or Metric.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /availability/v1/packageandserviceoptions

Sandbox Server

https://apis-sandbox.fedex.com/availability/v1/packageandserviceoptions

Production Server

https://apis.fedex.com/availability/v1/packageandserviceoptions

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"requestedShipment":
{
- "shipper":
  {
  - "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Collierville",
    "stateOrProvinceCode": "TN",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "John Taylor",
    "emailAddress": "sample@company.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "phoneExtension",
    "companyName": "Fedex",
    "faxNumber": "faxNumber"
    },
  - "accountNumber":
    {
    "value": "Your account number"
    }
  },
- "recipients":
  [
  - {
    "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "postalCode": "m1m1m1",
    "countryCode": "CA",
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "residential": false
    }
    }
  ],
- "shipDateStamp": "2020-02-28",
- "requestedPackageLineItems":
  [
  - {
    "physicalPackaging": "FEDEX_ENVELOPE",
    "groupPackageCount": 0,
    "itemDescriptionForClearance": "Item Description for Clearence",
    "customerReferences":
    [
    {
    "customerReferenceType": "DEPARTMENT_NUMBER",
    "value": "3686"
    }
    ],
    "contentRecord":
    {
    "itemNumber": "45673289",
    "receivedQuantity": 2,
    "description": "This is the part number.",
    "partNumber": "123"
    },
    "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "packageSpecialServices":
    {
    "signatureOptionType": "NO_SIGNATURE_REQUIRED",
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "TX64739DL7564"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "ACCESSIBLE",
    "options":
    [
    "HAZARDOUS_MATERIALS",
    "LIMITED_QUANTITIES_COMMODITIES"
    ]
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "specialServiceTypes":
    [
    "BATTERY",
    "DANGEROUS_GOODS"
    ],
    "codDetail":
    {
    "codCollectionType": "CASH",
    "codCollectionAmount":
    {
    "amount": 100.5,
    "currency": "USD"
    }
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
    }
  ],
- "freightShipmentDetail":
  {
  - "shipmentDimensions":
    {
    "length": 100,
    "width": 30,
    "height": 50,
    "units": "CM"
    },
  - "alternateBilling": true,
  - "lineItem":
    [
    {
    "pieces": 1,
    "volume":
    {
    "units": "CUBIC_FT",
    "value": 9.965781217890562
    },
    "handlingUnits": 1,
    "freightClass": "CLASS_050",
    "description": "Description",
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "packaging": "SELFPACKAGE",
    "classProvidedByCustomer": true,
    "hazardousMaterials": "HAZARDOUS_MATERIALS",
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    }
    }
    ],
  - "role": "SHIPPER",
  - "clientDiscountPercent": 10.5,
  - "fedExFreightBillingContactAndAddress":
    {
    "contactAncillaryDetail":
    {
    "emailAddresses": null,
    "prefix": "prefix",
    "phoneNumberDetails":
    [
    {
    "number":
    {
    "areaCode": "areaCode",
    "extension": "extension",
    "countryCode": "countryCode",
    "personalIdentificationNumber": "personalIdentificationNumber",
    "localNumber": "localNumber"
    },
    "permissions":
    {
    "CALL": "GRANT"
    },
    "usage": "PRIMARY",
    "type": "FAX"
    },
    {
    "number":
    {
    "areaCode": "areaCode",
    "extension": "extension",
    "countryCode": "countryCode",
    "personalIdentificationNumber": "personalIdentificationNumber",
    "localNumber": "localNumber"
    },
    "permissions":
    {
    "CALL": "GRANT"
    },
    "usage": "PRIMARY",
    "type": "FAX"
    }
    ],
    "companyName":
    {
    "division": "division",
    "companyCd": "companyCd",
    "name": "name",
    "department": "department",
    "storeId": "storeId"
    },
    "title": "title"
    },
    "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"
    },
    "addressAncillaryDetail":
    {
    "locationInCity": "location in the city",
    "suite": "suite",
    "locationInProperty": "location in the property",
    "addtionalDescriptions": "addtional descriptions",
    "department": "department",
    "roomFloor": "room or floor",
    "crossStreet": "cross street",
    "building": "building",
    "apartment": "apartment",
    "room": "room",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF"
    }
    },
  - "aliasID": "36839",
  - "liabilityCoverageDetail":
    {
    "coverageType": "NEW",
    "coverageAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "fedExFreightAccountNumber":
    {
    "value": "Your account number"
    },
  - "totalHandlingUnits": 0
  },
- "specialServicesRequested":
  {
  - "internationalControlledExportDetail":
    {
    "type": "DEA_036"
    },
  - "returnShipmentDetail":
    {
    "returnType": "PENDING"
    },
  - "homeDeliveryPremiumDetail":
    {
    "homedeliveryPremiumType": "APPOINTMENT"
    },
  - "returnEmailDetail":
    {
    "merchantPhoneNumber": "1234567890",
    "allowedSpecialService":
    [
    "SATURDAY_DELIVERY"
    ]
    },
  - "specialServiceTypes":
    [
    "FEDEX_EXPRESS"
    ],
  - "saturdayDeliveryDetail":
    {
    "locationContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName":
    {
    "firstName": "first name",
    "lastName": "last name",
    "middleName": "middle name",
    "suffix": "suffix"
    },
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "companyName": "company name",
    "faxNumber": "fax number",
    "title": "title"
    }
    }
    },
  - "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "contactAncillaryDetail":
    {
    "emailAddresses":
    [
    {
    "emailNotificationFormatType": "EMAIL",
    "address": "address",
    "permissions":
    {
    "EMAIL": "GRANT"
    }
    },
    {
    "emailNotificationFormatType": "TEXT",
    "address": "address",
    "permissions":
    {
    "EMAIL": "GRANT"
    }
    }
    ],
    "prefix": "prefix",
    "phoneNumberDetails":
    [
    {
    "number":
    {
    "areaCode": "areaCode",
    "extension": "extension",
    "countryCode": "countryCode",
    "personalIdentificationNumber": "personalIdentificationNumber",
    "localNumber": "localNumber"
    },
    "permissions":
    {
    "CALL": "GRANT"
    },
    "usage": "PRIMARY",
    "type": "FAX"
    },
    {
    "number":
    {
    "areaCode": "areaCode",
    "extension": "extension",
    "countryCode": "countryCode",
    "personalIdentificationNumber": "personalIdentificationNumber",
    "localNumber": "localNumber"
    },
    "permissions":
    {
    "CALL": "GRANT"
    },
    "usage": "PRIMARY",
    "type": "FAX"
    }
    ],
    "companyName":
    {
    "division": "division",
    "companyCd": "companyCd",
    "name": "name",
    "department": "department",
    "storeId": "storeId"
    },
    "title": "title"
    },
    "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"
    },
    "addressAncillaryDetail":
    {
    "locationInCity": "location in the city",
    "suite": "suite",
    "locationInProperty": "location in the property",
    "addtionalDescriptions": "addtional descriptions",
    "department": "department",
    "roomFloor": "room or floor",
    "crossStreet": "cross street",
    "building": "building",
    "apartment": "apartment",
    "room": "room",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF"
    }
    },
    "locationType": "FEDEX_ONSITE"
    },
  - "codDetail":
    {
    "codCollectionType": "CASH",
    "codCollectionAmount":
    {
    "amount": 100.5,
    "currency": "USD"
    }
    },
  - "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "LB",
    "value": 10
    },
    "packageCount": 12
    },
  - "freightDirectDetail":
    {
    "freightDirectDataDetails":
    [
    {
    "type": "STANDARD",
    "transportationType": "DELIVERY",
    "eMailAddress": "raj.osv@fedex.com",
    "phoneNumberDetails":
    [
    {
    "phoneNumberType": "MOBILE",
    "phoneNumber": "XXXXXXXXX12"
    }
    ]
    }
    ]
    }
  },
- "pickupType": "DROPOFF_AT_FEDEX_LOCATION"
},
"carrierCodes":
[
- "FDXE"
],
"accountNumber":
{
- "value": "123456789"
},
"systemOfMeasureType": "METRIC"

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "packageOptions":
  [
  - {
    "serviceType":
    {
    "displayText": "FedEx Ground",
    "key": "FEDEX_GROUND"
    },
    "oneRateMaxWeightAllowed":
    {
    "units": "KG",
    "value": 68
    },
    "maxWeightAllowed":
    {
    "units": "KG",
    "value": 68
    },
    "rateTypes":
    [
    "WEIGHT_BASED",
    "FLAT_BASED"
    ],
    "packagingInfoList":
    [
    {
    "dimensionText": "9-1/2” x 12-1/2",
    "description": "Letter"
    }
    ],
    "packageType":
    {
    "displayText": "FedEx Box",
    "key": "FEDEX_BOX"
    },
    "maxMetricWeightAllowed":
    {
    "units": "KG",
    "value": 68
    },
    "oneRateMaxMetricWeightAllowed":
    {
    "units": "KG",
    "value": 68
    }
    }
  ],
- "oneRate": true,
- "advancedRegulatoryPackages":
  [
  - {
    "displayText": "FedEx Ground",
    "key": "FEDEX_GROUND"
    }
  ],
- "serviceOptions":
  [
  - {
    "key": "FEDEX_GROUND",
    "displayText": "FedEx Ground"
    }
  ],
- "alerts":
  [
  - {
    "code": "code",
    "alertType": "NOTE",
    "message": "alert message"
    }
  ]
}

}

Retrieve Special Service Options

Use this endpoint to request list of all available FedEx services, shipment special, service options along with delivery signature options and return shipment types that are available between an origin and destination. You can filter the results using FedEx carrier code(s) and/or service type(s) for specific services.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.

header Parameters

x-customer-transaction-id	string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.
content-type required	string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.
x-locale	string Example: en_US This indicates the combination of language code and country code. Click here to see Locales
authorization required	string Example: Bearer XXX This indicates the authorization token for the input request.

Request Body schema: application/json

One of

Full_Schema_Special_Service_Options
Special_Service_Options_Domestic_Ground
Special_Service_Options_Domestic_Express
Special_Service_Options_International_Express
Special_Service_Options_International_Express_Freight

requestedShipment required	object (SpecialServicesRequestedShipment) The shipment details for which special service availability is requested.
accountNumber	object Account number associated with a Payor object. Example: Your account number
carrierCodes	Array of strings Items Enum: "FDXE" "FDXG" "FXSP" "FXFR" Optionally supplied to restrict the results to services for a specific carrier. Valid values are: FDXE, FDXG, FXSP. Example: ["FDXG", "FDXE"]

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /availability/v1/specialserviceoptions

Sandbox Server

https://apis-sandbox.fedex.com/availability/v1/specialserviceoptions

Production Server

https://apis.fedex.com/availability/v1/specialserviceoptions

Request samples

Content type

application/json

Example

Copy

Expand all Collapse all

{

"requestedShipment":
{
- "shipper":
  {
  - "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Collierville",
    "stateOrProvinceCode": "TN",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "John Ryan Taylor",
    "emailAddress": "sample@fedex.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "companyName": "Fedex",
    "faxNumber": "123456789"
    },
  - "accountNumber":
    {
    "value": "123456789"
    }
  },
- "recipient":
  {
  - "address":
    {
    "streetLines":
    [
    "Bldg. 10",
    "10 FedEx Parkway"
    ],
    "city": "Collierville",
    "stateOrProvinceCode": "TN",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
  - "contact":
    {
    "personName": "John Ryan Taylor",
    "emailAddress": "sample@fedex.com",
    "phoneNumber": "1234567890",
    "phoneExtension": "91",
    "companyName": "Fedex",
    "faxNumber": "123456789"
    },
  - "accountNumber":
    {
    "value": "123456789"
    }
  },
- "serviceType": "STANDARD_OVERNIGHT",
- "packagingType": "FEDEX_BOX",
- "shipDateStamp": "2019-09-01",
- "requestedPackageLineItems":
  [
  - {
    "physicalPackaging": "FEDEX_ENVELOPE",
    "groupPackageCount": 0,
    "itemDescriptionForClearance": "Item Description for Clearence",
    "customerReferences":
    [
    {
    "customerReferenceType": "DEPARTMENT_NUMBER",
    "value": "3686"
    }
    ],
    "contentRecord":
    {
    "itemNumber": "45673289",
    "receivedQuantity": 2,
    "description": "This is the part number.",
    "partNumber": "123"
    },
    "declaredValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    },
    "packageSpecialServices":
    {
    "signatureOptionType": "NO_SIGNATURE_REQUIRED",
    "signatureOptionDetail":
    {
    "signatureReleaseNumber": "TX64739DL7564"
    },
    "alcoholDetail":
    {
    "alcoholRecipientType": "LICENSEE",
    "shipperAgreementType": "Retailer"
    },
    "dangerousGoodsDetail":
    {
    "accessibility": "ACCESSIBLE",
    "options":
    [
    "HAZARDOUS_MATERIALS",
    "LIMITED_QUANTITIES_COMMODITIES"
    ]
    },
    "pieceCountVerificationBoxCount": 0,
    "batteryDetails":
    [
    {
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II",
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ],
    "specialServiceTypes":
    [
    "BATTERY",
    "DANGEROUS_GOODS"
    ],
    "codDetail":
    {
    "codCollectionType": "CASH",
    "codCollectionAmount":
    {
    "amount": 100.5,
    "currency": "USD"
    }
    },
    "dryIceWeight":
    {
    "units": "KG",
    "value": 68.25
    },
    "standaloneBatteryDetails":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL"
    }
    ]
    }
    }
  ],
- "dropoffType": "DROP_BOX",
- "variableHandlingChargeDetail":
  {
  - "percentValue": 25.67,
  - "fixedValue":
    {
    "amount": 12.45,
    "currency": "USD"
    },
  - "rateElementBasis": "NET_CHARGE",
  - "rateTypeBasis": "ACCOUNT"
  },
- "freightShipmentDetail":
  {
  - "shipmentDimensions":
    {
    "length": 100,
    "width": 30,
    "height": 50,
    "units": "CM"
    },
  - "alternateBilling": true,
  - "lineItem":
    [
    {
    "pieces": 1,
    "volume":
    {
    "units": "CUBIC_FT",
    "value": 9.965781217890562
    },
    "handlingUnits": 1,
    "freightClass": "CLASS_050",
    "description": "Description",
    "weight":
    {
    "units": "KG",
    "value": 68.25
    },
    "packaging": "SELFPACKAGE",
    "classProvidedByCustomer": true,
    "hazardousMaterials": "HAZARDOUS_MATERIALS",
    "dimensions":
    {
    "length": 100,
    "width": 50,
    "height": 30,
    "units": "CM"
    }
    }
    ],
  - "role": "SHIPPER",
  - "clientDiscountPercent": 10.5,
  - "fedExFreightBillingContactAndAddress":
    {
    "contactAncillaryDetail":
    {
    "emailAddresses": null,
    "prefix": "prefix",
    "phoneNumberDetails":
    [
    {
    "number":
    {
    "areaCode": "areaCode",
    "extension": "extension",
    "countryCode": "countryCode",
    "personalIdentificationNumber": "personalIdentificationNumber",
    "localNumber": "localNumber"
    },
    "permissions":
    {
    "CALL": "GRANT"
    },
    "usage": "PRIMARY",
    "type": "FAX"
    },
    {
    "number":
    {
    "areaCode": "areaCode",
    "extension": "extension",
    "countryCode": "countryCode",
    "personalIdentificationNumber": "personalIdentificationNumber",
    "localNumber": "localNumber"
    },
    "permissions":
    {
    "CALL": "GRANT"
    },
    "usage": "PRIMARY",
    "type": "FAX"
    }
    ],
    "companyName":
    {
    "division": "division",
    "companyCd": "companyCd",
    "name": "name",
    "department": "department",
    "storeId": "storeId"
    },
    "title": "title"
    },
    "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"
    },
    "addressAncillaryDetail":
    {
    "locationInCity": "location in the city",
    "suite": "suite",
    "locationInProperty": "location in the property",
    "addtionalDescriptions": "addtional descriptions",
    "department": "department",
    "roomFloor": "room or floor",
    "crossStreet": "cross street",
    "building": "building",
    "apartment": "apartment",
    "room": "room",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF"
    }
    },
  - "aliasID": "36839",
  - "liabilityCoverageDetail":
    {
    "coverageType": "NEW",
    "coverageAmount":
    {
    "amount": 12.45,
    "currency": "USD"
    }
    },
  - "fedExFreightAccountNumber":
    {
    "value": "Your account number"
    },
  - "totalHandlingUnits": 0
  },
- "specialServicesRequested":
  {
  - "internationalControlledExportDetail":
    {
    "type": "DEA_036"
    },
  - "returnShipmentDetail":
    {
    "returnType": "PENDING"
    },
  - "homeDeliveryPremiumDetail":
    {
    "homedeliveryPremiumType": "APPOINTMENT"
    },
  - "returnEmailDetail":
    {
    "merchantPhoneNumber": "1234567890",
    "allowedSpecialService":
    [
    "SATURDAY_DELIVERY"
    ]
    },
  - "specialServiceTypes":
    [
    "FEDEX_EXPRESS"
    ],
  - "saturdayDeliveryDetail":
    {
    "locationContactAndAddress":
    {
    "address":
    {
    "streetLines":
    [
    "10 FedEx Parkway",
    "Suite 302"
    ],
    "city": "Beverly Hills",
    "stateOrProvinceCode": "CA",
    "postalCode": "38127",
    "countryCode": "US",
    "residential": false
    },
    "contact":
    {
    "personName":
    {
    "firstName": "first name",
    "lastName": "last name",
    "middleName": "middle name",
    "suffix": "suffix"
    },
    "emailAddress": "email address",
    "phoneNumber": "phone number",
    "companyName": "company name",
    "faxNumber": "fax number",
    "title": "title"
    }
    }
    },
  - "holdAtLocationDetail":
    {
    "locationId": "YBZA",
    "locationContactAndAddress":
    {
    "contactAncillaryDetail":
    {
    "emailAddresses":
    [
    {
    "emailNotificationFormatType": "EMAIL",
    "address": "address",
    "permissions":
    {
    "EMAIL": "GRANT"
    }
    },
    {
    "emailNotificationFormatType": "TEXT",
    "address": "address",
    "permissions":
    {
    "EMAIL": "GRANT"
    }
    }
    ],
    "prefix": "prefix",
    "phoneNumberDetails":
    [
    {
    "number":
    {
    "areaCode": "areaCode",
    "extension": "extension",
    "countryCode": "countryCode",
    "personalIdentificationNumber": "personalIdentificationNumber",
    "localNumber": "localNumber"
    },
    "permissions":
    {
    "CALL": "GRANT"
    },
    "usage": "PRIMARY",
    "type": "FAX"
    },
    {
    "number":
    {
    "areaCode": "areaCode",
    "extension": "extension",
    "countryCode": "countryCode",
    "personalIdentificationNumber": "personalIdentificationNumber",
    "localNumber": "localNumber"
    },
    "permissions":
    {
    "CALL": "GRANT"
    },
    "usage": "PRIMARY",
    "type": "FAX"
    }
    ],
    "companyName":
    {
    "division": "division",
    "companyCd": "companyCd",
    "name": "name",
    "department": "department",
    "storeId": "storeId"
    },
    "title": "title"
    },
    "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"
    },
    "addressAncillaryDetail":
    {
    "locationInCity": "location in the city",
    "suite": "suite",
    "locationInProperty": "location in the property",
    "addtionalDescriptions": "addtional descriptions",
    "department": "department",
    "roomFloor": "room or floor",
    "crossStreet": "cross street",
    "building": "building",
    "apartment": "apartment",
    "room": "room",
    "addressVerificationOverrideReason": "CUSTOMER_PROVIDED_PROOF"
    }
    },
    "locationType": "FEDEX_ONSITE"
    },
  - "codDetail":
    {
    "codCollectionType": "CASH",
    "codCollectionAmount":
    {
    "amount": 100.5,
    "currency": "USD"
    }
    },
  - "shipmentDryIceDetail":
    {
    "totalWeight":
    {
    "units": "LB",
    "value": 10
    },
    "packageCount": 12
    },
  - "freightDirectDetail":
    {
    "freightDirectDataDetails":
    [
    {
    "type": "STANDARD",
    "transportationType": "DELIVERY",
    "eMailAddress": "raj.osv@fedex.com",
    "phoneNumberDetails":
    [
    {
    "phoneNumberType": "MOBILE",
    "phoneNumber": "XXXXXXXXX12"
    }
    ]
    }
    ]
    }
  },
- "pickupType": "DROPOFF_AT_FEDEX_LOCATION",
- "shippingDocumentSpecification": "shippingDocumentSpecification"
},
"accountNumber":
{
- "value": "123456789"
},
"carrierCodes":
[
- "FDXG",
- "FDXE"
]

}

Response samples

Content type

application/json

Copy

Expand all Collapse all

{

"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"output":
{
- "alerts":
  [
  - {
    "code": "code",
    "alertType": "NOTE",
    "message": "alert message"
    }
  ],
- "serviceOptionsList":
  [
  - {
    "serviceType": "INTERNATIONAL_FIRST",
    "issEnabled": true,
    "signatureOptionsList":
    [
    {
    "displayText": "Indirect Signature",
    "code:": "INDIRECT"
    }
    ],
    "packageSpecialServicesList":
    [
    {
    "displayText": "DANGEROUS_GOODS",
    "subType": "ACCESSIBLE",
    "specialServiceType": "DANGEROUS_GOODS",
    "customerIntegrationMode": "CUSTOM",
    "value": 10
    },
    {
    "displayText": "BATTERY",
    "specialServiceType": "BATTERY",
    "subType": "ACCESSIBLE",
    "customerIntegrationMode": "CUSTOM",
    "value": 10
    },
    {
    "displayText": "NON_STANDARD_CONTAINER",
    "specialServiceType": "NON_STANDARD_CONTAINER",
    "subType": "ACCESSIBLE",
    "customerIntegrationMode": "STANDARD",
    "value": 10
    },
    {
    "displayText": "DRY_ICE",
    "specialServiceType": "DRY_ICE",
    "subType": "ACCESSIBLE",
    "customerIntegrationMode": "CUSTOM",
    "value": 10
    },
    {
    "displayText": "DANGEROUS_GOODS",
    "subType": "INACCESSIBLE",
    "specialServiceType": "DANGEROUS_GOODS",
    "customerIntegrationMode"": "CUSTOM",
    "value": 10
    }
    ],
    "returnShipmentList":
    [
    "EMAIL_LABEL",
    "PRINT_RETURN_LABEL"
    ],
    "carrierCode": "FDXE",
    "batteryOptionList":
    [
    {
    "batteryMaterialType": "LITHIUM_METAL",
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II"
    },
    {
    "batteryMaterialType": "LITHIUM_METAL",
    "batteryPackingType": "PACKED_WITH_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II"
    },
    {
    "batteryMaterialType": "LITHIUM_ION",
    "batteryPackingType": "CONTAINED_IN_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II"
    },
    {
    "batteryMaterialType": "LITHIUM_ION",
    "batteryPackingType": "PACKED_WITH_EQUIPMENT",
    "batteryRegulatoryType": "IATA_SECTION_II"
    }
    ],
    "alertList":
    [
    {
    "displayText": "FedEx Ground",
    "key": "FEDEX_GROUND"
    }
    ],
    "shipmentSpecialServicesList":
    [
    {
    "value": "Returns Clearance",
    "specialServiceType": "RETURNS_CLEARANCE",
    "customerIntegrationMode": "CUSTOM",
    "astraDescription": "RC",
    "subType": "ACCESSIBLE",
    "ltlPaymentTerms":
    [
    "PREPAID",
    "COLLECT"
    ]
    },
    {
    "value": "Broker Select Option",
    "specialServiceType": "BROKER_SELECT_OPTION",
    "customerIntegrationMode": "CUSTOM",
    "astraDescription": "BSO",
    "subType": "ACCESSIBLE",
    "ltlPaymentTerms":
    [
    "COLLECT_SECTION_7_SIGNED",
    "COLLECT"
    ]
    },
    {
    "value": "International Mail Service",
    "specialServiceType": "INTERNATIONAL_MAIL_SERVICE",
    "customerIntegrationMode": "CUSTOM",
    "astraDescription": "IMS",
    "subType": "ACCESSIBLE",
    "ltlPaymentTerms":
    [
    "COLLECT_SECTION_9_SIGNED",
    "COLLECT"
    ]
    }
    ],
    "alerts":
    [
    {
    "code": "code",
    "alertType": "NOTE",
    "message": "alert message"
    }
    ]
    }
  ]
}

}

Request
Response

Response

Copy

Developer Portal

Service Availability API

簡介

服務可用性應用程式開發介面 (API) 詳細資料

FedEx 服務可用性應用程式開發介面 (API) 的運作方式

FedEx 服務

FedEx 服務選項

FedEx 包裝

商務規則

JSON 應用程式開發介面 (API) 集合

Service Availability API (1.0.0)

Retrieve Services and Transit Times

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve Services and Packaging Options

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve Special Service Options

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Enter your user ID and password to log in