{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/fedex/json-schema/fedex-regulatorydetails-retrieve-body-schema.json", "title": "regulatorydetails_retrieve_body", "x-generated": "2026-11-05", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/fedex-global-trade-api-openapi.yml#/components/schemas/regulatorydetails_retrieve_body", "oneOf": [ { "$ref": "#/$defs/FullSchema" }, { "$ref": "#/$defs/MinimumSamplePayload" } ], "$defs": { "Address": { "required": [ "countryCode" ], "type": "object", "properties": { "countryCode": { "type": "string", "description": "Indicate the 2-character ISO country code.
Maximum length is 2.
Example: US
click here to see Country codes" }, "postalCode": { "type": "string", "description": "This is the postal code.
Note: This is Optional for non postal-aware countries. Maximum length is 10.
Example: 65247
click here to see Postal aware countries" }, "stateOrProvinceCode": { "type": "string", "description": "This is a placeholder for state or province code.
Example: CA.
click here to see State or Province Code" } }, "description": "Address Model" }, "CommercialInvoice": { "type": "object", "properties": { "freightCharge": { "description": "Indicate the freight charge.", "allOf": [ { "$ref": "#/$defs/Money" } ] }, "purpose": { "type": "string", "description": "It describes the purpose." } }, "description": "Use this object to provide Commercial Invoice details. This element is required for electronic upload of CI data. It will serve to create/transmit an electronic Commercial Invoice through the FedEx system.
Customers are responsible for printing their own Commercial Invoice.
If you would like FedEx to generate a Commercial Invoice and transmit it to Customs for clearance purposes, you need to specify that in the ETDDetail/RequestedDocumentCopies element.
Supports maximum of 99 commodity line items." }, "CommodityVO": { "required": [ "harmonizedCode" ], "type": "object", "properties": { "quantity": { "type": "string", "description": "Total number of units (using quantityUnits as the unit of measure) of this commodity present in the shipment.
Example: '1'" }, "quantityUOM": { "type": "string", "description": "This is the units quantity per commodity. This is used to estimate duties and taxes in GTC.
Example: 125" }, "customsValue": { "description": "Required
Customs value for this commodity", "allOf": [ { "$ref": "#/$defs/Money" } ] }, "countryOfManufacture": { "type": "string", "description": "Required
Max Length is 4
Example: IN" }, "name": { "type": "string", "description": "This represents the name of commodity." }, "harmonizedCode": { "type": "string", "description": "This is to specify the Harmonized Tariff System (HTS) code to meet U.S. and foreign governments' customs requirements. These are mainly used to estimate the duties and taxes.
Example: 0613
To research the classification for your commodity, use the FedEx Global Trade Manager online at fedex.com/gtm. You will find country-specific information to determine whether your commodity is considered to be a document or non-document for your destination." }, "description": { "type": "string", "description": "This represents commodity description" }, "weight": { "description": "Represents Weight of the packages or shipment.", "allOf": [ { "$ref": "#/$defs/Weight" } ] }, "commodityId": { "type": "integer", "description": "This represents the commodity id", "format": "int32" }, "additionalMeasures": { "$ref": "#/$defs/Measure" } } }, "CustomsClearanceDetailVO": { "required": [ "commodities", "customsValue" ], "type": "object", "properties": { "regulatoryControls": { "type": "array", "description": "These are the Regulatory Controls applicable to the shipment.", "items": { "type": "string", "enum": [ "FOOD_OR_PERISHABLE", "USMCA", "NOT_APPLICABLE_FOR_LOW_VALUE_CUSTOMS_EXCEPTIONS", "NOT_IN_FREE_CIRCULATION" ] } }, "insuranceCharges": { "$ref": "#/$defs/Money_1" }, "importerOfRecordAccountNumber": { "description": "The descriptive data for the importer of Record for the shipment and account number information.", "allOf": [ { "$ref": "#/$defs/Party" } ] }, "customsValue": { "$ref": "#/$defs/Money" }, "commercialInvoice": { "$ref": "#/$defs/CommercialInvoice" }, "commodities": { "type": "array", "items": { "$ref": "#/$defs/CommodityVO" } }, "documentContent": { "type": "string", "description": "Defaults to COMMODITY. Only used for int'l Express requests to indicate if just documents are being shipped or not.", "enum": [ "DOCUMENT", "COMMODITY" ] } }, "description": "These are customs clearance details.
Required for International and intra-country Shipments." }, "FullSchema": { "required": [ "carrierCode", "destinationAddress", "originAddress" ], "type": "object", "properties": { "serviceType": { "type": "string", "description": "Specify the type of service that is used to ship the package.
click here to see Service Types" }, "totalCommodityValue": { "description": "Specify the total commodity value. Either customsClearenceDetail or totalCommodityValue is required.", "allOf": [ { "$ref": "#/$defs/Money" } ] }, "originAddress": { "description": "Provide the shipment origin address details.", "allOf": [ { "$ref": "#/$defs/Address" } ] }, "destinationAddress": { "description": "Provide the shipment destination address details.", "allOf": [ { "$ref": "#/$defs/Address" } ] }, "serviceOptionType": { "type": "array", "description": "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.", "items": { "type": "string", "description": "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.
Example: [FEDEX_ONE_RATE, SATURDAY_DELIVERY]", "enum": [ "FEDEX_ONE_RATE", "FREIGHT_GUARANTEE", "SATURDAY_DELIVERY", "SMART_POST_ALLOWED_INDICIA", "SMART_POST_HUB_ID" ] } }, "customsClearanceDetail": { "description": "Specify the Customs clearance details.Either customsClearenceDetail or totalCommodityValue is required.", "allOf": [ { "$ref": "#/$defs/CustomsClearanceDetailVO" } ] }, "shipDate": { "type": "string", "description": "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": { "type": "string", "description": "Specify the four letter code of a FedEx operating company that meets your requirements.

Valid values are: