Fedex Logo
Developer Portal

Freight LTL API

はじめに

フレイトLTL APIは、LTL (トラック積載量未満)未満の出荷を作成します。大きすぎて小包として出荷できないが、トラック全体を占める訳ではない貨物をLTLフレイトと呼びます。

フレイトLTL APIは、料金の見積もり、個々の取り扱い単位と船荷証券に固有の出荷ラベルの作成(必要な場合)、集荷の予約と出荷のステータスの追跡、空室状況の確認と集荷の予約の設定をサポートし、より大きな重い貨物の処理効率を改善します。

FedEx FreightのLTL出荷では、複数の取り扱い単位を利用する貨物の取り扱い単位レベルの追跡と可視性を提供し、また大半の場合、印刷された船荷証券(BOL)を必要とせず国内出荷できます。但し、船荷証券は必要に応じて作成できます。すべての取り扱い単位には固有の追跡番号がありますが、貨物は1つの船荷証券、配達受領、および請求書を基に輸送されます。

フレイトLTL APIの詳細

Freight LTL APIを使用することで、LTL貨物の出荷や、船荷証券(必要な場合)、FedEx Freight出荷ラベル、その他の様々な出荷書類を作成するのに役立ちます。フレイトLTL貨物では、マスターラベルは最初の取扱い単位に適用され、子ラベルは2番目以降の取扱い単位に適用されます。子ラベルには独自の追跡番号がありますが、マスター追跡番号を指しています。尚、貨物ごとに、すべての取扱い単位と(複数)個口貨物で構成された船荷証券を1件作成できます。

各取り扱い単位は追跡番号に関連付けることができ、ラベルはFedEx GroundまたはExpress Parcelラベルに似ていますが、Fのマークはフレイト貨物を表しています。

取り扱い単位および取り扱い単位あたりの最大個数:

  • 取り扱い単位あたりの最大個数上限 – 9,999
  • 最大取扱い単位 – 200 (取扱い単位ラベルを一度に 1 枚ずつ印刷する場合)
  • 最大取扱い単位 – 40 (取扱い単位ラベルを一度に印刷する場合)

FedEx LTLフレイト貨物は、プエルトリコ、USVI、カナダ、メキシコだけでなく、全50州に発送できます。但し、一部の貨物には、出荷ラベルに加えて船荷証券が必要です。船荷証券が必要な貨物の例として危険性を有する物質が挙げられます。

FedEx Freight®は、合理化されたLTLネットワーク内で貨物を迅速かつ効率的に出荷しやすくすることでLTL業界を変革しています。

出荷API機能:

  • フレイトLTL集荷の管理

    この機能では、フレイトLTL集荷場所の確認、貨物の集荷の予約、予約済み出荷のキャンセルができます。

  • フレイトLTLレート料金見積もり

    この機能では、選択した場所とサービスオプションに基づいて、フレイトLTL貨物の料金の見積もりができます。

  • フレイトLTL貨物の出荷

    この機能でフレイトLTL貨物を作成できます。

フレイトLTL APIの機能:

  • すべてのサービスタイプに対して1個口貨物または複数個口貨物を出荷し、出荷ラベルまたは船荷証券(必要な場合)を生成します。
  • 複数の取り扱い単位の貨物を作成し、各取り扱い単位を個別に追跡します。
  • FedEx Freight PriorityおよびFreight Economyサービスを利用するためにLTL貨物を作成します。
    • アカウント・ナンバー、連絡先、住所などの荷受人情報を提供します。
    • タイムスタンプ、梱包の種類、総重量、エンドポイントスキーマに記載されているその他の様々な必要な詳細が記載されています。
  • ブランド基準に定められたフェデックスラベルを指定サイズにて感熱式ラベルでサポートしています。
  • 次の出荷トランザクション中、電子メールまたはSMSテキストで通知が送られて来ます。
    • 出荷通知
    • 配達予定日
    • 集荷通知
  • 次の出荷ドキュメントを生成します。
    • 個別取り扱い単位出荷ラベル
    • 船荷証券
    • コマーシャル・インボイス
    • カナダの税関インボイス
  • 出荷を作成し、一度に1つの取り扱い単位でラベルを印刷するか、すべての取り扱い単位を一度に処理できます。
  • すべてのサービスタイプの1個口貨物または複数個口貨物出荷の料金を確認できます。
  • 集荷の空き状況を確認し、フレイトの集荷を予約し、集荷をキャンセルできます。
  • 代替の請求先住所の詳細を提供して、第三者アカウントの集荷を予約できます。

フレイトLTL出荷サービス

次のフレイトLTL出荷サービスを利用できます。

FedEx Freight® Priority

業界最先端の指定時間配達と最短配達所要時間により、FedEx Freight® Priorityは貨物を迅速かつ確実に配達いたします。お客様への翌営業日配達および2営業日配達の拡張配達サービスを希望される場合は、無料のマネーバックギャランティー制度が保証する地域サービスをご利用ください。*

FedEx Freight®Priorityサービス機能:

  • 最大600マイルの翌日配送サービスと、最大1,600マイルの2日間配送サービスによる高速配達所要時間
  • 米国、カナダ、メキシコのほぼすべての郵便番号への直接配達。
  • 一貫性のある、時間厳守の信頼性
  • 無料のマネーバックギャランティー*
  • エンドツーエンドの貨物の可視性を実現する最先端の情報技術
  • 地域のすべてのフレイトのニーズを支援する専門家による専任チーム

*すべてのサービスはFXF 100シリーズ規則関税の契約条件の対象となります。

FedEx Freight Economy

FedEx Freigh Economyは、お客様のベーシックなフレイト出荷のニーズに焦点を合わせ、経済的なLTL (トラック積載量未満)の配達サービスを提供しています。また、FedEx LTL配達サービスでは、時間厳守の信頼性、慎重な取り扱い、卓越したカスタマーサービスを提供しています。

FedEx Freight®Economyは以下を提供します。

  • 経済的なフレイトソリューション
  • 時間の制約がない、信頼性の高い配達を必要とする貨物で費用をますます節約できます。
  • 一貫性のある、時間厳守の信頼性
  • 米国、カナダ、メキシコ、プエルトリコのほぼすべての郵便番号への直接配達。
  • エンドツーエンドの貨物の可視性を実現する最先端の情報技術
  • エンドツーエンドの貨物追跡による可視性の向上

フレイトLTL APIのしくみ

このセクションでは、フェデックス フレイトLTL APIに必要なエンドポイントと主要な項目について説明します。

注意:FedExフレイトLTL APIをご利用になるには、FedEx FreightLTLアカウントを有効にする必要があります。LTL貨物を処理するうえで、FedEx Freightアカウント番号と正確なアカウントの郵送先住所の情報が必要不可欠です。

このAPIで使用できるエンドポイント:

フレイトLTLの出荷

このエンドポイントを使用して、FedExフレイトLTL貨物を検証および作成します。

本リクエストに関連して求められる提供情報:

  • フレイト・アカウント・ナンバー
  • アカウントの住所
  • フレイト要求貨物
  • ラベル応答オプション – エンコードまたはURLとして返されるラベル。
  • マスタートラッキングの詳細 – 複数個口貨物出荷の処理やラベルを一度にすべてを印刷するのではなく、1枚ずつ印刷する場合のみ。(項目singleShotMPSが提供されないか、falseの値と共に追加された場合)。

このリクエストが正常に処理されると、LTL貨物が作成され、応答に追跡とアラートの詳細が表示されます。また、エラーが発生した場合は、エラーと説明を返します。

注意:郵送先住所は実際の配達先住所と異なる場合があります。

フレイトLTL集荷の可用性の確認

このエンドポイントを使用して、運送業者、最新の利用可能な集荷時間、規定の最新の利用可能な時間、集荷の可用性、パッケージの集荷準備完了時間など、集荷予約の詳細を含む全ての利用可能なフレイト集荷場所、住所が居住地であるかどうかの確認、集荷締切時間、およびパッケージを集荷する際のドライバーのアクセスなどが示されたリストをリクエストできます。

本リクエストに関連して求められる提供情報:

  • 集荷先住所/郵便の詳細。
  • 集荷リクエストの種類(例:当日/将来)。
  • 国内/国際集荷かどうか。

注意:正確で有効な集荷先住所を入力してください。

このリクエストが正常に処理されると、利用可能なすべてのフレイトの集荷場所、配達日、空室状況(フラグ)、集荷日、締切時刻、アクセス時間、個人宅への集荷空室状況(フラグ)、終業時間(フラグ)、終業時間、および応答の現地時間が返されます。また、エラーが発生した場合は、エラーと説明を返します。

フレイトLTL集荷の作成

このエンドポイントを使用して、フレイトLTL集荷を作成および予約します。

本リクエストに関連して求められる提供情報:

  • 集荷請求される貨物アカウント・ナンバー。
  • 原産地についての詳細(住所、場所、およびアカウント/荷送人/その他の集荷住所の種類等)。
  • 関連付けられたアカウントの住所の詳細。

