Fedex Logo
Developer Portal

Global Trade - API

はじめに

Global Trade APIを使用して、出荷前に貨物に必要な規制文書の一覧を取得できます。規制文書は、通常、通関手続きの遅延、罰金、顧客満足度の問題につながる規制コンプライアンスの問題を回避するために必要です。

APIは、さらに以下も提供します。

  • FedExからの重要な情報、政府規制情報、およびお客様の貨物に関する通知など:
    • 貨物に影響を与える現在の状況
    • 天候およびその他の支障
    • 規制に関するニュースと最新情報
  • お客様の貨物について、米国税関への電子輸出情報(EEI)の申告が必要かどうかを判断します。
  • FedExを代理人として利用し、米国税関にEEIを申告することができます。
  • その後の出荷トランザクションで対応するEEIと、関連付けることができる、内部取引番号(ITN)を取得します。

EEIに関する詳細情報は、以下のページをご覧ください。

Global Trade APIの詳細

このAPIを使用して、貨物に適用される必要な規制文書と勧告の一覧を取得できます。また、お客様の貨物についてEEI申告が必要かどうかを判断し、必要であれば米国税関へのEEI申告と、お客様の貨物のITN番号の取得を支援します。

Global Trade APIに関連した機能:

規制の詳細を入手

この機能は、通関手続きをより円滑に行うために国際貨物に必要な書類の一覧を取得します。

すべての関係書類、申告書、申請書、修正、訂正、補足、改訂、レポート、提出、認可、承認、および規制当局の承認を維持するために必要なレポートまたは訂正等の文書は国際貨物の初期段階で指定されます。

サポートする規制文書の種類: 

  • FEDEX_GENERATED - 内部FedExシステムが構成および生成した書類。この書類はお客様が構成または変更することはできません。例:フェデックスが生成したコマーシャル・インボイス、フェデックスが生成したプロフォーマ・インボイス。
  • FILLABLE - オンラインで、またはフェデックスのサイトからダウンロード後に記入できるフォームと書類。これらのフォームは、フェデックスの出荷センターで入手して記入することもできます。例:CN22 郵便税関申告書フォーム。
  • PRINT_ONLY - 印刷された形式でのみ受け入れられる書類とフォーム。例:請求書
  • SAMPLE - フェデックスが生成したサンプル書類。例:サンプルのコマーシャル・インボイス

勧告を取得する

この機能は、貨物に固有の重要な規制情報、フェデックスの勧告、または政府の勧告を取得します。勧告は、天候やサービスの中断、または1つ以上の特定の外国や仕向地への旅行や訪問の相対的な安全性に関する情報といった政府機関が発行する公式の警告声明に関連している可能性があります。

フェデックスがサポートする勧告の種類: 

  • APPLICATION(申請書) 
  • DOCUMENT_SPECIFIC(文書固有) 
  • FEDEX(フェデックス) 
  • GOVERNMENT(政府) 
  • INSPECTION(点検) 
  • LICENSE_OR_PERMIT(ライセンスまたは許可書) 
  • MAYBE_DOCUMENT(書類の可能性) 
  • MAYBE_STATEMENT(明細書の可能性) 
  • PROHIBIT(禁止事項) 
  • UNIT_OF_MEASURE(測定単位) 
  • WAIVER(権利放棄)

電子輸出情報(EEI)

電子輸出情報(EEI)は、各個別スケジュールB番号に分類された品目の価額が$2,500を超える場合、またはその品目の輸出に有効な輸出許可証が必要な場合に、必要となる書類です。

EEIとは、自動輸出システム(AES)で申告しなければならない米国から海外に出荷される品目のデータです。申告書には、物品の荷送人と荷受人、そして輸出される物品に関する情報が記載されています。国勢調査局はこれらの申告書を利用して米国の貿易統計を算出しており、税関・国境警備局(CBP)および産業安全保障局(BIS)は、米国の輸出規制の順守を確保するためにこれらのデータを利用しています。

輸出者はEEIの作成に責任を負い、輸送業者はこれを米国税関・国境警備局(CBP)に自動商取引環境(ACE)を通じて、その中のAES Directで申告します。EEI記録ごとに、AESは固有のITNを生成し、EEI取引が受理され、AESに記録されていることを確認します。

要件

米国を拠点とするアカウント・ナンバーを使用する必要があります。

トランジット要件:

  • 米国、プエルトリコ、米領バージン諸島から他国への仕向地へ
  • 米国とプエルトリコ間
  • 米国またはプエルトリコから米領バージン諸島へ

同じスケジュールBまたは統計関税番号で価額がUS$2,500以上であり、同じ輸出者から同じ荷受人に同日に送付される貨物。
(注意:米国からカナダへの貨物は、この要件を免除される可能性があります)

  • 統統計関税スケジュール7102.10、7102.21および7102.31に分類される未加工ダイヤモンド
  • 米国政府の輸出許可証または許可証が必要な貨物
  • 米国国際武器取引規則(ITAR)の対象貨物
  • 米国の外国貿易規制に記載のFTR(外国貿易規制)、エンドユーザー、または仕向地の要件の対象貨物

Global Trade APIの仕組み

規制の詳細を入手

このエンドポイントを使用して、必要な規制文書と勧告を出荷前に取得してください。。

次はこのエンドポイントに関連する必要な情報です。 

  • 出荷地住所 – (該当する場合)国、郵便番号等の出荷地の詳細
  • 仕向地の住所 – (該当する場合)国、郵便番号などの仕向地の詳細
  • 通関手続きの詳細 – 通関手続料金、統計品目番号(HSコード)および貨物のその他の措置。
  • 運送業者コード – 貨物に必要なフェデックス運送業者。
  • 総重量 – 正しい測定単位を使用した貨物の総重量。

このリクエストが正常に処理されますと、入力された情報を基に、可能性のあるすべての規制文書と勧告の一覧が返されます。リクエストに誤りがある場合は、エラーメッセージとコードがエラーオブジェクトに提供されます。

規制コンプライアンスの検索

このエンドポイントを使用して、輸送に輸出および/または輸入のコンプライアンス規制が適用されるかどうかを確認することができます

現在サポートされているコンプライアンスタイプ:

輸出:

  • 米国税関への貨物に関するEEI申告が必要

輸入:

  • なし

このエンドポイントに関連する必要な情報:

  • shipDate:出荷日を指定
  • carrierCode:FedExの航空会社コードを指定。例:FXE
  • originAddress
    • countryCode:貨物の原産国コードを指定
  • destinationAddress
    • countryCode:仕向国コードを指定
  • serviceType:フェデックスオペレーティングカンパニーの選択したサービスタイプを指定。例:IP、SG、POなど
  • serviceOptionTypes:サービスタイプについて指定。例:FICE、ITAR
  • totalWeight:貨物の総重量を指定
    • units:重量測定の単位を指定。例:KG、LBなど
    • value:貨物の重量を指定。例:68.50
  • consolidationType:混載タイプを指定。例:IPD
  • consolidationRole:混載内での貨物の役割を指定。例:CRN_SHIPMENT
  • totalCommodityValue:貨物の合計価額を指定
  • regulatoryCustomsClearanceDetail:規制に関する通関の詳細を指定

このリクエストのレスポンスが正常に得られた後に、お客様の貨物にEEI申告が必要かどうかをお知らせいたします。

電子輸出情報(EEI)の申告

このエンドポイントを使用して、米国税関にEEIを申告したり、既存のEEIを更新またはキャンセルしたりすることができます。

このエンドポイントに関連する必要な情報:

  • processingOption:EEIリクエストの処理オプションを指定。例:ADD、UPDATE、CANCEL
  • eeiControlDetail
    • shipDate:出荷日を指定
    • accountNumber:フェデックス・アカウント・ナンバーを指定
  • eeiPartyDetails:荷送人の詳細を指定
    • eeiShipmentPartyType
    • eeiContactAndAddress
      • 担当者
        • companyName:会社名を指定
      • address
        • streetlines:会社の住所を番地まで指定。例:ビル
        • city:会社の市区町村を指定。例:PARIS
        • countryCode:国コードを指定。例:US
  • eeiCommodities
    • commodity:貨物の品目明細を指定
      • description:品目説明を記載
      • harmonizedCode:統計品目番号を指定
      • quantityUnits:B/HTS報告番号で規定された測定単位コードを指定
      • Weight:品目の重量を指定
        • Units:重量の測定単位を指定。例:KG
    • HarmonizedCode:統計品目番号を指定
    • quantityUnits:B/HTS報告番号で規定された測定単位コードを指定
    • weight:品目の重量を指定
      • Units:重量の測定単位を指定。例:KG
    • exportInformationCode:輸出情報コードを指定。例:GP
    • eeiCommodityLicenseDetail
      • licenseCode:許可証コードを指定

このリクエストのレスポンスが正常に得られた後に、米国税関に貨物の事前教示通知が提出され、貨物参照番号(SRN)が返送されます。レスポンスで受け取ったShipmentReferenceNumber(SRN)は、内部取引番号(ITN)を取得するために必要です。

ITNの取得

このエンドポイントを使用して、すでに米国税関に申告済みのEEIの内部取引番号(ITN)を取得します。

このエンドポイントに関連する必要な情報:

  • shipmentReferenceNumber:FileEEIトランザクションで受け取った貨物参照番号を指定

このリクエストのレスポンスが正常に得られた後に、申告済みのEEIのITN番号が返されます。このITN番号は、該当する貨物トランザクションリクエストで指定する必要があります。

例えば、Ship APIでは、FedExにITNまたはEEIの免除番号を提出するために、以下の要素を入力する必要があります。

要素 説明

荷送人/Tins/TinType

EEI貨物の場合、荷送人は、納税者識別情報をFedExにアップロードする必要があります。雇用者ID番号(EIN)を指定。有効値:

  • BUSINESS_NATIONAL
  • BUSINESS_STATE
  • BUSINESS_UNION
  • PERSONAL_NATIONAL
  • PERSONAL_STATE

荷送人/TINS/番号

TinTypeに対応するID番号を使用して納税者番号/番号を指定します。

CustomsClearanceDetail/ExportDetail/ExportComplianceStatement

EEIが必要な貨物の場合、貨物の申告時にAESから受け取ったITN番号、またはFTR(外国貿易規則)の免除番号、またはFedExにEEIを申告した際に受け取ったITN番号を入力してください。ITN番号の適切な形式はAESXYYYYMMDDNNNNNNです(YYYYMMDDは日付で、NNNNNNはAESが生成した数値です)。

注意:出荷リクエストで指定されたITNまたはFTR免除番号は、国際出荷ラベルに印刷されます。

貨物書類

正確な文書は、パッケージのケージ留置および遅延を回避して円滑なパッケージ配達を保証するために、国内および国際貨物にとって重要です。 

以下は、FedEx Global Trade Manager APIを介してご利用いただける様々な種類の貨物および通関書類です。

注意:         

  • 品目の性質によっては、ここに記載されていないその他の取引書類が貨物に必要になる場合があります。不明な場合は、フェデックスカスタマーサービスにお問い合わせいただき、貨物の円滑な通関に必要な書類をご確認ください。

Certificate of Origin(原産地証明書(COO))

COOは製品の製造国を確認する国際書類です。一部の国は特定の国からの輸入を制限し、多くの国は輸入品の量を制限し、一部の国は特定の国で製造された物品を優先しています。

[Service ENUM : CERTIFICATE_OF_ORIGIN]

Commercial Invoice(コマーシャル・インボイス(CI))

この申告書は、売り主または輸出業者が提出する、出荷処理に関与する当事者および輸送された品目に関する記述がある書類であり、通関が第一に使用する書類です。可能であれば、商品の輸出先の国/地域の公用語でご準備ください(FedExが作成したインボイスにはこのオプションがありません)。コマーシャル・インボイスには貨物に含まれるすべての品目の詳細な内訳を含めなければなりません。例えば、品目の適切な説明(何であるか?材料は何か?使用目的は何か?)、数量、製造国、価格またはコスト、使用される通貨、各品目の統計品目番号および配達条件などが含まれます。一部の国では、荷送人のレターヘッドでオリジナルのインボイスを作成しなければなりません。インボイスに記載した詳細は常に真実であること、およびコマーシャル・インボイスの対象になる内容が正確に表現されていることを証明する輸出者による署名と日付が記入されていなければなりません。[Service ENUM: COMMERCIAL_INVOICE]

詳細については、FedEx Global Trade Managerでご確認ください。

Dangerous Goods Shipper Declaration(危険物荷送人申告書)

これは安全データガイド(SDG)、国際航空運送協会(IATA)、国際民間航空機関(ICAO)に基づいて危険物として分類された貨物に対する荷送人による申告書です。FX 18フォームでは、フェデックス認定ベンダーが、出荷国が米国の危険物として分類された貨物に対する荷送人による申告書を作成しなければなりません。

[Service ENUM : DANGEROUS_GOODS_SHIPPERS_DECLARATION]

Export Declaration(輸出申告書)

以前は荷送人輸出申告書(SED)として知られていた電子輸出情報(EEI)は、統計データを取得するために米国国勢調査局(U.S. Department of Census)により、および輸出管理の実施を支援するためにBureau of Industry and Security(産業安全保障局)(BIS)により、求められています。価額が2,500米ドルを超えるスケジュールB品目や品目に輸出許可証が必要な場合、SED/EEIが必要となります。この情報は輸出業者またはエージェントが電子的に入力することができます。商業規制リスト(Commerce Control List)(CCL)または米国軍需品リスト(U.S. Munitions List)(USML)に記載されている品目の情報は自動輸出システム(Automated Export System)(AES)を介して電子的に送信しなければなりません。

注意:これは米国の輸出貨物にのみ必要となります。

[Service ENUM : EXPORT_DECLARATION]

General Agency Agreement(一般エージェント契約)

代理契約書または委任状(POA)は輸入者が通関業者に付与する法的権限であり、通関業者が輸入者の会社に代行してカナダ歳入庁(CRA)に貨物の公開および責任を持つことができるようにします。カナダに居住する輸入者がカナダの通関業者としてFederal Expressを指定する場合、カナダ向けに出荷する前にフォームを指示書に従って記入し返送しなければなりません。このフォームは限定エージェント契約(Limited Agency Agreement)であり、Federal Expressの貨物にのみ適用されます。このフォームは、このウェブサイトのドキュメント ライブラリ セクションで簡単に入力でき、使いやすい形式になっています。

[Service ENUM : GENERAL_AGENCY_AGREEMENT]

OP900

このフォームは、危険物を発送するために運輸部門が必要とします。顧客には貨物に基づいて記入する専用OP-900フォームが提供されます。

  • 貨物がレーザープリンタの場合はOP-900LL。
  • 貨物がドットマトリックスプリンタの場合はOP-900LG。

注意:手書きフォームはご利用いただけなくなりましたので、フォームにご記入の上、デジタルコピーをお送りください。

 [Service ENUM: OP_900]

Pro Forma Invoice(プロフォーマ・インボイス)

プロフォーマ・インボイスは販売前に発行します。サプライヤからプロフォーマ・インボイスを受け取りますと、バイヤーはサプライヤに発注書を送信するか、信用状を開きます。合意された出荷日に従って、売り手は品目の貨物を手配します。

[Service ENUM: PRO_FORMA_INVOICE]

VICS Bill of Lading(VICS船荷証券)

VICS(Voluntary Inter-Industry Commerce Standards)を基に作成されたVICS船荷証券フォームは主に一般的な小売業界の貨物用です。 

[Service ENUM: VICS_BILL_OF_LADING]

USMCA Commercial Invoice and Certification of Origin(USMCAのコマーシャル・インボイスと原産地証明書)

