FedEx Global Trade Virtual Sandbox
Virtual API for managing international shipping regulatory details and trade documentation.
The FedEx Global Trade API provides tools to retrieve regulatory details for international shipments. This virtual endpoint allows developers to prototype workflows for customs documentation, commodity classification, and trade compliance checks without hitting production systems.
Use this hosted sandbox to simulate FedEx Global Trade APIs without authentication, API keys, or extra dependencies. Point your code or SDK to the Beeceptor base URL, preferably through an environment variable or feature flag, and switch back to the production API when ready.
This keeps your integration code consistent across local development, QA, demos, and production.
Use cases:
Use this sandbox to validate international shipment regulatory payloads, verify commodity-specific documentation requirements, test customs data mapping, and handle error responses for invalid trade codes or missing shipment details.
General
POST
| Header Name | Example |
|---|---|
x-customer-transaction-id | "624deea6-b709-470c-8c39-4b5511281492" |
content-type* | "application/json" |
x-locale | "en_US" |
authorization* | "Bearer XXX" |
{
"carrierCode": "FDXG",
"consolidationRole": "CONSOLIDATION_DOCUMENTS_SHIPMENT",
"consolidationType": "INTERNATIONAL_GROUND_DISTRIBUTION",
"customsClearanceDetail": {
"commercialInvoice": {
"freightCharge": {
"amount": 181.93,
"currency": "DKK"
},
"purpose": "REPAIR"
},
"commodities": [
{
"additionalMeasures": {
"quantity": 88,
"uom": "LB"
},
"commodityId": 234,
"countryOfManufacture": "BF",
"customsValue": {
"amount": 671.57,
"currency": "SEK"
},
"description": "Professional-grade Chair perfect for creative training and recreational use",
"harmonizedCode": "2",
"name": "Soft Steel Shirt",
"quantity": "8",
"quantityUOM": "PCS",
"weight": {
"units": "KG",
"value": 68
}
}
],
"customsValue": {
"amount": 665.14,
"currency": "USD"
},
"documentContent": "DOCUMENT",
"importerOfRecordAccountNumber": "897654564",
"insuranceCharges": {
"amount": 490.21,
"currency": "RWF"
},
"regulatoryControls": {
"0": "N",
"1": "O",
"2": "T",
"3": "_",
"4": "I",
"5": "N",
"6": "_",
"7": "F",
"8": "R",
"9": "E",
"10": "E",
"11": "_",
"12": "C",
"13": "I",
"14": "R",
"15": "C",
"16": "U",
"17": "L",
"18": "A",
"19": "T",
"20": "I",
"21": "O",
"22": "N"
}
},
"destinationAddress": {
"countryCode": "LK",
"postalCode": "42248",
"stateOrProvinceCode": "KS"
},
"includeURLReferences": true,
"originAddress": {
"countryCode": "TN",
"postalCode": "05452",
"stateOrProvinceCode": "NY"
},
"serviceOptionType": {
"0": "FEDEX_ONE_RATE",
"1": "SATURDAY_DELIVERY"
},
"serviceType": "INTERNATIONAL_PRIORITY",
"shipDate": "2026-10-08T00:00:00.0Z",
"totalCommodityValue": {
"amount": 451.08,
"currency": "HKD"
},
"totalWeight": {
"units": "KG",
"value": 68
},
"version": {
"major": 3,
"minor": 12,
"patch": 29
}
}{
"customerTransactionId": "AnyCo_order870134702",
"output": {
"countryDetails": {
"category": "Regulatory",
"countryCode": "MM",
"shipmentDetails": {
"commodityIndex": 10,
"level": "ERROR",
"regulatoryCountryAdvisories": {
"messages": [
{
"code": "1",
"localizedText": "Documentation requise",
"parameters": [
{
"id": "7",
"value": "Exempt"
},
{
"id": "5",
"value": "Required"
},
{
"id": "4",
"value": "Required"
}
],
"text": "Duty Exemption Not Applicable"
},
{
"code": "8",
"localizedText": "Documentation requise",
"parameters": [
{
"id": "6",
"value": "Restricted"
},
{
"id": "3",
"value": "Exempt"
}
],
"text": "Import Restrictions Apply"
},
{
"code": "1",
"localizedText": "Exonération de droits non applicable",
"parameters": [
{
"id": "0",
"value": "Required"
},
{
"id": "3",
"value": "Exempt"
},
{
"id": "7",
"value": "Restricted"
},
{
"id": "1",
"value": "Required"
}
],
"text": "Import Restrictions Apply"
},
{
"code": "7",
"localizedText": "Les restrictions d'importation s'appliquent",
"parameters": [
{
"id": "0",
"value": "Exempt"
},
{
"id": "8",
"value": "Exempt"
},
{
"id": "8",
"value": "Restricted"
},
{
"id": "8",
"value": "Required"
}
],
"text": "Import Restrictions Apply"
}
],
"types": "DUTY_TAX"
},
"regulatoryDocuments": {
"agencyName": "Environmental Agency",
"agencyUrl": "https://evil-roadway.net",
"allowability": "REQUIRED",
"documentType": "EEI_FILING",
"documentUrl": "https://deafening-lounge.name",
"fileName": "above_ride_gadzooks.[object Object]",
"id": "lKF2VIKQwI",
"localizedAttributes": {
"description": "Savor the crunchy essence in our Shirt, designed for shrill culinary adventures",
"localization": {
"localeCode": "jp",
"localization": "FR"
},
"name": "Rustic Ceramic Chair"
},
"supportType": "PRINT_ONLY",
"userMessage": {
"code": "7",
"index": 18,
"localizedText": "Les dimensions du colis sont requises pour le calcul du fret.",
"messageParameters": [
{
"id": "0",
"value": "Contact information for recipient is missing."
},
{
"id": "7",
"value": "Declaration of contents needed for customs clearance."
},
{
"id": "5",
"value": "Declaration of contents needed for customs clearance."
}
],
"text": "Duis ex"
}
},
"regulatoryStatements": {
"agencyName": "Environmental Protection Agency",
"agencyUrl": "https://fearless-step.net/",
"allowability": "PROHIBITED",
"completionType": "COMPLETE",
"documentIds": [
"DOC004",
"DOC009",
"DOC008",
"DOC005"
],
"documentUrl": "https://heavy-making.biz",
"fileName": "honored_word.[object Object]",
"id": "HJFKi-q4Mut",
"localizedAttributes": {
"description": "New lavender Fish with ergonomic design for cheap comfort",
"localization": {
"localeCode": "ca",
"localization": "ZH"
},
"name": "Gorgeous Marble Computer"
},
"statementUrl": "https://another-humor.info",
"supportType": "FEDEX_GENERATED",
"userMessage": {
"code": "9",
"index": 13,
"localizedText": "Selon les informations fournies sur l'envoi, seul le type de produit / document est autorisé pour cet envoi",
"messageParameters": [
{
"id": "0",
"value": "Commodity description is too vague."
},
{
"id": "0",
"value": "Based on shipment information provided, only non-document/commodity type is permitted for this shipment"
},
{
"id": "0",
"value": "Package dimensions required for freight calculation."
},
{
"id": "7",
"value": "Declaration of contents needed for customs clearance."
},
{
"id": "0",
"value": "Package dimensions required for freight calculation."
}
],
"text": "officia ad"
}
},
"requiredCommodityUnitsOfMeasure": [
"LB",
"LIT"
]
}
},
"cxsalerts": [
{
"alertType": "WARNING",
"code": "ALERT_02",
"message": "Customs clearance notice",
"parameterList": [
{
"key": "forceValidation",
"value": "FALSE"
},
{
"key": "forceValidation",
"value": "TRUE"
},
{
"key": "ignoreWarnings",
"value": "FALSE"
},
{
"key": "ignoreWarnings",
"value": "TRUE"
}
]
},
{
"alertType": "NOTE",
"code": "ALERT_03",
"message": "Operational delay detected",
"parameterList": [
{
"key": "forceValidation",
"value": "TRUE"
},
{
"key": "ignoreWarnings",
"value": "FALSE"
},
{
"key": "forceValidation",
"value": "FALSE"
},
{
"key": "ignoreWarnings",
"value": "FALSE"
},
{
"key": "forceValidation",
"value": "TRUE"
}
]
},
{
"alertType": "NOTE",
"code": "ALERT_01",
"message": "Customs clearance notice",
"parameterList": [
{
"key": "ignoreWarnings",
"value": "FALSE"
},
{
"key": "forceValidation",
"value": "TRUE"
}
]
},
{
"alertType": "NOTE",
"code": "ALERT_03",
"message": "Service maintenance alert",
"parameterList": [
{
"key": "forceValidation",
"value": "FALSE"
},
{
"key": "forceValidation",
"value": "FALSE"
},
{
"key": "ignoreWarnings",
"value": "FALSE"
}
]
}
],
"userMessages": [
{
"code": "6",
"index": 22,
"localizedText": "Les informations sur le pays de fabrication sont manquantes.",
"messageParameters": [
{
"id": "4",
"value": "Commodity description is too vague."
},
{
"id": "4",
"value": "Country of manufacture information is missing."
},
{
"id": "2",
"value": "Based on shipment information provided, only non-document/commodity type is permitted for this shipment"
}
],
"text": "ullamco dolor"
},
{
"code": "4",
"index": 10,
"localizedText": "Déclaration du contenu nécessaire pour le dédouanement.",
"messageParameters": [
{
"id": "1",
"value": "Package dimensions required for freight calculation."
},
{
"id": "6",
"value": "Shipping instructions unclear for perishable items."
},
{
"id": "3",
"value": "Contact information for recipient is missing."
}
],
"text": "esse in Duis dolore quis"
}
]
},
"transactionId": "af610fba-e10f-4d9f-a155-7603cbf8ffa7"
}{
"transactionId": "624deea6-b709-470c-8c39-4b5511281492",
"customerTransactionId": "AnyCo_order123456789",
"errors": [
{
"code": "SYSTEM.GENERAL.ERROR",
"message": "We are unable to process this request for the moment. Try again later or contact FedEx Customer Service."
}
]
}{
"errors": [
{
"code": "NOT.AUTHORIZED.ERROR",
"message": {
"description": "Indicates the description of API error alert message.<br>Example: Access token expired. Please modify your request and try again."
},
"parameterList": [
{
"key": "forceValidation",
"value": "TRUE"
},
{
"key": "ignoreWarnings",
"value": "FALSE"
},
{
"key": "ignoreWarnings",
"value": "FALSE"
},
{
"key": "ignoreWarnings",
"value": "FALSE"
}
]
}
],
"transactionId": "c5eb420d-56df-426a-bec7-750849a78be9"
}{
"errors": [
{
"code": "NOT.FOUND.ERROR",
"message": {
"description": "Indicates the description of API error alert message.<br>Example: The resource you requested is no longer available. Please modify your request and try again."
},
"parameterList": [
{
"key": "forceValidation",
"value": "FALSE"
},
{
"key": "forceValidation",
"value": "TRUE"
}
]
},
{
"code": "NOT.FOUND.ERROR",
"message": {
"description": "Indicates the description of API error alert message.<br>Example: The resource you requested is no longer available. Please modify your request and try again."
},
"parameterList": [
{
"key": "forceValidation",
"value": "FALSE"
},
{
"key": "ignoreWarnings",
"value": "TRUE"
}
]
}
],
"transactionId": "992d075c-7c66-476a-945a-913a0f51c057"
}{
"errors": [
{
"code": "INVALID.INPUT.EXCEPTION",
"message": {
"description": "Validation failed for the object='shipmentRegulatoryDetailsInputVO'.Error count:1"
},
"parameterList": [
{
"key": "ignoreWarnings",
"value": "TRUE"
}
]
}
],
"transactionId": "4c24a98c-4dcc-474a-ae86-adb044a7afc2"
}{
"customerTransactionId": "AnyCo_order948581249",
"errors": [
{
"code": "INTERNAL.SERVER.ERROR",
"message": {
"description": "Indicates the description of API error alert message.<br>Example: We encountered an unexpected error and are working to resolve the issue. We apologize for any inconvenience. Please check back at a later time."
},
"parameterList": [
{
"key": "ignoreWarnings",
"value": "FALSE"
},
{
"key": "ignoreWarnings",
"value": "TRUE"
},
{
"key": "ignoreWarnings",
"value": "FALSE"
}
]
},
{
"code": "INTERNAL.SERVER.ERROR",
"message": {
"description": "Indicates the description of API error alert message.<br>Example: We encountered an unexpected error and are working to resolve the issue. We apologize for any inconvenience. Please check back at a later time."
},
"parameterList": [
{
"key": "ignoreWarnings",
"value": "TRUE"
},
{
"key": "forceValidation",
"value": "FALSE"
},
{
"key": "ignoreWarnings",
"value": "FALSE"
},
{
"key": "forceValidation",
"value": "TRUE"
}
]
}
],
"transactionId": "c1243192-c97b-41ff-b8a1-b0cb83490d30"
}Service Homepage: developer.fedex.com/api/en-us/catalog/global-trade/v1/docs.html
fedexlogisticsshippingglobal-tradecustoms