集荷リクエストが正常に処理されると、集荷確認番号、集荷通知、および予約されている集荷のロケーションコードを返します。また、エラーが発生した場合は、エラーと説明を返します。

注:集荷予約には、正確で有効な集荷先住所と、アカウント登録した住所のご提供が必要になります。また、集荷を予約する際は、過去の準備完了時間、過去の日付、または遠い未来の日付を入力できません。匿名での集荷は承っておりません。尚、有効な代替住所情報をご提供いただくことで、第三者アカウントの集荷を予約することができます。

フレイトLTL集荷のキャンセル

LTLパッケージのために既に予約済みの集荷リクエストをキャンセルする場合は、このエンドポイントを使用します。集荷のキャンセルが正常に完了すると、確認番号と集荷キャンセル確認メッセージが返されます。

本リクエストに関連して求められる提供情報:

  • 集荷確認コード(集荷リクエストの送信中に取得)
  • 予定日(集荷予定日)
  • 営業所(集荷リクエストの処理を担当するFedEx Express営業所)

リクエストが成功すると、集荷確認番号、集荷通知、および予約されている集荷のロケーションコードが返されます。また、エラーが発生した場合は、エラーと説明を返します。

注意:集荷確認番号と対応するロケーションコード(FDXEにのみ適用)を送信し、予約された集荷をキャンセルします。なお、集荷確認番号と対応するロケーションコード(FDXEにのみ適用)情報は、集荷リクエストの送信中に取得できます。また、アカウントに登録されている正確な住所を使用して、集荷をキャンセルします。FedExの集荷担当者が集荷場所に向かってから集荷をキャンセルすると、失敗通知を受け取ります。

フレイトLTLの料金

このエンドポイントを使用して、入力の詳細に基づいて、運送料金の全ての予定見積額とオプションの経由地情報のリストをリクエストできます。予定見積額は、出荷地、仕向地、およびその他の様々な入力に基づいています。また、運送業者コード、サービスタイプ、サービスオプションなどの追加情報を基に、より正確な結果を得ることができます。

本リクエストに関連して求められる提供情報:

  • フレイト・アカウント・ナンバー
  • フレイト要求貨物。

このリクエストへが正常に処理されますと、予約されている集荷の全ての予定見積額とロケーションコードのリストが返って来ます。また、エラーが発生した場合はエラーと説明を返します。

フレイトLTL複数個口貨物(MPS)

複数個口貨物(MPS)とは、同じ荷受人住所に出荷される2つ以上の貨物を指します。貨物リクエストの最初の取り扱い単位がマスターと見なされます。

複数個口貨物を作成するには:

  • serviceType、packagingType、totalWeight、totalPackageCount、freightShipmentDetail、requestedPackageLineItemsの詳細などの出荷レベル情報を含めてください。[注意:マスターパッケージのsequenceNumberは1でなければなりません。]
  • 取扱い単位ごとにラベルを印刷する際に、後続のすべての取扱い単位の項目masterTrackingIdにマスター追跡の詳細を含めてください。

以下は、このAPIで利用できる複数個口貨物の出荷オプションです。

取り扱い単位のラベルを1枚ずつ印刷

このAPIで複数個口貨物を処理しラベルを一度に取得することができます。

この機能をご利用になるには、必要な全ての複数個口貨物項目とともに、リクエストの項目にoneLabelAtATimeをtrueと指定してください。

最初のリクエストでは、マスター追跡番号であるラベルと追跡番号が生成されます。項目masterTrackingIdにこのマスター追跡番号を指定して、後続の出荷リクエストを処理し、定義された合計貨物数(groupPackageCount)の追跡番号(子追跡番号)のラベルを生成します。

注意:許可される最大取り扱い単位は200です。

すべての取り扱い単位ラベルを一度に印刷

このAPIで複数個口貨物の出荷処理とラベル取得を一度に行うことができます。同じ荷受人住所宛ての貨物に40個以下の取扱い単位(totalPackageCount <= 40)を出荷する場合の理想的な処理方法と言えます。

取扱い単位が40個以下の出荷リクエストでoneLabelAtATimeを「false」と設定すると即座にラベルを生成できます。

注意:取扱い単位の制限(最大40個)はあくまで目安であり、必ずしもそうである訳ではありません。制限は、取り扱い単位の数と品目の組み合わせにも依存します。詳細については、フェデックス営業担当者にお問い合わせください。

例:出荷リクエストには10個の取扱い単位があり、送信すると10個のラベルが生成され、リクエストに応じてラベルURLまたはエンコードされたラベルのいずれかが返って来ます。

FedEx Freight Direct

