{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/fedex/json-schema/fedex-body-specialserviceoptions-schema.json", "title": "body_specialserviceoptions", "x-generated": "2026-11-05", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/fedex-service-availability-api-openapi.yml#/components/schemas/body_specialserviceoptions", "oneOf": [ { "$ref": "#/$defs/Full_Schema_Special_Service_Options" }, { "$ref": "#/$defs/Special_Service_Options_Domestic_Ground" }, { "$ref": "#/$defs/Special_Service_Options_Domestic_Express" }, { "$ref": "#/$defs/Special_Service_Options_International_Express" }, { "$ref": "#/$defs/Special_Service_Options_International_Express_Freight" } ], "$defs": { "AccountNumber": { "description": "Specify the Account number.", "allOf": [ { "$ref": "#/$defs/AccountNumber1" } ] }, "AccountNumber1": { "type": "object", "properties": { "value": { "type": "string", "description": "This is the account number. Max Length is 9. Example: Your account number" } }, "description": "This is FedEx account number details." }, "Address": { "required": [ "countryCode" ], "type": "object", "properties": { "streetLines": { "type": "array", "description": "This is a combination of number, street name, etc.
Note: At least one line is required and streetlines more than 3 will be ignored. Empty lines should not be included.
Example: [\\\"10 FedEx Parkway\"\\, \\\"Suite 302\"\\]", "items": { "type": "string" } }, "city": { "type": "string", "description": "This is a placeholder for City Name.
Example: Beverly Hills" }, "stateOrProvinceCode": { "type": "string", "description": "This is a placeholder for State or Province code.
Example: CA
Click here to see State/Province Code" }, "postalCode": { "description": "This is the Postal code. This is Optional for non postal-aware countries. Max length is 10.
Example: 65247
Click here to see Postal aware countries" }, "countryCode": { "description": "This is a Two-letter country code.Max length is two.
Example: US
Click here to see Country Codes" }, "residential": { "type": "boolean", "description": "Indicate whether this address is Residential as opposed to Commercial.", "enum": [ true, false ] } }, "description": "This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (such as a city-state-ZIP combination within the US). Country code is required. Postal code is required for postal aware countries." }, "AddressAncillaryDetail": { "type": "object", "properties": { "locationInCity": { "type": "string", "description": "This is the Subdivision or community within a city for the given address.
Forester subdivision" }, "suite": { "type": "string", "description": "This is the suite information for the given address." }, "addressVerificationOverrideReason": { "type": "string", "description": "Specifies the reason to override address verification.
Valid values: CUSTOMER_PREFERENCE, CUSTOMER_PROVIDED_PROOF, MANUAL_VALIDATION" }, "locationInProperty": { "type": "string", "description": "This is location in a campus, such as exterior building annex A.
Example: south west of main office entrance." }, "addtionalDescriptions": { "type": "string", "description": "Specifies any additional information about the given address.
Example: north door" }, "department": { "type": "string", "description": "This is the department for the given address.
Example: Claims department" }, "roomFloor": { "type": "string", "description": "This is to specify the room or floor information for the given address.
Example: 5th floor" }, "crossStreet": { "type": "string", "description": "This is the cross street information for the given address.
Example: Union and Main" }, "building": { "type": "string", "description": "This is the building information for the given address.
Example: Building 300" }, "apartment": { "type": "string", "description": "This is the apartment information for the given address.
Example: Apartment 1503" }, "room": { "type": "string", "description": "This is room specific information for the given address.
Example: Room B-23" } }, "description": "specifies additional address details for the physical location" }, "AlcoholDetail": { "required": [ "alcoholRecipientType" ], "type": "object", "properties": { "alcoholRecipientType": { "type": "string", "description": "Specify the Alcohol Recipient Type of the shipment.
Example:
", "enum": [ "LICENSEE", "CONSUMER" ] }, "shipperAgreementType": { "type": "string", "description": "Specify the type of entity, the shipper for alcohol shipment is registered such as fulfillment house, retailer or a winery." } }, "description": "These are details for the package containing alcohol. This is required for alcohol special service. The alcoholRecipientType is required." }, "BatteryDetail": { "type": "object", "properties": { "batteryPackingType": { "type": "string", "description": "Describe the packing arrangement of the battery or cell with respect to other items within the same package.", "enum": [ "CONTAINED_IN_EQUIPMENT", "PACKED_WITH_EQUIPMENT" ] }, "batteryRegulatoryType": { "type": "string", "description": "This is a regulation specific classification for the battery or the cell.", "enum": [ "IATA_SECTION_II" ] }, "batteryMaterialType": { "type": "string", "description": "Indicate the material composition of the battery or cell.", "enum": [ "LITHIUM_METAL", "LITHIUM_ION" ] } }, "description": "Provide details about the batteries or cells that are contained within this specific package." }, "CODDetail": { "required": [ "codCollectionAmount" ], "type": "object", "properties": { "codCollectionType": { "type": "string", "description": "Identifies the type of funds FedEx should collect upon shipment delivery.", "enum": [ "COMPANY_CHECK", "ANY", "CASH", "GUARANTEED_FUNDS", "PERSONAL_CHECK" ] }, "codCollectionAmount": { "$ref": "#/$defs/Money" } } }, "CodDetail": { "description": "Conditional
\nFor Express-only COD, populate this object for COD detail information at the shipment level. When data is provided in this object, the related COD enum will be populated automatically by RATC", "allOf": [ { "$ref": "#/$defs/CODDetail" }, { "required": [ "codCollectionAmount" ], "properties": { "codCollectionAmount": { "description": "Use this object to specify amount and currency details." } } } ] }, "CompanyName": { "type": "object", "properties": { "division": { "type": "string", "description": "This is division within a company." }, "companyCd": { "type": "string", "description": "This is Company code." }, "name": { "type": "string", "description": "This is company Name." }, "department": { "type": "string", "description": "This is department within a company" }, "storeId": { "type": "string", "description": "This is Store identifier within a company." } }, "description": "Use this to provide Company details." }, "Contact": { "type": "object", "properties": { "personName": { "type": "string", "description": "Specify contact name.Max Length is 70." }, "emailAddress": { "type": "string", "description": "Specify contact email address. Max length is 80." }, "phoneNumber": { "type": "string", "description": "Specify contact person's phone number. Max length is 15." }, "phoneExtension": { "type": "string", "description": "Specify contact person's phone extension. Max length is 6." }, "faxNumber": { "type": "string", "description": "Specify contact person's fax number. Max length is 15." } }, "description": "Indicate the contact details for this shipment." }, "Contact1": { "type": "object", "properties": { "personName": { "type": "string", "description": "Specify the recipient contact person's name. Max Length is 70.
Example: John Taylor" }, "emailAddress": { "type": "string", "description": "Contact person's email address. Max length is 80.
Example: sample@company.com" }, "phoneNumber": { "type": "string", "description": "Contact person's phone number. Max length is 15.
Example: 1234567890" }, "phoneExtension": { "type": "string", "description": "contact person's phone extension. Max length is 6.
Example: 91" }, "faxNumber": { "type": "string", "description": "Contact person's fax number. Max length is 15.
Example: 956123" }, "companyName": { "type": "string", "description": "Specify contact person's company name. Max length is 35.
Example: FedEx" } }, "description": "Contact details for the Party such as Name, Email, PhoneNumber" }, "ContactAncillaryDetail": { "type": "object", "properties": { "emailAddresses": { "type": "array", "description": "These are contact email addresses.", "items": { "$ref": "#/$defs/EMailDetail" } }, "prefix": { "type": "string", "description": "Specify the Prefix." }, "phoneNumberDetails": { "type": "array", "description": "Phone Number Details", "items": { "$ref": "#/$defs/PhoneNumberDetail" } }, "companyName": { "$ref": "#/$defs/CompanyName" }, "title": { "type": "string", "description": "Indicate the contact title." } }, "description": "Indicate additional contact details such as email and phone information." }, "ContactAndAddress": { "type": "object", "properties": { "contact": { "$ref": "#/$defs/Contact" }, "contactAncillaryDetail": { "$ref": "#/$defs/ContactAncillaryDetail" }, "address": { "$ref": "#/$defs/Address" }, "addressAncillaryDetail": { "$ref": "#/$defs/AddressAncillaryDetail" } }, "description": "Specifies the contact and address details of a location." }, "ContentRecord": { "type": "object", "properties": { "itemNumber": { "type": "string", "description": "This is a package item number.
Example: 45673289" }, "receivedQuantity": { "type": "integer", "description": "This is the package item quantity.
Example: 2", "format": "int32" }, "description": { "type": "string", "description": "This is the description of the package item." }, "partNumber": { "type": "string", "description": "This is the part Number
Example: 123" } }, "description": "package/shipment content details" }, "CoverageAmount": { "description": "Specifies the Liability Coverage Amount & Currency used for Freight Shipment.", "allOf": [ { "$ref": "#/$defs/Money" } ] }, "CustomerReference": { "type": "object", "properties": { "customerReferenceType": { "type": "string", "description": "This is a customer reference type. Note: Use type as RMA_ASSOCIATION and value as the RMA Number to associate Ground Call Tag shipments to the outbound shipment.
For more information, click here for Cutsomer References", "enum": [ "BILL_OF_LADING", "CUSTOMER_REFERENCE", "DEPARTMENT_NUMBER", "INVOICE_NUMBER", "P_O_NUMBER", "SHIPMENT_INTEGRITY", "INTRACOUNTRY_REGULATORY_REFERENCE", "STORE_NUMBER", "RMA_ASSOCIATION", "SHIPPER_ID1", "SHIPPER_ID2" ] }, "value": { "type": "string", "description": "This is a customer reference type value.
Example: 3686" } } }, "DangerousGoodsDetail": { "type": "object", "properties": { "accessibility": { "type": "string", "description": "Specify the Dangerous Goods Accessibility Type. Valid Values: ", "enum": [ "ACCESSIBLE", "INACCESSIBLE" ] }, "options": { "type": "array", "description": "Indicate the kind of content being reported.", "items": { "type": "string", "enum": [ "HAZARDOUS_MATERIALS", "BATTERY", "ORM_D", "REPORTABLE_QUANTITIES", "SMALL_QUANTITY_EXCEPTION", "LIMITED_QUANTITIES_COMMODITIES" ] } } }, "description": "Use this object to provide Dangerous Goods Detail in the shipment." }, "Dimensions": { "description": "Indicate the dimensions of the package.
Following conditions will apply: Note: The maximum/minimum dimension values varies based on the services and the packaging types. Refer FedEx Service Guide for service details related to DIM Weighting for FedEx Express and oversize conditions for FedEx Express and FedEx Ground.", "allOf": [ { "$ref": "#/$defs/Dimensions1" }, { "properties": { "height": { "description": "Indicate the height of the package. No implied decimal places. Maximum value: 999
Example: 10" }, "length": { "description": "Indicate the length of the package. No implied decimal places. Maximum value: 999
Example: 20" }, "units": { "description": "Indicate the Unit of measure for the provided dimensions.
Valid Values are: Note: Any value other than CM including blank/null will default to IN.
Example: CM" }, "width": { "description": "Indicate the width of the package. No implied decimal places. Maximum value: 999
Example: 10" } } } ] }, "Dimensions1": { "type": "object", "properties": { "length": { "type": "integer", "description": "Indicate the length of the package. No implied decimal places. Maximum value: 999
Example: 20", "format": "int32" }, "width": { "type": "integer", "description": "Indicate the width of the package. No implied decimal places. Maximum value: 999
Example: 10", "format": "int32" }, "height": { "type": "integer", "description": "Indicate the height of the package. No implied decimal places. Maximum value: 999
Example: 10", "format": "int32" }, "units": { "type": "string", "description": "Indicate the Unit of measure for the provided dimensions.
Valid Values are: