{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/fedex/json-schema/fedex-modify-consolidation-response-schema.json", "title": "ModifyConsolidationResponse", "description": "Wrapper class for ModifyConsolidationOutputVO. It holds transactionId and output.", "x-generated": "2026-11-05", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/fedex-consolidation-api-openapi.yml#/components/schemas/ModifyConsolidationResponse", "type": "object", "properties": { "customerTransactionId": { "type": "string", "description": "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.
Example: AnyCo_order123456789" }, "transactionId": { "type": "string", "description": "The transaction ID is a special set of numbers that defines each transaction.
Example: 624deea6-b709-470c-8c39-4b5511281492" }, "output": { "$ref": "#/$defs/ModifyConsolidationOutputVO" } }, "$defs": { "AccountNumber": { "description": "This is the FedEx Account number.
Example: 123456789", "allOf": [ { "$ref": "#/$defs/PartyAccountNumber" } ] }, "AddressAncillaryDetail": { "type": "object", "properties": { "locationInCity": { "type": "string", "description": "Subdivision or community within a city
Example: Forester subdivision" }, "suite": { "type": "string", "description": "suite information for the address
Example: suite 201" }, "addressVerificationOverrideReason": { "type": "string", "description": "Indicates the reason to override address verification.
Valid values: CUSTOMER_PREFERENCE, CUSTOMER_PROVIDED_PROOF, MANUAL_VALIDATION" }, "locationInProperty": { "type": "string", "description": "Location in a campus, such as exterior building annex A.
Example: south west of main office entrance" }, "addtionalDescriptions": { "type": "string", "description": "Any additionl descriptions.
Example: north door" }, "department": { "type": "string", "description": "Department information for the address.
Example: Claims department" }, "roomFloor": { "type": "string", "description": "Room or floor information for the address.
Example: 5th floor" }, "crossStreet": { "type": "string", "description": "Cross Street information for the address.
Example: Union and Main" }, "building": { "type": "string", "description": "Building information for the address.
Example: Building 300" }, "apartment": { "type": "string", "description": "Apartment information for the address.
Example: Apartment 1503" }, "room": { "type": "string", "description": "Room specific information for the address.
Example: Room B-23" } }, "description": "Indicates additional address details for the physical location." }, "Address_1": { "required": [ "city", "countryCode", "streetLines" ], "type": "object", "properties": { "streetLines": { "type": "array", "description": "Combination of number, street name, etc. At least one line is required for a valid physical address. Empty lines should not be included. Max Length is 35.
Example: [1550 Union Blvd,Suite 302]", "items": { "type": "string" } }, "city": { "maxLength": 35, "type": "string", "description": "The name of city, town of the recipient.Max length is 35.
Example: Beverly Hills" }, "stateOrProvinceCode": { "type": "string", "description": "The US State and Canada Province codes. The Format and presence of this field may vary depending on the country.
Example: CA" }, "postalCode": { "type": "string", "description": "This is the postal code.Note: This is Optional for non postal-aware countries. Maximum length is 10.
Example: 65247" }, "countryCode": { "type": "string", "description": "The two-letter code used to identify a country. Max length is 2.
Click here to see Country Codes" }, "residential": { "type": "boolean", "description": "Indicates whether this address is residential (as opposed to commercial)." } }, "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)." }, "Address_2": { "type": "object", "properties": { "streetLines": { "type": "array", "description": "Combination of number, street name, etc. At least one line is required for a valid physical address. Empty lines should not be included. Max Length is 35.
Example: [1550 Union Blvd,Suite 302]", "items": { "type": "string" } }, "city": { "maxLength": 35, "type": "string", "description": "The name of city, town of the recipient.Max length is 35.
Example: Beverly Hills" }, "stateOrProvinceCode": { "type": "string", "description": "The US State and Canada Province codes. The Format and presence of this field may vary depending on the country.
Example: CA" }, "postalCode": { "type": "string", "description": "This is the postal code.Note: This is Optional for non postal-aware countries. Maximum length is 10.
Example: 65247" }, "countryCode": { "type": "string", "description": "The two-letter code used to identify a country. Max length is 2.
Click here to see Country Codes" }, "residential": { "type": "boolean", "description": "Indicates whether this address is residential (as opposed to commercial)." } }, "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)." }, "BrokerDetail": { "type": "object", "properties": { "broker": { "description": "These are broker details for the shipment with physical address, contact and account number information.", "allOf": [ { "$ref": "#/$defs/Party_1" }, { "required": [ "address", "contact" ], "properties": { "address": { "description": "Broker address details." }, "contact": { "description": "Broker contact details." } } } ] }, "type": { "type": "string", "description": "Identifies the type of Broker." } }, "description": "Broker details for the shipment" }, "CarrierCode": { "type": "string", "description": "Specifies which carrier should be included.
Example: FDXE" }, "ClearanceItemDetail": { "type": "object", "properties": { "role": { "type": "string", "description": "Role in producing or supplying the item/commodity", "enum": [ "MANUFACTURER" ] }, "id": { "type": "string", "description": "Unique identifier of the manufacturer of the commodity.
For shipments to United States, refer to U.S. Customs and Border Protection website.
Example: USGRE98BIR" }, "contact": { "$ref": "#/$defs/ClearanceItemDetail_contact" }, "address": { "$ref": "#/$defs/ClearanceItemDetail_address" } } }, "ClearanceItemDetail_address": { "type": "object", "properties": { "streetLines": { "type": "array", "description": "Combination of number, street name, etc. At least one line is required for a valid physical address. Empty lines should not be included.
Example: 98 Royal Crescent", "items": { "type": "string" } }, "city": { "type": "string", "description": "The name of city, town of the recipient.
Example: Birmingham" }, "stateOrProvinceCode": { "type": "string", "description": "It is used to identify the principal subdivisions (e.g., provinces or states) of countries. The Format and presence of this field may vary depending on the country.
Example: CA" }, "postalCode": { "type": "string", "description": "The US State and Canada Province codes. The Format and presence of this field may vary depending on the country.
Example: 35209" }, "countryCode": { "type": "string", "description": "The two-letter code used to identify a country.
Example: US" }, "residential": { "type": "boolean", "description": "Indicate whether this address is Residential (as opposed to Commercial).
Valid Values: True or False." } }, "description": "Address of the manufacturer." }, "ClearanceItemDetail_contact": { "type": "object", "properties": { "companyName": { "type": "string", "description": "Legal name of the manufacturer of the commodity.
Example: THE GREENHOUSE" } }, "description": "Contact details of the manufacturer." }, "Commodity": { "required": [ "description", "numberOfPieces" ], "type": "object", "properties": { "name": { "type": "string", "description": "Specify the commodity name" }, "numberOfPieces": { "type": "integer", "description": "Indicates the number of pieces associated with the commodity. Number of pieces cannot be a negative value or exceed 9,999.", "format": "int32" }, "description": { "type": "string", "description": "This is the commodity description. Maximum allowed 450 characters." }, "cIMarksAndNumbers": { "type": "string", "description": "This is an identifying mark or number used on the packaging of a shipment to help customers identify a particular shipment
Example: 125SU212061F7" }, "countryOfManufacture": { "type": "string", "description": "This is commodity country of manufacture. This is required for International shipments. Maximum allowed length is 4." }, "weight": { "$ref": "#/$defs/Weight" }, "quantity": { "type": "integer", "description": "This is the units quantity (using quantityUnits as the unit of measure) per commodity. This is used to estimate duties and taxes.", "format": "int32" }, "quantityUnits": { "type": "string", "description": "This is the unit of measure for the units quantity. This is used to estimate duties and taxes." }, "unitPrice": { "$ref": "#/$defs/Money" }, "customsValue": { "$ref": "#/$defs/Money" }, "commodityId": { "type": "string", "description": "Value used to identify a commodity description; must be unique within the containing shipment." }, "clearanceItemDetail": { "type": "array", "description": "Array of clearance item details including manufacturer info for customs clearance.", "items": { "$ref": "#/$defs/ClearanceItemDetail" } } } }, "ConsolidationCustomsDeclarationStatementDetail": { "type": "object", "properties": { "types": { "type": "array", "description": "It indicates the different statements, declarations, acts, and/or certifications that apply to this shipment.", "items": { "type": "string" } } }, "description": "This provides the information necessary to identify the different statements,declarations, acts, and/or certifications that apply to this shipment." }, "ConsolidationDataSources": { "type": "object", "properties": { "consolidationDataType": { "type": "string", "description": "Identifies the field being specified.", "enum": [ "TOTAL_CUSTOMS_CODE", "TOTAL_FREIGHT_CHARGES", "TOTAL_HANDLING_COSTS", "TOTAL_INSURANCE_CHARGES", "TOTAL_INSURED_VALUE", "TOTAL_PACKING_COSTS", "TOTAL_TAXES_OR_MISCELLANEOUS_CHARGES" ] }, "consolidationDataSourceType": { "type": "string", "description": "Identifies how the content of the field should be determined.", "enum": [ "ACCUMULATED", "CLIENT" ] } }, "description": "Specifies how selected values in the consolidation are to be determined." }, "ConsolidationDocumentSpec": { "type": "object", "properties": { "consolidationDocumentTypes": { "type": "array", "description": "Specifies consolidation document types.
Example:", "items": { "type": "string" } }, "consolidatedCommercialInvoiceDetail": { "$ref": "#/$defs/ConsolidationDocumentSpec_consolidatedCommercialInvoiceDetail" }, "customsPackingListDetail": { "$ref": "#/$defs/ConsolidationDocumentSpec_customsPackingListDetail" }, "crnReportDetail": { "$ref": "#/$defs/ConsolidationDocumentSpec_crnReportDetail" }, "condensedCrnReportDetail": { "$ref": "#/$defs/ConsolidationDocumentSpec_condensedCrnReportDetail" }, "consolidatedCustomsLinehaulReportDetail": { "$ref": "#/$defs/ConsolidationDocumentSpec_consolidatedCustomsLinehaulReportDetail" }, "consolidatedPartyReportDetail": { "$ref": "#/$defs/ConsolidationDocumentSpec_consolidatedPartyReportDetail" }, "consolidatedSoldToSummaryReportDetail": { "$ref": "#/$defs/ConsolidationDocumentSpec_consolidatedSoldToSummaryReportDetail" }, "commoditiesByTrackingNumberDetail": { "$ref": "#/$defs/ConsolidationDocumentSpec_consolidatedSoldToSummaryReportDetail" }, "customDocumentDetails": { "type": "array", "description": "Specifies the child reference number report detail for consolidated SoldTo summary report detail.", "items": { "$ref": "#/$defs/Formats" } } }, "description": "Details of consolidation document specification" }, "ConsolidationDocumentSpec_condensedCrnReportDetail": { "type": "object", "properties": { "format": { "$ref": "#/$defs/Formats" } }, "description": "Specifies the child reference number report detail for condensed CrnReport Detail." }, "ConsolidationDocumentSpec_consolidatedCommercialInvoiceDetail": { "type": "object", "properties": { "format": { "$ref": "#/$defs/Formats" } }, "description": "Specifies consolidated commercial invoice detail." }, "ConsolidationDocumentSpec_consolidatedCustomsLinehaulReportDetail": { "type": "object", "properties": { "format": { "$ref": "#/$defs/Formats" } }, "description": "Specifies the child reference number report detail for consolidated customs linehaul report detail." }, "ConsolidationDocumentSpec_consolidatedPartyReportDetail": { "type": "object", "properties": { "format": { "$ref": "#/$defs/Formats" } }, "description": "Specifies the child reference number report detail for consolidated party report detail." }, "ConsolidationDocumentSpec_consolidatedSoldToSummaryReportDetail": { "type": "object", "properties": { "format": { "$ref": "#/$defs/Formats" } }, "description": "Specifies the child reference number report detail for consolidated SoldTo summary report detail." }, "ConsolidationDocumentSpec_crnReportDetail": { "type": "object", "properties": { "format": { "$ref": "#/$defs/Formats" } }, "description": "Specifies the child reference number report detail." }, "ConsolidationDocumentSpec_customsPackingListDetail": { "type": "object", "properties": { "format": { "$ref": "#/$defs/Formats" } }, "description": "Specifies the customs packing list detail." }, "ContactAncillaryDetail_1": { "type": "object", "properties": { "emailAddresses": { "type": "array", "description": "Email Addresses", "items": { "$ref": "#/$defs/EMailDetail_1" } } }, "description": "Indicates additional contact details for the Party such as email information." }, "ContactAndAddress": { "type": "object", "properties": { "contact": { "$ref": "#/$defs/Contact_1" }, "contactAncillaryDetail": { "$ref": "#/$defs/ContactAncillaryDetail_1" }, "address": { "$ref": "#/$defs/Address_1" }, "addressAncillaryDetail": { "$ref": "#/$defs/AddressAncillaryDetail" } }, "description": "Indicates the contact and address details of a location." }, "Contact_1": { "type": "object", "properties": { "personName": { "type": "string", "description": "Specify contact name. First 35 chars will be printed on the label, excess characters will be truncated.
Note: Either the companyName or personName is mandatory.
Example: John Taylor" }, "emailAddress": { "type": "string", "description": "Specify contact email address. Maximum length is 80.
Example: sample@company.com" }, "phoneExtension": { "type": "string", "description": "Specify contact phone extension. Maximum length is 6.
Example: 1234" }, "phoneNumber": { "type": "string", "description": "Specify contact phone number.Minimum length is 1 and supports maximum of 15 for certain countries using longer phone numbers.
Note: For US and CA, a phone number must have exactly 10 digits, plus an optional leading country code of '1' or '+1'.
Example: 918xxxxx890" }, "faxNumber": { "type": "string", "description": "Specify contact fax number.
Note: Recommended Length is 15. There's no specific validation for the fax number." }, "companyName": { "type": "string", "description": "Specify contact company name. Maximum length is 35.
Note: Either the companyName or personName is mandatory." }, "stateTaxId": { "type": "string", "description": "Specify State TaxID for the contact person." }, "fedralTaxId": { "type": "string", "description": "Specify Fedral TaxId for the contact person." } }, "description": "Indicate the contact details for this shipment." }, "CustomerReferences": { "type": "object", "properties": { "customerReferenceType": { "type": "string", "description": "This is a customer reference type. The value specified here for the element is printed on the Commercial Invoice only for tracking and label information.

Note:


Note: INTRACOUNTRY_REGULATORY_REFERENCE is applicable only in Intra-Brazil.
Click here for more information on Cutsomer References ENUMs", "enum": [ "BILL_OF_LANDING", "CUSTOMER_REFERENCE", "DEPARTMENT_NUMBER", "ELECTRONIC_PRODUCT_CODE", "INTRACOUNTRY_REGULATORY_REFERENCE", "INVOICE_NUMBER", "P_O_NUMBER", "PACKING_SLIP_NUMBER", "RMA_ASSOCIATION", "SHIPMENT_INTEGRITY", "STORE_NUMBER" ] }, "value": { "type": "string", "description": "This is a customer reference type value.
Example: 3686
Note: Maximum length for all customer references is 40 characters." } }, "description": "These are additional customer reference data for commercial invoice." }, "CustomerSpecifiedLabelDetail": { "type": "object", "properties": { "maskedData": { "type": "array", "description": "Controls which data/sections will be suppressed.", "items": { "type": "string", "enum": [ "CUSTOMS_VALUE", "DIMENSIONS", "DUTIES_AND_TAXES_PAYOR_ACCOUNT_NUMBER", "FREIGHT_PAYOR_ACCOUNT_NUMBER", "INSURED_VALUE", "PACKAGE_SEQUENCE_AND_COUNT", "SECONDARY_BARCODE", "SHIPPER_ACCOUNT_NUMBER", "SHIPPER_INFORMATION", "SUPPLEMENTAL_LABEL_DOC_TAB", "TERMS_AND_CONDITIONS", "TOTAL_WEIGHT", "TRANSPORTATION_CHARGES_PAYOR_ACCOUNT_NUMBER" ] } }, "regulatoryLabels": { "type": "array", "description": "Specifies details needed to generate any label artifacts required due to regulatory requirements", "items": { "$ref": "#/$defs/RegulatoryLabelContentDetail" } }, "docTabContent": { "$ref": "#/$defs/DocTabContent" } }, "description": "Allows customer-specified control of label content" }, "CustomsClearanceDetail": { "type": "object", "properties": { "customsOption": { "$ref": "#/$defs/CustomsOptionDetail" }, "importerOfRecord": { "description": "The descriptive data for the importer of Record for the shipment and their physical address, contact and account number information.", "allOf": [ { "$ref": "#/$defs/ImporterOfRecord" } ] }, "recipientCustomsId": { "$ref": "#/$defs/RecipientCustomsId" }, "dutiesPayment": { "$ref": "#/$defs/Payment1" }, "documentContent": { "type": "string", "description": "Specifies document content.", "enum": [ "DOCUMENTS_ONLY", "NON_DOCUMENTS", "DERIVED" ] }, "totalCustomsValue": { "$ref": "#/$defs/Money" }, "regulatoryControls": { "type": "array", "description": "RegulatoryControls", "items": { "type": "string", "enum": [ "FOOD_OR_PERISHABLE", "USMCA", "NOT_APPLICABLE_FOR_LOW_VALUE_CUSTOMS_EXCEPTIONS", "NOT_IN_FREE_CIRCULATION" ] } }, "insuranceCharges": { "description": "Amount paid to a third party for the purpose of insuring this shipment against damage or loss. Used to calculate estimated duties and taxes", "allOf": [ { "$ref": "#/$defs/Money" } ] }, "declarationStatementDetail": { "$ref": "#/$defs/ConsolidationCustomsDeclarationStatementDetail" }, "commercialInvoice": { "$ref": "#/$defs/CustomsClearanceDetail_commercialInvoice" }, "exportDetail": { "$ref": "#/$defs/ExportDetail" }, "commodities": { "type": "array", "description": "Indicates the details about the dutiable packages. Maximum upto 999 commodities per shipment.", "items": { "$ref": "#/$defs/Commodity" } }, "brokers": { "type": "array", "description": "Specify broker information. Use this option only if you are using Broker Select Option for your shipment. A country code must be specified in addition to one of the following address items: postal code, city, or location id.", "items": { "$ref": "#/$defs/BrokerDetail" } }, "clearanceBrokerage": { "type": "string", "description": "Specifies the type of brokerage to be applied to a shipment.", "enum": [ "BROKER_INCLUSIVE", "BROKER_INCLUSIVE_NON_RESIDENT_IMPORTER", "BROKER_SELECT", "BROKER_SELECT_NON_RESIDENT_IMPORTER", "BROKER_UNASSIGNED" ] }, "freightOnValue": { "type": "string", "description": "Specify the risk owner for the Freight shipment.This element is only mandatory or valid for Intra India shipments.", "enum": [ "CARRIER_RISK", "OWN_RISK" ] } }, "description": "Required for International and intra-country Shipments. Information about this package that only applies to an international (export) shipment or return." }, "CustomsClearanceDetail_commercialInvoice": { "type": "object", "properties": { "termsOfSale": { "type": "string", "description": "Specify terms Of Sale that will be populated on the Commercial Invoice (or Pro Forma). Maximum length is 3.
Valid values are:" }, "comments": { "type": "array", "description": "The comments that will populate the Commercial Invoice (or Pro Forma).", "items": { "type": "string" } }, "shipmentPurpose": { "type": "string", "description": "Specifies the purpose of shipments.", "enum": [ "GIFT", "NOT_SOLD", "PERSONAL_EFFECTS", "REPAIR_AND_RETURN", "SAMPLE", "SOLD" ] }, "freightCharge": { "$ref": "#/$defs/FreightChargeMoney" }, "taxesOrMiscellaneousCharge": { "$ref": "#/$defs/TaxesOrMiscellaneousCharges" }, "taxesOrMiscellaneousChargeType": { "type": "string", "description": "Specifice the kind of tax or miscellaneous charge being reported on a Commercial Invoice.", "enum": [ "COMMISSIONS", "DISCOUNTS", "HANDLING_FEES", "OTHER", "ROYALTIES_AND_LICENSE_FEES", "TAXES" ] }, "packingCosts": { "$ref": "#/$defs/PackingCostCharges" }, "handlingCosts": { "$ref": "#/$defs/HandlingCostCharges" }, "specialInstructions": { "type": "string", "description": "The special instructions that will populate the Commercial Invoice (or Pro Forma).
Example: specialInstructions" }, "declarationStatement": { "type": "string", "description": "For licensed/ECCN shipments, the Destination Control Statement is fixed and non-editable; shippers who need a different statement must supply their own commercial invoice.
Example: declarationStatement" }, "paymentTerms": { "type": "string", "description": "The payment terms that will populate the Commercial Invoice (or Pro Forma). This field is being supported for completeness only.
Example: payment terms" }, "purposeOfShipmentDescription": { "type": "string", "description": "This is the reason for the shipment.
Note: SOLD is not a valid purpose for a Proforma Invoice.", "enum": [ "GIFT", "NOT_SOLD", "PERSONAL_EFFECTS", "REPAIR_AND_RETURN", "SAMPLE", "SOLD" ] }, "customerReferences": { "$ref": "#/$defs/CustomerReferences" }, "originatorName": { "type": "string", "description": "The originatorName that will populate the Commercial Invoice (or Pro Forma)." } }, "description": "Use this object to provide Commercial Invoice details.
This element is required if a FedEx generated Consolidated Commercial Invoice is requested.
To request a FedEx generated Consolidated Commercial Invoice include \"CONSOLIDATED_COMMERCIAL_INVOICE\" value in the \"consolidationDocumentTypes\" array, in the \"consolidationDocumentSpecification\" object.
Customers are responsible for printing the Consolidated Commercial Invoice." }, "CustomsOptionDetail": { "type": "object", "properties": { "description": { "type": "string", "description": "Specify additional description about customs options. This is a required field when the Type is OTHER." }, "type": { "type": "string", "description": "Specify the reason for a global return, as recognized by Customs. Valid values:", "enum": [ "COURTESY_RETURN_LABEL", "EXHIBITION_TRADE_SHOW", "FAULTY_ITEM", "FOLLOWING_REPAIR", "FOR_REPAIR", "ITEM_FOR_LOAN", "OTHER", "REJECTED", "REPLACEMENT", "TRIAL" ] } }, "description": "Customs Option Detail, type must be indicated for each occurrence" }, "DestinationControlDetail": { "required": [ "statementTypes" ], "type": "object", "properties": { "endUser": { "type": "string", "description": "Specify End User name. Its is required if StatementTypes is entered as DEPARTMENT_OF_STATE." }, "statementTypes": { "type": "string", "description": "Specify appropriate destination control statement type(s), Also make sure to specify destination country and end user. Type", "enum": [ "DEPARTMENT_OF_COMMERCE", "DEPARTMENT_OF_STATE" ] }, "destinationCountries": { "type": "array", "description": "Specify DCS shipment destination country. You may enter up to four country codes in this element. Up to 11 alphanumeric characters are allowed.
click here to see Country codes", "items": { "type": "string" } } }, "description": "Use this object to specify the appropriate destination control statement type(s). Also make sure to specify destination country and end user." }, "Dimensions": { "type": "object", "properties": { "length": { "type": "integer", "description": "Indicates the length of the package. No implied decimal places.", "format": "int32" }, "width": { "type": "integer", "description": "Indicates the width of the package. No implied decimal places.", "format": "int32" }, "height": { "type": "integer", "description": "Indicates the height of the package. No implied decimal places.", "format": "int32" }, "units": { "type": "string", "description": "Unit of measure for the provided dimensions.
Valid Values are IN - inches, CM - centimeters.
Note: Any value other than CM including blank/null will default to IN.", "enum": [ "CM", "IN" ] } }, "description": "Conditional.
The dimensions of the package; length, width & height. All three dimensions must be indicated.
Note: Dimensions are required with YOUR_PACKAGING package type." }, "DistributionLocations": { "type": "object", "properties": { "type": { "type": "string", "description": "Specifies the type of distribution locations.", "enum": [ "CUSTOMER_SPECIFIED", "FEDEX_EXPRESS_FREIGHT_RAMP", "FEDEX_EXPRESS_STATION", "FEDEX_GROUND_TERMINAL" ] }, "locationNumber": { "type": "integer", "description": "Specifies the location number." }, "id": { "type": "string", "description": "This is a customer-specified or system-assigned identifier that uniquely identifies the specific distibution location within a collection of distribution locations. This is not the same as the FedEx locationId or locationNumber..
Example: 123" }, "locationId": { "type": "string", "description": "The unique location identifier
Example: YBZA" }, "locationContactAndAddress": { "$ref": "#/$defs/ContactAndAddress" }, "clearanceNumber": { "type": "string", "description": "This specifies the clearance number associated with the distribution location.
Example: 123" }, "inclusionSpecifications": { "type": "array", "description": "Specifies which kinds of shipments will be processed by this distribution location.", "items": { "allOf": [ { "$ref": "#/$defs/CarrierCode" }, { "$ref": "#/$defs/ServiceCategory" } ] } } }, "description": "Specifies the type and location id for the distribution location to be used to process the consolidation.
Mandatory for International Ground Distribution." }, "DocTabContent": { "type": "object", "properties": { "docTabContentType": { "type": "string", "description": "Doc Tab Content Type", "enum": [ "BARCODED", "CUSTOM", "MINIMUM", "STANDARD", "ZONE001" ] }, "zone001": { "$ref": "#/$defs/DocTabContentZone001" }, "barcoded": { "$ref": "#/$defs/DocTabContentBarcoded" } }, "description": "Specifies details of doc tab content, If provided, thermal documents will include specified doc tab content. If omitted, document will be produced without doc tab content." }, "DocTabContentBarcoded": { "type": "object", "properties": { "symbology": { "type": "string", "description": "Barcode Symbology Type", "enum": [ "CODABAR", "CODE128", "CODE128_WIDEBAR", "CODE128B", "CODE128C", "CODE39", "CODE93", "I2OF5", "MANUAL", "PDF417", "POSTNET", "QR_CODE", "UCC128" ] }, "specification": { "$ref": "#/$defs/DocTabZoneSpecification" } } }, "DocTabContentZone001": { "type": "object", "properties": { "docTabZoneSpecifications": { "type": "array", "description": "Indicate the doc tab specifications for the individual doc tab zone on the label.", "items": { "$ref": "#/$defs/DocTabZoneSpecification" } } } }, "DocTabZoneSpecification": { "type": "object", "properties": { "zoneNumber": { "type": "integer", "description": "It is a non-negative integer that represents the portion of doc-tab in a label.
Example: 1", "format": "int32" }, "header": { "type": "string", "description": "Indicates the parameter name in the header for the doc tab zone.
Example: WHT" }, "dataField": { "type": "string", "description": "Indicate the path request/reply element to be printed on doc tab.
Example: " }, "literalValue": { "type": "string", "description": "Indicates the actual data to be printed in the label." }, "justification": { "type": "string", "description": "Indicates the justification format for the string.", "enum": [ "LEFT", "RIGHT" ] } } }, "EMailDetail_1": { "type": "object", "properties": { "emailNotificationFormatType": { "type": "string", "description": "Email Notification Format Type", "enum": [ "SMS_TEXT_MESSAGE", "TEXT", "HTML" ] }, "address": { "type": "string", "description": "Address" }, "permissions": { "type": "object", "additionalProperties": { "type": "string", "enum": [ "GRANT", "DENY" ] }, "description": "Email Permission Type" } } }, "ExportDetail": { "required": [ "b13AFilingOption" ], "type": "object", "properties": { "destinationControlDetail": { "$ref": "#/$defs/DestinationControlDetail" }, "b13AFilingOption": { "type": "string", "description": "Specify the filing option being exercised. Required for non-document shipments originating in Canada destinated for any country other than Canada, the United States, Puerto Rico, or the U.S. Virgin Islands.", "enum": [ "NOT_REQUIRED", "MANUALLY_ATTACHED", "FILED_ELECTRONICALLY", "SUMMARY_REPORTING", "FEDEX_TO_STAMP" ] }, "exportComplianceStatement": { "type": "string", "description": "For US export shipments requiring an EEI, enter the ITN number received from AES when you filed your shipment or the FTR (Foreign Trade Regulations) exemption number.The proper format for an ITN number is AES XYYYYMMDDNNNNNN where YYYYMMDD is date and NNNNNN are numbers generated by the AES.
Example: AESX20220714987654
Note: The ITN or FTR exemption number you submit in the Ship request prints on the international shipping label.

For CA export shipments, it can be Proof of report number(15-32 alphanumeric), Summary proof of report number(7-32 alphanumeric) or Exemption number(2 digit) based on the selected b13AFillingOption.
Example: 98765432107654321(POR number), 7654321(Summary POR number) and 02(Exemption number)" }, "permitNumber": { "type": "string", "description": "This is a Permit Number. This field is applicable only to Canada export non-document shipments of any value to any destination. No special characters are allowed." } }, "description": "These are export Detail Used for US or CA exports." }, "Formats": { "type": "object", "properties": { "docType": { "type": "string", "description": "Specify the image format used for a shipping document.
click here to see label format types", "enum": [ "PDF", "PNG" ] }, "stockType": { "type": "string", "description": "Specify the label stock type.
click here to see label format types", "enum": [ "PAPER_LETTER" ] } }, "description": "Specifies the formats." }, "FreightChargeMoney": { "required": [ "currency" ], "type": "object", "properties": { "amount": { "type": "number", "description": "This is commodity value in amount used for Customs declaration.
Max limit: 7 digits before decimal.", "format": "double" }, "currency": { "type": "string", "description": "This is the currency of the commodity value used for Customs declaration.Click here to see Currency Codes" } }, "description": "Any freight charges that are associated with this shipment." }, "HandlingCostCharges": { "required": [ "currency" ], "type": "object", "properties": { "amount": { "type": "number", "description": "This is commodity value in amount used for Customs declaration.
Max limit: 7 digits before decimal.", "format": "double" }, "currency": { "type": "string", "description": "This is the currency of the commodity value used for Customs declaration.Click here to see Currency Codes" } }, "description": " Any handling costs that are associated with this shipment." }, "ImporterOfRecord": { "description": "The descriptive data for the importer of Record for the shipment and their physical address, contact and account number information.", "allOf": [ { "$ref": "#/$defs/Party_1" } ] }, "InternationalControlledExportDetail": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates if consolidation is goods moving under a US Department of State(DOS) license, US Drug Enforcement Administration(DEA) export permit, bonded shipments moving under a CBP-7512 from a FTZ and/or bonded warehouse.", "enum": [ "DEA_036", "DEA_236", "DEA_486", "DSP_05", "DSP_61", "DSP_73", "DSP_85", "DSP_94", "DSP_LICENSE_AGREEMENT", "FROM_FOREIGN_TRADE_ZONE", "WAREHOUSE_WITHDRAWAL" ] }, "foreignTradeZoneCode": { "type": "string", "description": "Foreign Trade Zone(FTZ) code which is a designated geographical commercial area where foreign merchandise is imported and stored without immediate requirement for duty payments." }, "entryNumber": { "type": "string", "description": "The entry number is 11 digits and is comprised of the 3-character filer code, followed by the 7-digit entry number, and completed with the one digit check digit." }, "licenseOrPermitNumber": { "type": "string", "description": "State Department License Number or DEA Permit Number" }, "licenseOrPermitExpirationDate": { "type": "string", "description": "Indicates the State Department License or DEA Permit expiration date. Format: YYYY-MM-DD", "format": "YYYY-MM-DD" } }, "description": "Required FICE details. Used when the requested special service is FICE." }, "InternationalDistributionDetail": { "required": [ "clearanceFacilityLocationId", "declarationCurrencies", "totalDimensions" ], "type": "object", "properties": { "dropOffType": { "type": "string", "description": "Specifies drop off type.", "enum": [ "BUSINESS_SERVICE_CENTER", "DROP_BOX", "REGULAR_PICKUP", "REQUEST_PICKUP", "STATION" ] }, "totalDimensions": { "$ref": "#/$defs/Dimensions" }, "totalInsuredValue": { "$ref": "#/$defs/TotalInsuredMoney" }, "unitSystem": { "type": "string", "description": "Specifies the unit system.", "enum": [ "ENGLISH", "METRIC" ] }, "declarationCurrencies": { "type": "array", "items": { "$ref": "#/$defs/Money_1" } }, "clearanceFacilityLocationId": { "type": "string", "description": "Specifies the clearance facility location id." } }, "description": "Specifies the international distribution detail." }, "LabelSpecification": { "required": [ "printedLabelOrigin" ], "type": "object", "properties": { "labelFormatType": { "type": "string", "description": "Specify the label Format Type.
click here to see label format types", "enum": [ "COMMON2D", "ERROR", "LABEL_DATA_ONLY", "MAILROOM", "NO_LABEL", "OPERATIONAL_LABEL", "PRE_COMMON2D" ] }, "labelStockType": { "type": "string", "description": "Indicate the label stock type used.
click here to see label format types", "enum": [ "PAPER_4X6", "PAPER_4X675", "PAPER_4X8", "PAPER_4X9", "PAPER_7X475", "PAPER_85X11_BOTTOM_HALF_LABEL", "PAPER_85X11_TOP_HALF_LABEL", "PAPER_LETTER", "STOCK_4X675_LEADING_DOC_TAB", "STOCK_4X8", "STOCK_4X9_LEADING_DOC_TAB", "STOCK_4X6", "STOCK_4X675_TRAILING_DOC_TAB", "STOCK_4X9_TRAILING_DOC_TAB", "STOCK_4X675", "STOCK_4X9", "STOCK_4X8.5_TRAILING_DOC_TAB", "STOCK_4X10.5_TRAILING_DOC_TAB" ] }, "imageType": { "type": "string", "description": "Specify the image format used for a shipping document.
click here to see label format types", "enum": [ "ZPLII", "EPL2", "PDF", "PNG" ] }, "processingOptionsRequested": { "$ref": "#/$defs/LabelSpecification_processingOptionsRequested" }, "dispositions": { "type": "array", "description": "Specifies how to create, organize, and return the document.", "items": { "$ref": "#/$defs/ShippingDocumentDispositionDetail" } }, "labelPrintingOrientation": { "type": "string", "description": "This is applicable only to documents produced on thermal printers with roll stock.", "default": "TOP_EDGE_OF_TEXT_FIRST", "enum": [ "BOTTOM_EDGE_OF_TEXT_FIRST", "TOP_EDGE_OF_TEXT_FIRST" ] }, "labelRotation": { "type": "string", "description": "This is applicable only to documents produced on thermal printers with roll stock.", "enum": [ "LEFT", "RIGHT", "UPSIDE_DOWN", "NONE" ] }, "labelOrder": { "type": "string", "description": "This is the order of the Shipping labels to be generated.", "enum": [ "SHIPPING_LABEL_FIRST", "SHIPPING_LABEL_LAST" ] }, "printedLabelOrigin": { "$ref": "#/$defs/ContactAndAddress" }, "customerSpecifiedDetail": { "$ref": "#/$defs/CustomerSpecifiedLabelDetail" }, "resolution": { "type": "integer", "description": "Specifies the image resolution in DPI (Dots Per Inch). Valid values are 203 & 300. If not provided or for any other value, system will default it to 203.Note: 300 DPI resolution is only allowed for ZPLII image type." } }, "description": "These are label specification details includes the image type, printer format, and label stock for label. Can also specify specific details such as doc-tab content, regulatory labels, and masking data on the label.
Mandatory as it is needed during confirming consolidation. If it is not passed while creating consolidation it will fail during confirming consolidation." }, "LabelSpecification_processingOptionsRequested": { "type": "object", "properties": { "options": { "type": "string", "enum": [ "INCLUDE_DOC_TAB_ON_ALL_LABELS", "PRE_EACI_LABEL" ] } } }, "Locale": { "type": "object", "properties": { "country": { "type": "string", "description": "Country
Example: US" }, "language": { "type": "string", "description": "Language
Example: en" } }, "description": "Locale" }, "ModifyConsolidationOutputVO": { "type": "object", "properties": { "modifyConsolidation": { "$ref": "#/$defs/RetrievedConsolidation" } }, "description": "This is the response received when a consolidation shipment is modified." }, "Money": { "required": [ "currency" ], "type": "object", "properties": { "amount": { "type": "number", "description": "This is commodity value in amount used for Customs declaration.
Max limit: 7 digits before decimal.", "format": "double" }, "currency": { "type": "string", "description": "This is the currency of the commodity value used for Customs declaration.Click here to see Currency Codes" } }, "description": "This is commodity value used for Customs declaration." }, "Money_1": { "required": [ "value" ], "type": "object", "properties": { "currency": { "type": "string", "description": "Three-character currency code (e.g. USD, CAD, EUR, JPY, etc.)
Click here to see Currency Codes" }, "value": { "type": "string", "description": "Specify the value.", "enum": [ "CUSTOMS_VALUE", "INSURED_VALUE" ] } }, "description": "This is commodity value used for Customs declaration." }, "Origin": { "type": "object", "properties": { "address": { "$ref": "#/$defs/PartyAddress" }, "contact": { "$ref": "#/$defs/PartyContact" } }, "description": "The descriptive information for the customer origin." }, "PackingCostCharges": { "required": [ "currency" ], "type": "object", "properties": { "amount": { "type": "number", "description": "This is commodity value in amount used for Customs declaration.
Max limit: 7 digits before decimal.", "format": "double" }, "currency": { "type": "string", "description": "This is the currency of the commodity value used for Customs declaration.Click here to see Currency Codes" } }, "description": "Any packing costs that are associated with this shipment." }, "Party": { "required": [ "accountNumber" ], "type": "object", "properties": { "address": { "$ref": "#/$defs/Address_1" }, "contact": { "$ref": "#/$defs/Contact_1" }, "accountNumber": { "$ref": "#/$defs/PartyAccountNumber_1" } }, "description": "Indicate the payer Information responsible for paying for the shipment.Note: ResponsibleParty accountNumber is required for ACCOUNT based services." }, "Party1": { "type": "object", "properties": { "address": { "$ref": "#/$defs/Address_2" }, "contact": { "$ref": "#/$defs/Contact_1" }, "accountNumber": { "$ref": "#/$defs/PartyAccountNumber_1" } }, "description": "Indicate the payer Information responsible for paying for the shipment.Note: ResponsibleParty accountNumber is required for ACCOUNT based services." }, "PartyAccountNumber": { "type": "object", "properties": { "value": { "type": "string", "description": "Conditional.
The account number value.
Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT." } }, "description": "This FedEx Account number details." }, "PartyAccountNumber_1": { "type": "object", "properties": { "value": { "type": "string", "description": "The account number value. Value is required if the paymentType is RECIPIENT, THIRD_PARTY or COLLECT." } }, "description": "This is FedEx Account number details." }, "PartyAddress": { "required": [ "city", "countryCode", "postalCode", "streetLines" ], "type": "object", "properties": { "streetLines": { "type": "array", "description": "Combination of number, street name, etc. At least one line is required for a valid physical address. Empty lines should not be included. Max Length is 35.
Example: [1550 Union Blvd,Suite 302]", "items": { "type": "string" } }, "city": { "maxLength": 35, "type": "string", "description": "The name of city, town of the recipient.Max length is 35.
Example: Beverly Hills" }, "stateOrProvinceCode": { "type": "string", "description": "The US States,Canada and Puerto Rico Province codes of the recipient. The Format and presence of this field may vary depending on the country. State code is required for US, CA, PR and not required for other countries. Conditional. Max length is 2.
Example: CA " }, "postalCode": { "type": "string", "description": "This is the postal code.
Note: This is Optional for non postal-aware countries. Maximum length is 10.
Example: 90210
click here to see Postal aware countries" }, "countryCode": { "type": "string", "description": "The two-letter code used to identify a country.
Maximum length is 2.
Example: US
click here to see Country codes" }, "residential": { "type": "boolean", "description": " Indicates whether this address is residential (as opposed to commercial).
Example: 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)." }, "PartyAddress_soldTo": { "required": [ "city", "countryCode", "postalCode", "stateOrProvinceCode", "streetLines" ], "type": "object", "properties": { "streetLines": { "type": "array", "description": "Combination of number, street name, etc. At least one line is required for a valid physical address. Empty lines should not be included. Max Length is 35.
Example: [1550 Union Blvd,Suite 302]", "items": { "type": "string" } }, "city": { "maxLength": 35, "type": "string", "description": "The name of city, town of the recipient.Max length is 35.
Example: Beverly Hills" }, "stateOrProvinceCode": { "type": "string", "description": "The US States,Canada and Puerto Rico Province codes of the recipient. The Format and presence of this field may vary depending on the country.
Example: CA" }, "postalCode": { "type": "string", "description": "The US State and Canada Province codes. The Format and presence of this field may vary depending on the country.
Example: 90210" }, "countryCode": { "type": "string", "description": "The two-letter code used to identify a country. Max length is 2.
Example: US" }, "residential": { "type": "boolean", "description": " Indicates whether this address is residential (as opposed to commercial).
Example: 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)." }, "PartyContact": { "required": [ "phoneNumber" ], "type": "object", "properties": { "personName": { "type": "string", "description": "Specify contact name. First 35 chars will be printed on the label, excess characters will be truncated..
Note: Either the companyName or personName is mandatory.
Example: John Taylor" }, "emailAddress": { "type": "string", "description": "Specify contact email address. Maximum length is 80.
Example: sample@company.com" }, "phoneExtension": { "type": "string", "description": "Specify contact phone extension. Maximum length is 6.
Example: 91" }, "phoneNumber": { "type": "string", "description": "Specify contact phone number.
Minimum length is 1 and supports maximum of 15 for certain countries using longer phone numbers.
Note: For US and CA, a phone number must have exactly 10 digits, plus an optional leading country code of '1' or '+1'.
Example: 918xxxxx890" }, "companyName": { "type": "string", "description": "Specify contact company name. Maximum length is 35.
Note: Either the companyName or personName is mandatory." } }, "description": "Indicate the contact details for this shipment." }, "PartyContact_soldTo": { "required": [ "companyName", "personName", "phoneNumber" ], "type": "object", "properties": { "personName": { "type": "string", "description": "Specify contact name. Max Length is 70.
Example: John Taylor" }, "emailAddress": { "type": "string", "description": "Specify contact email address. Max length is 80.
Example: sample@company.com" }, "phoneExtension": { "type": "string", "description": "Specify contact phone extension. Max length is 6.
Example: 91" }, "phoneNumber": { "type": "string", "description": "Specify contact phone number.
Minimum length is 1 and supports maximum of 15 for certain countries using longer phone numbers.
Note: For US and CA, a phone number must have exactly 10 digits, plus an optional leading country code of '1' or '+1'.
Example: 918xxxxx890" }, "companyName": { "type": "string", "description": "Specify contact company name. Max length is 35.
Example: FedEx" } }, "description": "Contact details of the shipper." }, "Party_1": { "type": "object", "properties": { "address": { "$ref": "#/$defs/PartyAddress" }, "contact": { "$ref": "#/$defs/PartyContact" }, "accountNumber": { "$ref": "#/$defs/PartyAccountNumber" }, "tins": { "type": "array", "description": "This is the tax identification number details.", "items": { "$ref": "#/$defs/TaxpayerIdentification" } }, "deliveryInstructions": { "type": "string", "description": "Used with Ground Home Delivery and Freight.
Example: FRONT DOOR" } }, "description": "" }, "Payment": { "type": "object", "properties": { "payor": { "$ref": "#/$defs/Payor" }, "paymentType": { "type": "string", "description": "Specify the payment Type.
Note: This is required for Express, Ground and SmartPost shipments.
The payment type COLLECT is applicable only for Ground shipments.", "enum": [ "SENDER", "RECIPIENT", "THIRD_PARTY" ] } }, "description": "Details about who and how the shipment will be paid for. 'payor' is optional when 'paymentType' provided is SENDER." }, "Payment1": { "type": "object", "properties": { "payor": { "$ref": "#/$defs/Payor1" }, "paymentType": { "type": "string", "description": "Specify the payment Type.
Note: This is required for Express, Ground and SmartPost shipments.
The payment type COLLECT is applicable only for Ground shipments.", "enum": [ "SENDER", "THIRD_PARTY" ] } }, "description": "Details about who and how the shipment will be paid for. 'payor' is optional when 'paymentType' provided is SENDER." }, "Payor": { "required": [ "responsibleParty" ], "type": "object", "properties": { "responsibleParty": { "$ref": "#/$defs/Party" } }, "description": "Information about the person who is paying for the shipment. Not applicable for credit card payment. " }, "Payor1": { "type": "object", "properties": { "responsibleParty": { "$ref": "#/$defs/Party1" } }, "description": "Information about the person who is paying for the shipment. Not applicable for credit card payment. " }, "PriorityAlertDetail": { "type": "object", "properties": { "enhancementTypes": { "type": "array", "description": "The types of all enhancement for the Priority Alert
Example: PRIORITY_ALERT_PLUS", "items": { "type": "string" } }, "content": { "type": "array", "description": "Specifies Content for the Priority Alert Detail.", "items": { "type": "string" } } }, "description": "specifies the Priority Alert Detail." }, "RecipientCustomsId": { "type": "object", "properties": { "type": { "type": "string", "description": "This is ID Type.", "enum": [ "COMPANY", "INDIVIDUAL", "PASSPORT" ] }, "value": { "type": "string", "description": "This is the ID number." } }, "description": "Conditional. Use this element to provide valid identification details. Used for populating brazil tax id." }, "RegulatoryLabelContentDetail": { "type": "object", "properties": { "generationOptions": { "type": "string", "description": "Specifies how to print the regulatory label in relation to the main shipping label.", "enum": [ "CONTENT_ON_SHIPPING_LABEL_PREFERRED", "CONTENT_ON_SUPPLEMENTAL_LABEL_ONLY", "CONTENT_ON_SHIPPING_LABEL_ONLY" ] }, "type": { "type": "string", "description": "Regulatory Label Type", "enum": [ "ALCOHOL_SHIPMENT_LABEL" ] } } }, "RetrievedConsolidation": { "type": "object", "properties": { "consolidationType": { "type": "string", "description": "Specifies the consolidation type.", "enum": [ "INTERNATIONAL_DISTRIBUTION_FREIGHT", "INTERNATIONAL_ECONOMY_DISTRIBUTION", "INTERNATIONAL_GROUND_DISTRIBUTION", "TRANSBORDER_DISTRIBUTION", "INTERNATIONAL_PRIORITY_DISTRIBUTION" ] }, "shipDatestamp": { "type": "string", "description": "This field indicates the shipping date of the LTL Shipment" }, "trackingIds": { "type": "array", "description": "The field is present to allow use of preassigned Master Airway Bill tracking number.", "items": { "$ref": "#/$defs/TrackingIds" } }, "shipper": { "description": "Descriptive data identifying the party responsible for shipping the package. Shipper and Origin should have the same address.", "allOf": [ { "$ref": "#/$defs/ShipperParty" } ] }, "origin": { "description": "Descriptive data identifying the Origin.", "allOf": [ { "$ref": "#/$defs/Origin" } ] }, "soldTo": { "$ref": "#/$defs/SoldToParty" }, "bookingNumber": { "type": "string", "description": "Specifies the booking number needed to reserve package placement on a FedEx plane. Is a 12 digit number." }, "consolidationDataSources": { "$ref": "#/$defs/ConsolidationDataSources" }, "customerReferences": { "type": "array", "items": { "$ref": "#/$defs/CustomerReferences" } }, "labelSpecification": { "$ref": "#/$defs/LabelSpecification" }, "internationalDistributionDetail": { "$ref": "#/$defs/InternationalDistributionDetail" }, "transborderDistributionDetail": { "$ref": "#/$defs/TransborderDistributionDetail" }, "customsClearanceDetail": { "$ref": "#/$defs/CustomsClearanceDetail" }, "consolidationDocumentSpecification": { "$ref": "#/$defs/ConsolidationDocumentSpec" }, "distributionLocations": { "$ref": "#/$defs/DistributionLocations" }, "shippingChargesPayment": { "$ref": "#/$defs/Payment" }, "specialServicesRequested": { "$ref": "#/$defs/SpecialServicesRequested" } }, "description": "Specifies the consolidation that is being retrieved" }, "ServiceCategory": { "type": "string", "description": "FOR FEDEX INTERNAL USE ONLY. This is tied to the Product EFS interface definition which will currently contain the values of parcel or freight.
Example: freight" }, "ShipperParty": { "required": [ "address", "contact" ], "type": "object", "properties": { "address": { "$ref": "#/$defs/PartyAddress" }, "contact": { "$ref": "#/$defs/PartyContact" }, "tins": { "type": "array", "description": "This is the tax identification number details.", "items": { "$ref": "#/$defs/TaxpayerIdentification" } }, "accountNumber": { "$ref": "#/$defs/AccountNumber" } }, "description": "The descriptive information for the customer shipping the package along with the physical location from where the shipment originates." }, "ShippingDocumentDispositionDetail": { "type": "object", "properties": { "eMailDetail": { "$ref": "#/$defs/ShippingDocumentEmailDetail" }, "dispositionType": { "type": "string", "description": "Values in this field specify how to create and return the document.", "enum": [ "CONFIRMED", "DEFERRED_QUEUED", "DEFERRED_RETURNED", "DEFERRED_STORED", "EMAILED", "QUEUED", "RETURNED", "STORED" ] }, "grouping": { "type": "string", "description": "Identifies the convention by which documents are to be grouped as email attachment.", "enum": [ "CONSOLIDATED_BY_DOCUMENT_TYPE", "CONSOLIDATED_BY_IMAGE_TYPE", "INDIVIDUAL" ] }, "storageDetail": { "$ref": "#/$defs/ShippingDocumentStorageDetail" }, "printDetail": { "$ref": "#/$defs/ShippingDocumentPrintDetail" } }, "description": "Each occurrence of this class specifies a particular way in which a kind of shipping document is to be produced and provided." }, "ShippingDocumentEmailDetail": { "required": [ "eMailRecipients" ], "type": "object", "properties": { "eMailRecipients": { "type": "array", "description": "Shipping Document Email Recipients array", "items": { "$ref": "#/$defs/ShippingDocumentEmailRecipient" } }, "locale": { "$ref": "#/$defs/Locale" }, "grouping": { "type": "string", "description": "Shipping Document Email Grouping Type", "enum": [ "BY_RECIPIENT", "NONE" ] } }, "description": "Specifies how to e-mail shipping documents." }, "ShippingDocumentEmailRecipient": { "required": [ "recipientType" ], "type": "object", "properties": { "emailAddress": { "type": "string", "description": "Provides the email Address
Example: email@fedex.com" }, "recipientType": { "type": "string", "description": "Email Notification Recipient Type", "enum": [ "BROKER", "OTHER", "RECIPIENT", "SHIPPER", "THRID_PARTY", "OTHER1", "OTHER2" ] } } }, "ShippingDocumentPrintDetail": { "properties": { "printerId": { "type": "string", "description": "Provides environment specific printer identification." } }, "description": "Specifies printing options for a shipping document." }, "ShippingDocumentStorageDetail": { "properties": { "type": { "type": "string", "description": "Indicates the mechanism by which a shipping document will be stored for later retrieval.", "enum": [ "ASYNC_SERVICE", "LOCAL_FILE_SYSTEM" ] }, "filePath": { "type": "string", "description": "Provides the path to be used for STORED or DEFERRED documents." }, "fileNaming": { "type": "string", "description": "Identifies the convention by which file names are constructed from STORED or DEFERRED documents.", "enum": [ "FAST", "LEGACY_FXRS" ] }, "fileSuffix": { "type": "string", "description": "Suffix to be placed at the end of the file name;required on some platforms to determine file type" } }, "description": "Specifies how to store document images." }, "SoldToParty": { "type": "object", "properties": { "address": { "$ref": "#/$defs/PartyAddress_soldTo" }, "contact": { "$ref": "#/$defs/PartyContact_soldTo" }, "tins": { "type": "array", "description": "Used for adding the tax id", "items": { "$ref": "#/$defs/TaxpayerIdentification" } }, "accountNumber": { "$ref": "#/$defs/AccountNumber" } }, "description": "Will indicate the party responsible for purchasing the goods shipped from the shipper to the recipient. The sold to party is not necessarily the recipient or the importer of record. The sold to party is relevant when the purchaser, rather than the recipient determines when certain customs regulations apply." }, "SpecialServicesRequested": { "type": "object", "properties": { "specialServiceTypes": { "type": "string", "description": "Provides all the special service types.
Example: PRIORITY_ALERT", "enum": [ "BROKER_SELECT_OPTION", "PRIORITY_ALERT", "SATURDAY_PICKUP", "INTERNATIONAL_CONTROLLED_EXPORT_SERVICE" ] }, "priorityAlertDetail": { "$ref": "#/$defs/PriorityAlertDetail" }, "internationalControlledExportDetail": { "$ref": "#/$defs/InternationalControlledExportDetail" } }, "description": "These special services are available at the shipment level for some or all service types." }, "SummaryDetail": { "type": "object", "properties": { "expressPacakgeCount": { "type": "integer", "description": "Number of Express packages" }, "expressTotalPackageWeight": { "$ref": "#/$defs/SummaryDetail_expressTotalPackageWeight" }, "expressTotalPackageAdjustedWeight": { "$ref": "#/$defs/SummaryDetail_expressTotalPackageAdjustedWeight" }, "expressFreightPackageCount": { "type": "integer", "description": "Number of Express freight packages" }, "expressTotalFreightWeight": { "$ref": "#/$defs/SummaryDetail_expressTotalFreightWeight" }, "expressTotalFreightAdjustedWeight": { "$ref": "#/$defs/SummaryDetail_expressTotalFreightAdjustedWeight" }, "groundPackageCount": { "type": "integer", "description": "Number of Ground packages" }, "groundTotalPackageWeight": { "$ref": "#/$defs/SummaryDetail_groundTotalPackageWeight" }, "groundTotalPackageAdjustedWeight": { "$ref": "#/$defs/SummaryDetail_groundTotalPackageAdjustedWeight" }, "numberOfUnconsolidatedCommodities": { "type": "integer", "description": "Number of unconsolidated commodities" } }, "description": "Package type, number, and weight details" }, "SummaryDetail_expressTotalFreightAdjustedWeight": { "type": "object", "properties": { "units": { "type": "string", "description": "Weight unit", "enum": [ "KG", "LB" ] }, "value": { "type": "integer", "description": "Weight amount" } }, "description": "Adjusted total weight of Express freight packages" }, "SummaryDetail_expressTotalFreightWeight": { "type": "object", "properties": { "units": { "type": "string", "description": "Weight unit", "enum": [ "KG", "LB" ] }, "value": { "type": "integer", "description": "Weight amount" } }, "description": "Total weight of Express freight packages" }, "SummaryDetail_expressTotalPackageAdjustedWeight": { "type": "object", "properties": { "units": { "type": "string", "description": "Weight unit", "enum": [ "KG", "LB" ] }, "value": { "type": "integer", "description": "Weight amount" } }, "description": "Adjusted total package weight for Exress packages" }, "SummaryDetail_expressTotalPackageWeight": { "type": "object", "properties": { "units": { "type": "string", "description": "Weight unit", "enum": [ "KG", "LB" ] }, "value": { "type": "integer", "description": "Weight amount" } }, "description": "The total weight of all Express packages" }, "SummaryDetail_groundTotalPackageAdjustedWeight": { "type": "object", "properties": { "units": { "type": "string", "description": "Weight unit", "enum": [ "KG", "LB" ] }, "value": { "type": "integer", "description": "Weight amount" } }, "description": "Adjusted total weight of Ground packages" }, "SummaryDetail_groundTotalPackageWeight": { "type": "object", "properties": { "units": { "type": "string", "description": "Weight unit", "enum": [ "KG", "LB" ] }, "value": { "type": "integer", "description": "Weight amount" } }, "description": "Total weight of Ground packages" }, "TaxesOrMiscellaneousCharges": { "required": [ "currency" ], "type": "object", "properties": { "amount": { "type": "number", "description": "This is commodity value in amount used for Customs declaration.
Max limit: 7 digits before decimal.", "format": "double" }, "currency": { "type": "string", "description": "This is the currency of the commodity value used for Customs declaration.Click here to see Currency Codes" } }, "description": "Any taxes or miscellaneous charges other than Freight charges or Insurance charges, that are associated with this shipment." }, "TaxpayerIdentification": { "type": "object", "properties": { "number": { "type": "string", "description": "Specify tax ID number. Maximum length is 18.
Example: 123567" }, "tinType": { "type": "string", "description": "Indicate the type of tax identification number.", "enum": [ "PERSONAL_NATIONAL", "PERSONAL_STATE", "FEDERAL", "BUSINESS_NATIONAL", "BUSINESS_STATE", "BUSINESS_UNION" ] }, "usage": { "type": "string", "description": "Specify the reason for using the tax identification number in shipment processing.
Example: usage" }, "effectiveDate": { "type": "string", "description": "Specify the tax ID effective date.
Example: 2000-01-23T04:56:07.000+00:00" }, "expirationDate": { "type": "string", "description": "Specify the tax ID expiration date.
Example: 2000-01-23T04:56:07.000+00:00" } } }, "Tins": { "properties": { "tinType": { "type": "string", "description": "Identifies the type of Tax Identification Number in Shipment processing.", "enum": [ "BUSINESS_NATIONAL", "BUSINESS_STATE", "BUSINESS_UNION", "PERSONAL_NATIONAL", "PERSONAL_STATE" ] }, "number": { "type": "string", "description": "Specifies Number in Shipment processing." }, "usage": { "type": "string", "description": "Identifies the usage of Tax Identification Number in Shipment processing." }, "effectiveDate": { "type": "string", "description": "Specifies Effective Date. Format YYYY-MM-DD" }, "expirationDate": { "type": "string", "description": "Specifies Expiration Date." } }, "description": "Tax payer identification details" }, "TotalInsuredMoney": { "required": [ "currency" ], "type": "object", "properties": { "amount": { "type": "number", "description": "This is commodity value in amount used for Customs declaration.
Max limit: 7 digits before decimal.", "format": "double" }, "currency": { "type": "string", "description": "This is the currency of the commodity value used for Customs declaration.
Click here to see Currency Codes" } }, "description": "This is commodity value used for Customs declaration." }, "TrackingIds": { "required": [ "formId", "trackingIdType", "trackingNumber" ], "type": "object", "properties": { "trackingIdType": { "type": "string", "description": "Specify the FedEx transportation type (EXPRESS, GROUND, FREIGHT)." }, "formId": { "type": "string", "description": "This is FedEx tracking Identifier associated with the package." }, "trackingNumber": { "type": "string", "description": "This is a number associated with a package that is used to track it." } }, "description": "The field is present to allow use of preassigned Master Airway Bill tracking number." }, "TransborderDistributionDetail": { "type": "object", "properties": { "specialServicesRequested": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested" }, "routing": { "type": "string", "description": "Specifies the transborder distribution routing.", "enum": [ "BY_METER", "BY_ORIGIN", "CUSTOMER_SPECIFIED" ] }, "summaryDetail": { "$ref": "#/$defs/SummaryDetail" } }, "description": "Specifies attributes of a shipment whithin a transborder distribution." }, "TransborderDistributionDetail_specialServicesRequested": { "type": "object", "properties": { "specialServiceTypes": { "type": "string", "description": "Identifies features of service requested for the current Transborder Distribution. shipment.", "enum": [ "FEDEX_LTL" ] }, "transborderDistributionLtlDetail": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail" } }, "description": "Specifies special services to be performed on this shipment as part of a transborder distribution." }, "TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail": { "type": "object", "properties": { "payment": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment" }, "ltlScacCode": { "type": "string", "description": "Standard Carrier Alpha Code for origin-country LTL services." } }, "description": "Specifies details for the origin-country LTL services performed by FedEx." }, "TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment": { "type": "object", "properties": { "paymentType": { "type": "string", "description": "Payment type for LTL transportation", "enum": [ "ACCOUNT", "CASH", "COLLECT", "CREDIT_CARD", "EPAYMENT", "RECIPIENT", "SENDER", "THIRD_PARTY" ] }, "payor": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_payor" }, "ePaymentDetail": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_ePaymentDetail" }, "creditCard": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_creditCard" }, "creditCardTransactionDetail": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_creditCardTransactionDetail" }, "amount": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_amount" } }, "description": "Payment for LTL transportation" }, "TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_amount": { "type": "object", "properties": { "currency": { "type": "string", "description": "Type of currency" }, "amount": { "type": "number", "description": "monetary amount" } }, "description": "Currency type and amount details" }, "TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_creditCard": { "type": "object", "properties": { "number": { "type": "string", "description": "Credit card number" }, "creditCardType": { "type": "string", "description": "Credit card used for payment", "enum": [ "AMEX", "DANKORT", "DINERS", "DISCOVER", "JCB", "MASTERCARD", "VISA" ] }, "expirationDate": { "type": "string", "description": "Credit card expiration date" }, "lastAuthenticationByFedexDate": { "type": "string", "description": "Use date format (MM-dd-yyyy). It is the last time the user has updated their credit card information" }, "verificationCode": { "type": "string", "description": "Verification code" }, "creditCardHolder": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_creditCard_creditCardHolder" } }, "description": "Credit card details" }, "TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_creditCardTransactionDetail": { "type": "object", "properties": { "authorizationId": { "type": "string", "description": "Credit card authorization ID" }, "authorizationType": { "type": "string", "description": "Type of authorization", "enum": [ "AUTHORIZE_NON_ACCOUNT", "AUTHORIZE_WITH_ACCOUNT", "VERIFY_WITH_ACCOUNT" ] }, "settlementScheduleType": { "type": "string", "description": "Settlement schedule type", "enum": [ "SETTLE_IMMEDIATELY", "SETTLE_NEXT_DAY", "SETTLE_ON_DELIVERY" ] }, "fraudDetectionDetail": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_creditCardTransactionDetail_fraudDetectionDetail" }, "payorAuthenticationCode": { "type": "string", "description": "Specifies a secure code used for payor authentication in the credit card transaction." }, "payorAuthenticationSessionId": { "type": "string", "description": "If you have a session id from a 3D security 2.0 check put it this field. Otherwise do not populate." }, "attributesDetail": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_creditCardTransactionDetail_attributesDetail" } }, "description": "Details for the credit card transaction" }, "TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_creditCardTransactionDetail_attributesDetail": { "type": "object", "properties": { "types": { "type": "array", "description": "Will be used to make decisions on credit card processing", "items": { "type": "string", "enum": [ "ORIGINATED_BY_AUTHORIZED_PERSONNEL", "ORIGINATED_BY_UNAUTHORIZED_PERSONNEL" ] } } }, "description": "Specifies details about the credit card transaction that drive decisions about credit card processing." }, "TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_creditCardTransactionDetail_fraudDetectionDetail": { "type": "object", "properties": { "ipAddress": { "type": "string", "description": "IP address" }, "clientCookiesEnabled": { "type": "boolean", "description": "Client cookies enabled or not" }, "devicePrint": { "type": "string", "description": "The html that a client needs to embed for triggering a call to cyber source for needed information on device identification" } }, "description": "Credit card fraud detection detail" }, "TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_creditCard_creditCardHolder": { "type": "object", "properties": { "contact": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_creditCard_creditCardHolder_contact" }, "address": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_payor_responsibleParty_address" } }, "description": "Credit card holder's information" }, "TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_creditCard_creditCardHolder_contact": { "type": "object", "properties": { "personName": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_creditCard_creditCardHolder_contact_personName" }, "phoneNumberCountryCode": { "type": "string", "description": "Country code for credit card holder's phone number" }, "phoneNumberAreaCode": { "type": "string", "description": "Area code for credit card holder's phone number" }, "emailAddress": { "type": "string", "description": "Specify EmailAddress." }, "phoneNumber": { "type": "string", "description": "Specify Phone Number." }, "phoneExtension": { "type": "string", "description": "Specify Phone Extension." }, "companyName": { "type": "string", "description": "Specify Company Name." }, "pagerNumber": { "type": "string", "description": "Specify Pager Number." }, "faxNumber": { "type": "string", "description": "Specify Fax Number." }, "title": { "type": "string", "description": "Specify the Title of the Contact." } }, "description": "Specifies the Contact information for the credit card holder." }, "TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_creditCard_creditCardHolder_contact_personName": { "type": "object", "properties": { "prefix": { "type": "string", "description": "Prefix for the credit card holder" }, "title": { "type": "string", "description": "Title for the credit card holder" }, "firstName": { "type": "string", "description": "First name of the credit card holder" }, "middleName": { "type": "string", "description": "Middle name of the credit card holder" }, "lastName": { "type": "string", "description": "Last name of the credit card holder" }, "suffix": { "type": "string", "description": "Suffix for the credit card holder" } }, "description": "Credit card holder's name" }, "TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_ePaymentDetail": { "type": "object", "properties": { "epaymentProcessor": { "type": "string", "description": "e-payment processor", "enum": [ "RETAIL_SINGLE_POINT_OF_SALE" ] }, "ePaymentMode": { "type": "string", "description": "Method for e-payment", "enum": [ "APPLE_PAY", "CASH", "CHECK", "CREDIT_CARD", "GOOGLE_PAY", "PAYPAL" ] }, "creditCardType": { "type": "string", "description": "Credit card used for e-payment", "enum": [ "AMEX", "DANKORT", "DINERS", "DISCOVER", "JCB", "MASTERCARD", "VISA" ] }, "creditCardExpirationDate": { "type": "string", "description": "Credit card expiration date" }, "amount": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_ePaymentDetail_amount" } }, "description": "e-payment detail" }, "TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_ePaymentDetail_amount": { "type": "object", "properties": { "currency": { "type": "string", "description": "Currency" }, "amount": { "type": "number", "description": "Amount" } }, "description": "E-payment credit card amount" }, "TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_payor": { "type": "object", "properties": { "responsibleParty": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_payor_responsibleParty" }, "associatedAccounts": { "type": "array", "description": "Other associated accounts", "items": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_payor_associatedAccounts" } } }, "description": "Information about the person who is paying for the shipment.
Payor is mandatory when the paymentType is RECIPIENT and THIRD_PARTY." }, "TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_payor_associatedAccounts": { "properties": { "type": { "type": "string", "description": "Type of account", "enum": [ "FEDEX_EXPRESS", "FEDEX_FREIGHT", "FEDEX_GROUND", "FEDEX_OFFICE" ] }, "accountNumber": { "type": "string", "description": "account number" } } }, "TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_payor_responsibleParty": { "type": "object", "properties": { "accountNumber": { "type": "string", "description": "Account number of the payor" }, "tins": { "type": "array", "description": "Used for adding the tax id", "items": { "$ref": "#/$defs/Tins" } }, "contact": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_payor_responsibleParty_contact" }, "address": { "$ref": "#/$defs/TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_payor_responsibleParty_address" } }, "description": "The descriptive information for the person who is responsible for the shipment." }, "TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_payor_responsibleParty_address": { "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.", "items": { "type": "string" } }, "city": { "type": "string", "description": "This is a placeholder for City Name.
Note: This is conditional and not required in all the shipping requests. It is recommended for Express shipments for the most accurate ODA and OPA surcharges and not used for Ground/SmartPost." }, "stateOrProvinceCode": { "type": "string", "description": "This is a placeholder for State or Province code.
Note: This is conditional and not required in all the shipping requests. It is recommended for Express shipments for the most accurate ODA and OPA surcharges and not used for Ground/SmartPost." }, "postalCode": { "type": "string", "description": "This is placeholder for postal code.
Note: The postal code is required for postal-aware countries." }, "countryCode": { "type": "string", "description": "This is the Two-letter country code. Click here to see Country Codes" }, "residential": { "type": "boolean", "description": "Indicate whether this address is Residential as opposed to Commercial.
Valid Values: True or False.", "enum": [ true, false ] }, "urbanizationCode": { "type": "string", "description": "Relevant only to addresses in Puerto Rico." }, "countryName": { "type": "string", "description": "The fully spelt out name of a country." }, "geographicCoordinates": { "type": "string", "description": "The geographic coordinates cooresponding to this address." }, "classification": { "type": "string", "description": "Specifies that FedEx courier has confirmed that the address is a confirmed business location.", "enum": [ "BUSINESS", "MIXED", "RESIDENTIAL", "UNCONFIRMED_BUSINESS", "UNCONFIRMED_RESIDENCE", "UNKOWN" ] } }, "description": "Descriptive data for a 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)." }, "TransborderDistributionDetail_specialServicesRequested_transborderDistributionLtlDetail_payment_payor_responsibleParty_contact": { "type": "object", "properties": { "contactId": { "type": "string", "description": "Client provided identifier corresponding to this contact information." }, "personName": { "type": "string", "description": "Specify Person Name." }, "tollFreePhoneNumber": { "type": "string", "description": "Specify Toll Free PhoneNumber." }, "emailAddress": { "type": "string", "description": "Specify Email Address." }, "phoneNumber": { "type": "string", "description": "Specify Phone Number." }, "phoneExtension": { "type": "string", "description": "Specify Phone Extension." }, "companyName": { "type": "string", "description": "Specify Company Name." }, "faxNumber": { "type": "string", "description": "Specify Fax Number." }, "pagerNumber": { "type": "string", "description": "Specify Pager Number." }, "title": { "type": "string", "description": "Specify the Title of the Contact." } }, "description": "The descriptive data for a point-of-contact person." }, "Weight": { "required": [ "units", "value" ], "type": "object", "properties": { "units": { "type": "string", "description": "Indicates the weight unit type. The package and commodity weight unit should be the same else the request will result in an error." }, "value": { "type": "number", "description": "This is the weight. Maximum length is 99999.", "format": "double" } }, "description": "Indicate the shipment total weight in pounds.
Example: 10.6
Note: " } } }