このサービスは、大きなおよびパレット梱包された商品の配達やお客様のご自宅および事業所の中まで重く、かさばる貨物をお持ちする、または返送のために集荷するなど、優れた顧客体験を提供いたします。

このサービスでは、先進的な通知機能や柔軟な配達オプション、複数の特別取り扱い手数料を含んだセット料金などを提供しています。

このサービスに含まれる機能の一例:

  • 米国本土、アラスカ、およびハワイ内であれば、FedEx Freight Direct Basic(ベーシック)、Basic by Appointment(ベーシック予約)、Standard(スタンダード)およびPremium(プレミアム)の配達、およびBasicの返送/集荷を処理できます。
  • FedEx Freight Directアカウント・ナンバーを基にFedEx Freight Direct貨物の料金を見積もる機能と、FedEx Freight Direct集荷をキャンセルする機能が含まれます。
    • アラスカとハワイについては料金見積り機能に対応しておりません。アラスカとハワイのお見積もりは、FedExカスタマーサービスまでお問合せください。
    • 同日に予定されている集荷をキャンセルするには、FedExカスタマーサービスにお電話ください。
  • 元の荷送人/荷受人にEメール通知を送信する機能があるため、お客様は次のことを実行することができます。
    • 配達を予定する
    • 配達および/または集荷の確認を受ける
    • 配達および/または集荷通知を受け取る
    • 集配状況通知を受け取る
    • 配達された貨物に関するお客様アンケート
  • FedEx Freight Directは、郵便番号の検証、寸法、重量、取り扱い単位の重量に関するビジネス規則に則り、航空輸送とファースト/ラストマイルサービスの適切な組み合わせを決定します。

FedEx Freight Directは各種サービスタイプを提供しております。

このAPIは、Freight Directサービスで次の機能を提供します。

Freight Direct料金の見積もり

このエンドポイントを使用して、次の特別なFreight DirectサービスオプションのFreight Direct料金と追加料金を見積もることができます。

エンドポイントRate Freight LTLを使用して見積を依頼する場合は、依頼に以下を添付する必要があります。

  • Freight Directの種類(BASIC、BASIC_BY_APPOINTMENT、PREMIUM、STANDARD)
  • Freight Direct集配の種類(配達、集荷)
  • 電話番号が提供されている場合は電話番号の種別を入力します(自宅、携帯電話、勤務先)
  • 重量
  • 寸法(負の値ではない長さ、幅、高さ)

Freight Directの運送状の作成

このエンドポイントを使用して、Basic Service、Basic Service by appt.、Standard Service、Premium Serviceの特別なFreight Directサービスオプションの単一の貨物またはMPS貨物の運送状を作成し、Freight Priority貨物の処理に必要な書類を含む出荷ラベルまたはBOLを取得することができます。

以下は、エンドポイントShip Freight LTLを介して出荷依頼に添付する必要がある詳細です。

  • Freight Directの種類(BASIC、BASIC_BY_APPOINTMENT、PREMIUM、STANDARD)
  • Freight Direct集配の種類(配達、集荷)
  • メールアドレス、電話番号、電話種別
  • 重量
  • 寸法(負の値ではない長さ、幅、高さ)

出力BOLには、新しいFreight Directサービス名が印刷されます。以下は、サービスの選択に応じてBOLに印刷される値です。

  • DIRECT BASIC配達
  • DIRECT BASIC BY APPOINTMENT配達
  • DIRECT PREMIUM配達
  • DIRECT STANDARD配達
  • DIRECT BASIC集荷
  • DIRECT BASIC BY APPOINTMENT集荷
  • DIRECT PREMIUM集荷
  • DIRECT STANDARD集荷

Freight Direct集荷

このエンドポイントを使用して、Freight LTL Freight Direct集荷サービスの可用性を確認したり、集荷するパッケージの集荷を依頼したり、集荷予約をキャンセルすることができます。

以下は、エンドポイントCheck Freight LTL Pickup Availability、Create Freight LTL Pickup、およびCancel Freight LTL Pickupを使用して集荷を依頼をする場合に、依頼に添付する必要がある詳細です。

  • Freight Directの種類(BASIC、BASIC_BY_APPOINTMENT、PREMIUM、STANDARD)
  • Freight Direct集配の種類(配達、集荷)
  • メールアドレス(集荷依頼を作成)
  • 電話番号と電話種別(集荷依頼の作成)
  • 重量