USMCA/T - MEC/CUSMAのコマーシャル・インボイス - 原産地証明書は、発送する適格品の明細書および米国 - メキシコ - カナダ協定の特恵関税措置を請求するために提出する、必要な原産地証明書データ項目を一つの書類に組み合わせたコマーシャル・インボイスです。特恵関税措置の対象となる物品は、米国、メキシコ、またはカナダで製造され、輸出されなければなりません。[Service ENUM: USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN]

USMCA Certification of Origin(USMCA原産地証明書)

USMCA/T-MEC/CUSMA原産地証明書は、米国 - メキシコ - カナダ協定の特恵関税措置を請求するためのフォームです。証明書には、明細書を含む一連のデータ項目が含まれており、適格品については、輸出業者、生産者、または輸入業者が証明しなければなりません。輸入品は、米国、メキシコ、またはカナダから発送および輸出されなければなりません。このフォームは、1つの貨物、または最大12ヶ月の「包括」期間をカバーするために使用します。

[Service ENUM: USMCA_CERTIFICATION_OF_ORIGIN]

ビジネス規則

  • コマーシャル・インボイスは、品目の輸出先の国/地域の公用語でご準備ください。FedExが作成したインボイスにはこのオプションがありません。そのため、お客様作成のコマーシャルインボイスを印刷する必要があります。
  • フェデックスは、OP-900フォームのデジタルコピーのみを受け付けます。手動フォームは受け付けていません。

Global Trade - API (1.0)

Retrieve Regulatory Details

Use this endpoint to retrieve regulatory document and advisories for your shipment.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.


EXPAND ALLCOLLAPSE ALL
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
serviceType
string

Specify the type of service that is used to ship the package.
click here to see Service Types

totalCommodityValue
object

Specify the total commodity value. Either customsClearenceDetail or totalCommodityValue is required.

originAddress
required
object

Provide the shipment origin address details.

destinationAddress
required
object

Provide the shipment destination address details.

serviceOptionType
Array of strings
Items Enum: "FEDEX_ONE_RATE" "FREIGHT_GUARANTEE" "SATURDAY_DELIVERY" "SMART_POST_ALLOWED_INDICIA" "SMART_POST_HUB_ID"

Specify attributes to filter location types. If more than one value is specified, only those locations that have all the specified attributes will be returned.

customsClearanceDetail
object

Specify the Customs clearance details.Either customsClearenceDetail or totalCommodityValue is required.

shipDate
string

Specify shipment date.

Note : Default value is current date in case the date is not provided or a past date is provided.
Format [YYYY-MM-DD].
Example: 2021-08-05'

carrierCode
required
string

Specify the four letter code of a FedEx operating company that meets your requirements.

Valid values are:

  • FDXE - FedEx Express
  • FDXG - FedEx Ground

  • Example: FDXE

totalWeight
object

Provide the total weight for the shipment.

includeURLReferences
boolean

Specify if the url references to be included in the output. These are regulatory reference data urls specific to document, agency.

consolidationType
string

Specify the type of consolidation that contains this shipment.

Valid values are:

  • INTERNATIONAL_DISTRIBUTION_FREIGHT
  • INTERNATIONAL_ECONOMY_DISTRIBUTION
  • INTERNATIONAL_GROUND_DISTRIBUTION
  • INTERNATIONAL_PRIORITY_DISTRIBUTION
  • TRANSBORDER_DISTRIBUTION

consolidationRole
string

Specify the role this shipment plays within the consolidation.

Valid values are:

  • CONSOLIDATION_DOCUMENTS_SHIPMENT – Shipment contains clearance documents for the corresponding consolidation.
  • CRN_SHIPMENT – Shipment is a Child Reference Number(individual shipment within consolidation).
  • MASTER_AIRWAYBILL_SHIPMENT – Shipment represents entire consolidation, moving as a unit.

Responses

200

Success

400

Bad Request

401

Unauthorized

404

Not Found

422

UnProcessable Entity

