An update is scheduled to the FedEx Developer Portal on January 18, 2025, from 8:00PM to 10:00PM CST

and the portal will be unavailable during this time.

Fedex Logo
Developer Portal

Global Trade API

Introduction

The Global Trade API enables you to retrieve the list of regulatory documents required for your shipment before it is shipped. Regulatory documents are required to avoid regulatory compliance issues that typically lead to customs clearance delays, fines, and customer dissatisfaction on the deliveries.

The API also provides:

  • Important information from FedEx, government regulatory information, as well as advisories specific to your shipment such as:
    • Current situations affecting shipments
    • Weather and other disruptions
    • Regulatory news and updates
  • Ability to determine whether your shipment requires Electronic Export Information (EEI) to be filed with U.S. Customs.
  • Ability to file EEI with U.S. Customs using FedEx as your agent.
  • Retrieve Internal Transaction Number (ITN), which can then be used in the subsequent shipment transaction to associate with the corresponding EEI.

For more information on EEI, visit the below pages:

Global Trade API Details

This API allows you to retrieve the list of required regulatory documents and advisories applicable to the shipment. It also enables you to determine if your shipment requires an EEI filing, and if so, helps you to file EEI with U.S. Customs, and retrieve the ITN number for your shipment.

Following are features associated with Global Trade API:

Retrieve Regulatory Details

This feature helps you to retrieve the list of documents that must accompany your international shipments, thereby helping to ensure smooth customs clearance.

All dossiers, filings, applications, modifications, amendments, supplements, revisions, reports, submissions, authorizations and approvals, and any reports or amendments necessary to maintain regulatory approvals are specified at early stages of international shipping.

The following are the regulatory document types supported: 

  • FEDEX_GENERATED - Specifies that the document is configured and generated by an internal FedEx system. This document cannot be configured or modified by the customer. Example: FedEx Generated Commercial Invoice, FedEx Generated Proforma Invoice.
  • FILLABLE- Specifies the forms and documents that can be either be filled online or post downloading from the FedEx sites. These forms can also be collected from FedEx ship centers and filled. Example: CN 22 postal customs declaration form.
  • PRINT_ONLY- Specifies the documents and forms that are accepted only in printed form. Example: Invoices
  • SAMPLE- Specifies the sample documents generated by FedEx. Example: sample commercial Invoice

Get Advisories

This feature helps you to retrieve the important regulatory information or FedEx advisories or government advisories specific to your shipment. Advisories could be related to weather and service disruptions, or an official warning statement issued by a government agency so as to provide information about the relative safety of travelling to or visiting one or more specific foreign countries or destinations.

Following are the different types of advisories supported by FedEx: 

  • APPLICATION 
  • DOCUMENT_SPECIFIC 
  • FEDEX 
  • GOVERNMENT 
  • INSPECTION 
  • LICENSE_OR_PERMIT 
  • MAYBE_DOCUMENT 
  • MAYBE_STATEMENT 
  • PROHIBIT 
  • UNIT_OF_MEASURE 
  • WAIVER

Electronic Export Information (EEI)

The Electronic Export Information (EEI) is required documentation when the value of the commodity classified under each individual Schedule B number is over $2,500 or if a validated export license is required to export the commodity.

EEI is the data that must be filed through the Automated Export System (AES) for goods shipped from the U.S. to a foreign country. The filing includes information about the sender and the receiver of goods, and about the goods being exported. The Census Bureau uses these filings to calculate U.S. trade statistics, and Customs and Border Protection (CBP) and the Bureau of Industry and Security (BIS) use the data to help ensure compliance with U.S. export regulations.

The exporter is responsible for preparing the EEI, and the carrier files it with U.S. Customs and Border Protection (CBP) through the Automated Commercial Environment (ACE) and within that, AES Direct. For each EEI record, AES generates a unique ITN, confirming the EEI transaction was accepted and is on file in AES.

Requirements

Customer must use a U.S.-based account number.

Transit requirements:

  • From the U.S., Puerto Rico, or the U.S. Virgin Islands to foreign destinations,
  • Between the U.S. and Puerto Rico, and
  • From the U.S. or Puerto Rico to the U.S. Virgin Islands.

Under the same Schedule B or harmonized tariff number valued at more than US$2,500 and are sent from the same exporter to the same recipient on the same day.
(Note: Shipments to Canada from the U.S. may be exempt from this requirement.)

  • That are rough diamonds classified under harmonized tariff schedule 7102.10, 7102.21 and 7102.31.
  • Requiring a U.S. government export license or permit.
  • Subject to the U.S. International Traffic in Arms Regulations (ITAR) or
  • Subject to commodity, end user, or destination requirements listed in the U.S. Foreign Trade Regulation.

How Global Trade API Works

Retrieve Regulatory Details

Use this endpoint to get required regulatory documents as well as advisories in advance of a shipment.

Following is the required information associated with this endpoint. 

  • Origin Address – Specify the origin details such as Country, postal and State Province code if applicable.
  • Destination Address – Specify the destination details such as Country, postal and State Province code if applicable.
  • Customs Clearance Detail – Specify the customs clearance charges, harmonized code and additional measures of the shipment.
  • Carrier Code – Specify the FedEx carrier needed for the shipment.
  • Total Weight – Specify total weight of the shipment with appropriate unit of measurement.

The successful response to the request will return a list of all possible regulatory documents and advisories as per the given inputs. If there are errors in the request, then error messages and code will be provided in the error object.

Regulatory Compliance Lookup

Use this endpoint to determine if any export and/or import compliance regulations apply for the shipment

The following compliance types are supported as of now:

Export:

  • EEI Filing is required with US Customs for a shipment.

Import:

  • None

Following is the required information associated with this endpoint:

  • shipDate: Specify the shipment date.
  • carrierCode: Specify the FedEx carrier Code. Example: FXE.
  • originAddress:
    • countryCode: Specify the origin country code for the shipment.
  • destinationAddress:
    • countryCode: Specify the destination country code for the shipment.
  • serviceType: Specify the chosen service type of the FedEx operating company. Example: IP, SG, PO etc.
  • serviceOptionTypes: Specify the feature of the service type. Example: FICE, ITAR.
  • totalWeight: Specify the total weight of the shipment.
    • units: Specify the unit for weight measurement. Example: KG, LB etc.
    • value: Specify the weight of the shipment: Example: 68.50.
  • consolidationType: Specify the consolidation type. Example: IPD
  • consolidationRole: Specify the role of the shipment within the consolidation. Example: CRN_SHIPMENT
  • totalCommodityValue: Specify the total value of the shipment.
  • regulatoryCustomsClearanceDetail: Specify the regulatory customs details.

The successful response for this request will let you know if your shipment requires filing an EEI or not.

File EEI

Use this endpoint to file an EEI with the U.S. customs, or update, or cancel an existing EEI.

Following is the required information associated with this endpoint:

  • processingOption: Specify the processing option for your EEI request. Example: ADD, UDPATE, CANCEL
  • eeiControlDetail:
    • shipDate: Specify the shipment date.
    • accountNumber: Specify your FedEx account number.
  • eeiPartyDetails: Specify the shipping party details
    • eeiShipmentPartyType
    • eeiContactAndAddress
      • contact:
        • companyName: Specify the name of the company.
      • address:
        • streetlines: Specify the street address of the company. Example: BUILDING
        • city: Specify the city of the company. Example: PARIS
        • countryCode: Specify the country code. Example: US
  • eeiCommodities
    • commodity: Specify the commodity line item within the shipment.
      • description: Provide a description of the commodity.
      • harmonizedCode: Specify the harmonized code.
      • quantityUnits: Specify the unit of measure code as prescribed by the B/HTS reported number.
      • Weight: Specify the weight of the commodity.
        • Units: Specify the weight measurement unit. Example: KG
    • HarmonizedCode: Specify the harmonized code
    • quantityUnits: Specify the unit of measure code as prescribed by the B/HTS reported number.
    • weight: Specify the weight of the commodity
      • Units: Specify the weight measurement unit. Example: KG
    • exportInformationCode: Specify the export information Code: Example: GP
    • eeiCommodityLicenseDetail:
      • licenseCode: Specify the license code