ビジネス規則

  • マスター追跡(プロ)番号は、フレイトLTL貨物の最初の取り扱い単位に割り当てられ、子追跡番号は、後続の各取り扱い単位に割り当てられます。
  • 貨物の各取り扱い単位は、個別の追跡も、貨物全体の一部としても追跡することもできます。
  • 他の書類が特定の貨物に適用される場合があります(例:フレイトの危険性を有する物質[HazMat]および国際出荷)
  • 「LTLフレイトのみ」および「LTLフレイトへの請求」アカウントは、FedEx Developer Portalに追加できません。
  • お客様は長期単一LTLアカウント・ナンバーまたはFedEx Freight Directアカウント・ナンバーのいずれかを使用して、Freight Directサービスを利用できます。
  • FedEx Freight Directの料金見積機能は、通常のLTL APIでのみ利用できます。
  • すべての新しいエラー/メッセージは英語で表示されます。
  • 運送状を作成する際に、FedEx Freight Directサービスオプションのリクエストの一部として、Eメールアドレスと電話番号を提供する必要があります。

JSON APIコレクション

Freight LTL API (1.0.0)

Rate Freight LTL

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

header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema
  • MinimumSamplePayload
accountNumber
required
object (LTLRootAccountNumber)

This is the Account number details.
Note:

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

rateRequestControlParameters
object (LTLRateRequestControlParameters)

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

freightRequestedShipment
required
object (LTLRequestedShipment)

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /rate/v1/freight/rates/quotes

Sandbox Server

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

Production Server

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

Request samples

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

Response samples

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

Ship Freight LTL

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

header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-FreightShipment
  • FreightShipment_ShipTo_Freight_Account
  • FreightShipment_BillTo_Freight_Account
  • FreightShipment_International_SingleShot_MPS_ShipTo_Freight_Account
  • FreightShipment_OneLabelAtATime_MPS_Master_ShipTo_Freight_Account
  • FreightShipment_OneLabelAtATime_MPS_Child_ShipTo_Freight_Account
freightRequestedShipment
required
object (FreightRequestedShipment_Freight2020)

The descriptive data for the FreightShipment being tendered to FedEx.

labelResponseOptions
required
string
Enum: "URL_ONLY" "LABEL"

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

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

accountNumber
required
object (ShipperAccountNumber)

The account number associated with the shipment.

oneLabelAtATime
boolean

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /ship/v1/freight/shipments

Sandbox Server

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

Production Server

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

Request samples

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

Response samples

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

Check Freight LTL Pickup Availability

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

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

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

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

header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-FreightPickupAvailability
  • MinimumSamplePayload-FreightPickupAvailability
pickupAddress
required
object (PickupAddress)

The address for which pickup availability inquiry is made.

packageReadyTime
string

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

customerCloseTime
string

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

shipmentAttributes
object (ShipmentAttributes)

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

freightPickupSpecialServiceDetail
object (FullSchemaFreightPickupAvailability_freightPickupSpecialServiceDetail)
dispatchDate
string

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

numberOfBusinessDays
integer <int32>

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /pickup/v1/freight/pickups/availabilities

Sandbox Server

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

Production Server

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

Request samples

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

Response samples

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

Create Freight LTL Pickup

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

header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-CreatePickup
  • MinimumSamplePayload-CreateFreightPickup
  • MinimumSamplePayload-FreightBillToPickup
associatedAccountNumber
required
object

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

originDetail
required
object

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

totalWeight
Array of objects (TotalWeight)

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

packageCount
integer <int32>

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

remarks
string

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

countryRelationships
string
Enum: "DOMESTIC" "INTERNATIONAL"

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

trackingNumber
string

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

commodityDescription
string

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

freightPickupDetail
required
object

This provides the Freight LTL pickup detailed information.

oversizePackageCount
integer <int32>

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

pickupNotificationDetail
object

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /pickup/v1/freight/pickups/

Sandbox Server

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

Production Server

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

Request samples

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

Response samples

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

Cancel Freight LTL Pickup

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

header Parameters
x-customer-transaction-id
string
Example: 624deea6-b709-470c-8c39-4b5511281492

This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply.

content-type
required
string
Example: application/json

This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file.

x-locale
string
Example: en_US

This indicates the combination of language code and country code. Click here to see Locales

authorization
required
string
Example: Bearer XXX

This indicates the authorization token for the input request.

Request Body schema: application/json
One of
  • FullSchema-CancelFreightPickup
  • MinimumSamplePayload-FreightCancel
associatedAccountNumber
required
object (AccountNumber_2)

Specify the FedEx Account number.
Example: Your account number

pickupConfirmationCode
required
string

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

remarks
string

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

reason
required
string

Specify the reason for cancellation of pickup.

contactName
required
string

Specify the contact name.

scheduledDate
string

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

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

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

Sandbox Server

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

Production Server

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

Request samples

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

Response samples

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

Response

Copy