500

Failure

post /globaltrade/v1/shipments/regulatorydetails/retrieve

Sandbox Server

https://apis-sandbox.fedex.com/globaltrade/v1/shipments/regulatorydetails/retrieve

Production Server

https://apis.fedex.com/globaltrade/v1/shipments/regulatorydetails/retrieve

Request samples - Retrieve Regulatory Details

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "serviceType": "FEDEX_FREIGHT_ECONOMY",
  • "totalCommodityValue":
    {
    },
  • "originAddress":
    {
    },
  • "destinationAddress":
    {
    },
  • "serviceOptionType":
    [
    ],
  • "customsClearanceDetail":
    {
    },
  • "shipDate": "2019-10-14",
  • "carrierCode": "FDXE",
  • "totalWeight":
    {
    },
  • "includeURLReferences": true,
  • "consolidationType": "INTERNATIONAL_DISTRIBUTION_FREIGHT",
  • "consolidationRole": "CONSOLIDATION_DOCUMENTS_SHIPMENT"
}

Response samples - Retrieve Regulatory Details

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

Retrieve ITN

Use this endpoint to retrieve the ITN(internal tracking number) of an EEI(Electronic Export Information) which was already filed with US Customs.


EXPAND ALLCOLLAPSE ALL
header Parameters
x-locale
string
Example: en_US

This indicates the combination of language code and country code.

content-type
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.

authorization
required
string
Example: Bearer XXXXX

This indicates the authorization token for the input request

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.

Request Body schema: application/json
version
object (version)
shipmentReferenceNumber
required
string

This is the shipment reference number which is needed in order to retrieve the ITN (Internal Tracking Number).

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

503

Service Unavailable

post /globaltrade/v1/shipments/itn/retrieve

Sandbox Server

https://apis-sandbox.fedex.com/globaltrade/v1/shipments/itn/retrieve

Production Server

https://apis.fedex.com/globaltrade/v1/shipments/itn/retrieve

Request samples - Retrieve ITN

Content type
application/json
Copy
Expand all Collapse all
{
  • "version":
    {
    },
  • "shipmentReferenceNumber": "24091060018"
}

Response samples - Retrieve ITN

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
  • "customerTransactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
  • "output":
    {
    }
}

File EEI

Use this endpoint to file an Electronic Export Information(EEI) with US Customs.


EXPAND ALLCOLLAPSE ALL
header Parameters
x-locale
string
Example: en_US

This indicates the combination of language code and country code.

authorization
required
string
Example: Bearer XXXXX

This indicates the authorization token for the input request.

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.

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.

Request Body schema: application/json
One of
  • FullSchema_FileEEIInputVO
  • SamplePayload_CancelFiling
  • SamplePayload_UpdateFiling
  • Minimum_Payload
version
object (version)
processingOption
required
Array of strings
Items Enum: "ADD" "CANCEL" "UPDATE"

processingOption for ADD Cancel Update

eeiControlDetail
object (FullSchema_FileEEIInputVO_eeiControlDetail)

Object of EEIControlDetail

eeiPartyDetails
required
Array of objects (FullSchema_FileEEIInputVO_eeiPartyDetails)

Both USPPI and ULTIMATE_CONSIGNEE are mandatory.

eeiCommodities
Array of objects (FullSchema_FileEEIInputVO_eeiCommodities)

commodity US Customs code, a high level explanation of type of export.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

post /globaltrade/v1/shipments/eei/file

Sandbox Server

https://apis-sandbox.fedex.com/globaltrade/v1/shipments/eei/file

Production Server

https://apis.fedex.com/globaltrade/v1/shipments/eei/file

Request samples - File EEI

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "version":
    {
    },
  • "processingOption": "ADD",
  • "eeiControlDetail":
    {
    },
  • "eeiPartyDetails":
    [
    ],
  • "eeiCommodities":
    [
    ]
}

Response samples - File EEI

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
  • "customerTransactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
  • "output":
    {
    }
}

RegulatoryComplianceLookup V1