Successful response to this request will file your shipment’s EEI with the U.S. Customs and returns a Shipment Reference number (SRN). The ShipmentReferenceNumber (SRN) received in the response is required to retrieve the Internal Transaction Number (ITN).

Retrieve ITN

Use this endpoint to retrieve the Internal Transaction Number (ITN) for an EEI which was already filed with the U.S. Customs. 

Following is the required information associated with this endpoint:

  • shipmentReferenceNumber: Specify the shipment Reference Number received from the FileEEI transaction.

Successful response to this request will return the ITN number for the filed EEI. This ITN number needs to be specified in the corresponding shipment transaction request.

For Example, in Ship API, following elements need to be populated for submitting your ITN or EEI exemption number to FedEx.

Element Description

Sender/Tins/TinType

As the shipper, your tax identification information must be uploaded to FedEx for EEI shipments. Specify the Employer Identification Number (EIN). Valid values:

  • BUSINESS_NATIONAL
  • BUSINESS_STATE
  • BUSINESS_UNION
  • PERSONAL_NATIONAL
  • PERSONAL_STATE

Sender/Tins/Number

Specify the Taxpayer Identification/Number with the corresponding ID number for TinType.

CustomsClearanceDetail/ExportDetail/ExportComplianceStatement

For shipments requiring an EEI, enter the ITN number received from AES when you filed your shipment or the FTR (Foreign Trade Regulations) exemption number, or the ITN number received from filing EEI with/through FedEx. The proper format for an ITN number is AES XYYYYMMDDNNNNNN where YYYYMMDD is date and NNNNNN are numbers generated by the AES.

Note: The ITN or FTR exemption number specified in the Ship request is printed on the international shipping label.

Shipment Documents

Accurate documentation is an important part of domestic as well as international shipments in order to avoid package caging or delays and to ensure smooth package delivery. 

The following are the different types of shipping and customs documents that are available through the FedEx Global Trade Manager API.

Note:         

  • Other trade documents that are not listed here may be required for your shipment depending on the exact nature of the goods. If unsure, contact FedEx Customer Service for directions concerning what must be included to ensure smooth clearance for your shipment.

Certificate of Origin (COO)

A COO is an international document that verifies the country/territory where a product was manufactured. Some countries restrict imports from certain countries, many countries limit the quantity of imported goods, and some countries give preference to goods manufactured in a certain country.

[Service ENUM : CERTIFICATE_OF_ORIGIN]

Commercial Invoice (CI)

This is a document provided by the seller/exporter that describes the parties involved in the shipping transaction and the goods being transported. It is the primary document used by Customs. It should be created using the official language of the country/territory to which the goods are being exported (FedEx generated invoices do not have this option), if possible. The Commercial Invoice should include a detailed breakdown of all items included in the shipment, including: a proper description of the goods (what is it? what is it made from? what is its intended use?) the quantity, the country/territory of manufacture, the price or cost, currency used, the Harmonized System number for each commodity and the terms of delivery. Some countries require that an original invoice be executed on the shipper's letterhead. The invoice should always be signed and dated by the exporter certifying that the details provided are true and correct representations of the contents covered by the Commercial Invoice. [Service ENUM: COMMERCIAL_INVOICE] 

For more information visit FedEx Global Trade Manager.

Dangerous Goods Shipper Declaration

This is a shipper’s declaration for shipments classified as dangerous goods based on Safety Data Guide (SDG), International Air Transport Association (IATA) and International Civil Aviation Organization (ICAO). The FX 18 form requires the FedEx recognized vendors to produce the Shipper’s Declaration for Dangerous Goods form for Dangerous goods classified shipments that originate in the U.S.

[Service ENUM: DANGEROUS_GOODS_SHIPPERS_DECLARATION]

Export Declaration

The Electronic Export Information (EEI) formerly known as Shipper's Export Declaration (SED) is required by the US Department of Census in order to obtain statistical data and by the Bureau of Industry and Security (BIS) to assist in enforcing export controls. The SED/EEI is required when the total value of goods classified under any single Schedule B number exceeds $2,500 (USD) or the commodity(s) require an export license. This information can be completed electronically by the exporter or their agent. The information is mandatory and required to be submitted electronically through the Automated Export System (AES) for commodities listed on the Commerce Control List (CCL) or the U.S. Munitions List (USML). 

Note: This is only required for US Export Shipments.

[Service ENUM: EXPORT_DECLARATION]

General Agency Agreement

An Agency Agreement or Power of Attorney (POA) is the legal authority that is provided by importers to a customs broker to allow them to release and/or account for shipments with the Canada Revenue Agency (CRA) on behalf of the importer's company. If a Canadian Resident Importer would like Federal Express to act as their customs broker in Canada on an ongoing basis, these forms must be completed and returned as per the instruction sheet before shipping into Canada. This form is a Limited Agency Agreement and would apply to Federal Express shipments only. This form is in a format which can be easily filled and easy to use in the document library section on this website. 

[Service ENUM: GENERAL_AGENCY_AGREEMENT]

OP900

This form is required by the DOT for shipping hazardous materials. Customer will be provided the specific OP-900 form to be filled out based on the shipment.

Examples:

  • OP-900LL if the shipment is a laser printer.
  • OP-900LG if the shipment is a dot matrix printer.

Note: Manual forms are not accepted anymore, hence you have to fill up the form and send us the digital copy of the same.

 [Service ENUM: OP_900]

Pro Forma Invoice

The pro forma invoice is issued before sales takes place. Once a pro forma invoice is received from the supplier, the buyer sends a purchase order or opens a letter of credit to the supplier. As per agreed date of shipment, the seller arranges to ship the goods. 

[Service ENUM: PRO_FORMA_INVOICE]

VICS Bill of Lading

VICS Bill of Lading form is created by the VICS (Voluntary Inter-Industry Commerce Standards) and is primarily used for general merchandise retail industry shipments. 

[Service ENUM: VICS_BILL_OF_LADING]

USMCA Commercial Invoice and Certification of Origin

The USMCA/T-MEC/CUSMA Commercial Invoice-Certification of Origin is a commercial invoice combined with the required certification of origin data elements. That includes a statement that will provide a way to both ship and claim preferential tariff treatment for qualifying goods using one document for the United States-Mexico-Canada agreement. Goods that qualify for the preferential tariff treatment must originate and be exported from the U.S., Mexico or Canada. [Service ENUM: USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN]

USMCA Certification of Origin

The USMCA/T-MEC/CUSMA Certification of Origin is a form used to claim the preferential tariff treatment for the United States-Mexico-Canada Agreement. The certification contains a set of data elements including a statement and must be certified by the exporter, producer or importer for qualifying goods. The imported goods must originate and be exported from the U.S., Mexico or Canada. This form can be used to cover a single shipment or for a 'blanket' period of up to twelve months. 

[Service ENUM: USMCA_CERTIFICATION_OF_ORIGIN]

Business Rules

  • The commercial invoice should be created in the official language of the country/territory to which the goods are being exported. FedEx generated invoices do not provide this option, hence, customers are responsible for printing their own Commercial Invoice.
  • FedEx only accepts the digital copies of OP-900 forms. Manual forms are not accepted.

JSON API Collection

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.

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

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

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.

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

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

Response samples

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.

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

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

Response samples

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.

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

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

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

Response

Copy