This endpoint is to determine the compliance regulations applied for Shipment for EEI Filings.


EXPAND ALLCOLLAPSE ALL
cookie Parameters
fdx_login
string
Example: fdx_login=fdx_login%3Dssoxdev2.df9e.6b52a541

It is the login cookie.It is required for online clients.

header Parameters
X-clientid
string
Example: MAGS

Registered client ids with FedEx API. i.e. MAGS, CAFE , INET, ISHP, etc.

X-locale
string
Example: en_US

ISO locale

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.

Authorization
required
string
Example: Bearer XXX

Specifies the authorization token.

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.

Request Body schema: application/json

Contains the Materials Input object to be applied.

version
object (version_optional)
shipDate
required
string <YYYY-MM-DD>

String date format to indicate the date to be used for importing. Default to next day if not present in the request. This date can’t be greater than 120 days this includes weekends. The date format should be ISO8601Date, YYYY-MM-DD.

carrierCode
required
string

The shipment type abbreviation for a FedEx operating company. EX: FXE for FedEx Express. Supported Values: FXE, FXG, FXF or any value supported in the DOM element CarrierCodeType.

originAddress
required
object (RegulatoryAddressVO)

AddressVO V3 Model

destinationAddress
required
object (RegulatoryAddressVO)

AddressVO V3 Model

serviceType
required
string

String value to indicate a FedEx operating company’s type of service. Valid values from the authoritative data source (ADS) are listed in the example. Default value is “IP” if not present in the request. Valid values are also DOM ServiceType values.

serviceOptionTypes
required
Array of strings
totalWeight
required
object (Weight)

Specify the Dry Ice weight details.

Note:

  • Dry Ice is a Package level service for Domestic shipments.
  • Dry Ice must be declared at both Shipment and Package level for International MPS shipments to print the compliance statement on Airway Bill labels.

consolidationType
required
string

String value to identify the type of consolidation containing this shipment.

consolidationRole
required
string

A String value to identify the role of this shipment within the consolidation.

totalCommodityValue
required
object (Money_2)
regulatoryCustomsClearanceDetail
required
object (RegulatoryCustomsClearanceDetail)

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Failure

post /globaltrade/v1/regulatorycompliance/lookup

Sandbox Server

https://apis-sandbox.fedex.com/globaltrade/v1/regulatorycompliance/lookup

Production Server

https://apis.fedex.com/globaltrade/v1/regulatorycompliance/lookup

Request samples - RegulatoryComplianceLookup V1

Content type
application/json
Copy
Expand all Collapse all
{
  • "version":
    {
    },
  • "shipDate": "2022-10-05",
  • "carrierCode": "FXE",
  • "originAddress":
    {
    },
  • "destinationAddress":
    {
    },
  • "serviceType": "[\"IP\",\"SG\",\"PO\",\"XS\",\"FR\",\"FL\"]",
  • "serviceOptionTypes":
    [
    ],
  • "totalWeight":
    {
    },
  • "consolidationType": "INTERNATIONAL_PRIORITY_DISTRIBUTION",
  • "consolidationRole": "CRN_SHIPMENT",
  • "totalCommodityValue":
    {
    },
  • "regulatoryCustomsClearanceDetail":
    {
    }
}

Response samples - RegulatoryComplianceLookup V1

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactionId": "0e671149-016f-1000-941f-ef4dbabadd2e",
  • "customerTransactionId": "AnyCo_order123456789",
  • "output":
    {
    }
}

Error Codes

  • SHIPMENTREGULATORYDETAILS.ORIGINCOUNTRYCODE.INVALID

    出荷国の国コードが正しくありません。更新してもう一度お試しください。

  • SHIPMENTREGULATORYDETAILS.DESTINATIONCOUNTRYCODE.INVALID

    仕向国コードが無効です。更新してもう一度お試しください。

  • SHIPMENTREGULATORYDETAILS.CARRIERCODE.INVALID

    Carriercode が無効です。更新してもう一度お試しください。

CLOSE

Response

Copy