{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/fedex/json-schema/fedex-confirm-consolidation-results-response-schema.json", "title": "ConfirmConsolidationResultsResponse", "description": "Wrapper class for ConfirmOpenshipmentOutputVO. 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/ConfirmConsolidationResultsResponse", "type": "object", "properties": { "transactionId": { "type": "string", "description": "The transaction ID is a special set of numbers that defines each transaction.
Example: 624deea6-b709-470c-8c39-4b5511281492" }, "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" }, "output": { "$ref": "#/$defs/BaseProcessOutputVO_ConfirmConsolidationResults" } }, "$defs": { "AccountNumber": { "description": "This is the FedEx Account number.
Example: 123456789", "allOf": [ { "$ref": "#/$defs/PartyAccountNumber" } ] }, "Address": { "required": [ "countryCode", "streetLines" ], "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 ] } }, "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)." }, "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)." }, "AdrLicenseDetail": { "type": "object", "properties": { "licenseOrPermitDetail": { "$ref": "#/$defs/LicenseOrPermitDetail" } }, "description": "Specifies the details around the ADR license required for shipping." }, "Alert": { "type": "object", "properties": { "code": { "type": "string", "description": "Specifies the api alert code." }, "alertType": { "type": "string", "description": "Specifies the api alert type.", "enum": [ "NOTE", "WARNING" ] }, "message": { "type": "string", "description": "Specifies the api alert message." } }, "description": "These are alert details received in the response." }, "AncillaryFeeAndTax": { "description": "Identifies the total amount of the shipment-lvel fees and taxes that are not based on transportation charges of commodity-level estimated duties and taxes.", "type": "object", "properties": { "type": { "description": "Identifies the total amount of the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.", "type": "string", "enum": [ "CLEARANCE_ENTRY_FEE", "GOODS_AND_SERVICES_TAX", "HARMONIZED_SALES_TAX", "OTHER" ] }, "description": { "description": "Identifies the amount of the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.", "type": "string" }, "amount": { "description": "list of AncillaryFees And Taxes", "allOf": [ { "$ref": "#/$defs/Money_1" } ] } } }, "AssociatedTrackingDetails": { "type": "object", "properties": { "trackingIds": { "type": "array", "description": "Tracking details for the package to be retrieved from the Open shipment.", "items": { "$ref": "#/$defs/TrackingIds" } }, "type": { "type": "string", "description": "Provides the type of associated tracking details.
Example: CONSOLIDATION_MASTER", "enum": [ "COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN", "COD_RETURN", "CONSOLIDATION_DOCUMENTS", "CONSOLIDATION_MASTER", "DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN" ] } } }, "BaseProcessOutputVO_ConfirmConsolidationResults": { "type": "object", "properties": { "jobId": { "type": "string", "description": "Unique identifier for a Job. Example: abc123456" }, "processingOptionType": { "type": "string", "description": "This field describes how the the consolidation is processed.\n Example: ASYNCHRONOUSLY_PROCESSED" }, "transactionConsolidations": { "type": "array", "description": "These are consolidation transaction details, such as master tracking number, service type, and ship date and time.", "items": { "$ref": "#/$defs/TransactionConsolidationOutputVO" } }, "alerts": { "type": "array", "description": "The alerts received when a ConsfirmConsolidation is processed. This includes the alert code, alert type, and alert message.", "items": { "$ref": "#/$defs/Alert" } } }, "description": "The response elements received when a shipment is created." }, "BinaryBarcode": { "type": "object", "properties": { "type": { "type": "string", "description": "The kind of barcode data in this instance." }, "value": { "type": "array", "description": "The data content of this instance.", "items": { "type": "string", "format": "byte" } } }, "description": "Each instance of this data type represents a barcode whose content must be represented as binary data (i.e. not ASCII text)." }, "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" }, "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" } } } }, "CompletedCodDetail": { "type": "object", "properties": { "codCollectionAmount": { "$ref": "#/$defs/Money" } }, "description": "Provides the complete collection detail." }, "CompletedEtdDetail": { "type": "object", "properties": { "folderId": { "type": "string", "description": "Returns the folder id where the documents is uploaded.\"" }, "type": { "type": "string", "description": "Returns the type of the document that is being uploaded.\"" }, "uploadDocumentReferenceDetails": { "type": "array", "items": { "$ref": "#/$defs/UploadDocumentReferenceDetail" } } }, "description": "These are completed ETD details when ELECTRONIC_TRADE_DOCUMENTS Special service type is requested" }, "CompletedHazardousPackageDetail": { "type": "object", "properties": { "regulation": { "type": "string", "description": "Specifies the hazardous package regulation type.
Example: IATA" }, "accessibility": { "type": "string", "description": "Specifies the hazardous package accessibility.
Example: ACCESSIBLE" }, "labelType": { "type": "string", "description": "Specifies the label type of hazardous package.
Example: II_YELLOW" }, "containers": { "type": "array", "description": "Indicates one or more approved containers used to pack dangerous goods commodities. This does not describe any individual inner receptacles that may be within this container.", "items": { "$ref": "#/$defs/ValidatedHazardousContainer" } }, "cargoAircraftOnly": { "type": "boolean", "description": "A Boolean value that, when True, specifies the mode of shipment transportation should be Cargo Aircraft for Dangerous Goods. Its default value is set as False.
Note: An identifier DGD-CAO is added in AWB for cargo aircraft shipments." }, "referenceId": { "type": "string", "description": "A unique reference id that matches the package to a package configuration. This is populated if the client provided a package configuration for several packages that have the exact same dangerous goods content." }, "radioactiveTransportIndex": { "type": "number", "description": "Specifies the maximum radiation level from the package (measured in microSieverts per hour at a distance of one meter from the external surface of the package, divided by 10).", "format": "double" } }, "description": "Complete package-level hazardous commodity information for a single package." }, "CompletedHazardousShipmentDetail": { "type": "object", "properties": { "hazardousSummaryDetail": { "$ref": "#/$defs/CompletedHazardousSummaryDetail" }, "adrLicense": { "$ref": "#/$defs/AdrLicenseDetail" }, "dryIceDetail": { "$ref": "#/$defs/ShipmentDryIceDetail" } }, "description": "Completed shipment level hazardous commodity information." }, "CompletedHazardousSummaryDetail": { "type": "object", "properties": { "smallQuantityExceptionPackageCount": { "type": "integer", "description": "Specifies the total number of packages containing hazardous commodities in small exceptions.", "format": "int32" } }, "description": "Specifies Completed Hazardous Summary Detail." }, "CompletedHoldAtLocationDetail": { "type": "object", "properties": { "holdingLocationType": { "type": "string", "description": "Identifies the type of the FedEx holding location.
Example: FEDEX_STAFFED" }, "holdingLocation": { "$ref": "#/$defs/CompletedHoldAtLocationDetail_holdingLocation" } }, "description": "Returns the default holding location information when HOLD_AT_LOCATION special service is requested and the client does not specify the hold location address." }, "CompletedHoldAtLocationDetail_holdingLocation": { "properties": { "address": { "$ref": "#/$defs/Address" }, "contact": { "$ref": "#/$defs/Contact" } }, "description": "Specifies the physical address of the FedEx holding location." }, "CompletedPackageDetail": { "type": "object", "properties": { "sequenceNumber": { "type": "integer", "description": "A positive integer specifying the sequence number for the package in shipment.", "format": "int32" }, "operationalDetail": { "$ref": "#/$defs/PackageOperationalDetail" }, "signatureOption": { "type": "string", "description": "This specifies the actual signature option applied, to allow for cases in which the value requested conflicted with other service features in the shipment." }, "trackingIds": { "type": "array", "description": "The field is present to allow use of preassigned Master Airway Bill tracking number.", "items": { "$ref": "#/$defs/TrackingId" } }, "groupNumber": { "type": "integer", "description": "Used with request containing PACKAGE_GROUPS, to identify which group of identical packages was used to produce a reply item.", "format": "int32" }, "oversizeClass": { "type": "string", "description": "Indicates the oversize Classification." }, "packageRating": { "$ref": "#/$defs/PackageRating" }, "dryIceWeight": { "description": "Descriptive data required for a FedEx shipment containing dry ice. Includes Weight and Units. This element is required when SpecialServiceType DRY_ICE is present in the SpecialServiceTypes collection at the package level.", "allOf": [ { "$ref": "#/$defs/Weight" } ] }, "hazardousPackageDetail": { "$ref": "#/$defs/CompletedHazardousPackageDetail" } }, "description": "Package level details about this package." }, "ConsolidationCompletedShipmentDetail": { "type": "object", "properties": { "completedPackageDetails": { "type": "array", "items": { "$ref": "#/$defs/CompletedPackageDetail" } }, "operationalDetail": { "$ref": "#/$defs/ShipmentOperationalDetail" }, "carrierCode": { "type": "string", "description": "Specify the four letter code of a FedEx operating company that meets your requirements
Examples of FedEx Operating Companies are:" }, "completedHoldAtLocationDetail": { "$ref": "#/$defs/CompletedHoldAtLocationDetail" }, "completedEtdDetail": { "$ref": "#/$defs/CompletedEtdDetail" }, "packagingDescription": { "type": "string", "description": "Specifies packaging description." }, "masterTrackingId": { "$ref": "#/$defs/TrackingId" }, "serviceDescription": { "$ref": "#/$defs/ServiceDescription" }, "usDomestic": { "type": "boolean", "description": "Indicates whether or not this is an intra-U.S. shipment." }, "hazardousShipmentDetail": { "$ref": "#/$defs/CompletedHazardousShipmentDetail" }, "shipmentRating": { "$ref": "#/$defs/ShipmentRating" }, "documentRequirements": { "$ref": "#/$defs/DocumentRequirementsDetail" }, "exportComplianceStatement": { "type": "string", "description": "Specifies export Compliance Statement." }, "accessDetail": { "$ref": "#/$defs/PendingShipmentAccessDetail" }, "shipmentConsolidationDetail": { "$ref": "#/$defs/ShipmentConsolidationDetail" }, "completedCodDetail": { "$ref": "#/$defs/CompletedCodDetail" } }, "description": "Returns the result of processing the desired package as a single-package shipment." }, "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." }, "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." }, "ConsolidationShipments": { "type": "object", "properties": { "shipmentRoleType": { "type": "string", "description": "Specify the role type of shipment", "enum": [ "CONSOLIDATION_DOCUMENTS_SHIPMENT", "CRN_SHIPMENT", "MASTER_AIRWAYBILL_SHIPMENT" ] }, "consolidationRequestedShipments": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments" }, "completedShipmentDetail": { "$ref": "#/$defs/ConsolidationCompletedShipmentDetail" } }, "description": "These are details when Confirm Consolidation is Synchronously Processed." }, "ConsolidationShipments_consolidationRequestedShipments": { "type": "object", "properties": { "shipDatestamp": { "type": "string", "description": "This is shipment date. Both the date and time portions of the string are expected to be used. The date should not be a past date or a date more than 10 days in the future. The time is the local time of the shipment based on the shipper's time zone.
Format: YYYY-MM-DD.
Example: 2019-06-26." }, "dropOffType": { "type": "string", "enum": [ "BUSINESS_SERVICE_CENTER", "DROP_BOX", "REGULAR_PICKUP", "REQUEST_COURIER", "STATION" ] }, "recipientLocationNumber": { "type": "string", "description": "Indicates whether this address is residential (as opposed to commercial).
Example: false" }, "serviceType": { "type": "string", "description": "Indicate the FedEx service type used for this shipment.
Example: STANDARD_OVERNIGHT
click here to see Service Types" }, "packagingType": { "type": "string", "description": "Specify the packaging used.
Note: For Express Freight shipments, the packaging will default to YOUR_PACKAGING irrespective of the user provided package type in the request.
Example: FEDEX_PAK
click here to see Package Types" }, "totalWeight": { "$ref": "#/$defs/Weight" }, "totalDimensions": { "type": "object", "allOf": [ { "$ref": "#/$defs/Dimensions" } ] }, "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": { "allOf": [ { "$ref": "#/$defs/Origin" } ] }, "recipient": { "allOf": [ { "$ref": "#/$defs/SoldToParty" } ] }, "processingOptionsRequested": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_processingOptionsRequested" }, "consolidationDetail": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_consolidationDetail" }, "customsClearanceDetail": { "$ref": "#/$defs/CustomsClearanceDetail" }, "blockinsightVisibility": { "type": "boolean" }, "labelSpecification": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_labelSpecification" }, "rateRequestTypes": { "type": "string", "description": "Indicate the type of rates to be returned. The account specific rates are returned by default if the account number is specified in the request.
Following are values:Examples: [\"ACCOUNT\", \"PREFERRED\"]", "enum": [ "ACCOUNT", "CUSTOM", "INCENTIVE", "LIST", "NONE", "PREFERRED", "RATED", "RETAIL" ] }, "edtRequestTypes": { "type": "string", "description": "Specify whether the customer wishes to have Estimated Duties and Taxes provided with the rate quotation on this shipment. Only applies with shipments moving under international services.", "enum": [ "ALL", "NONE" ] }, "requestedPackageLineItems": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_requestedPackageLineItems" }, "completedShipmentDetail": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail" } } }, "ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail": { "type": "object", "properties": { "usDomestic": { "type": "boolean", "description": "Indicates whether or not this is an intra-U.S. shipment." }, "carrierCode": { "type": "string", "description": "Specify the four letter code of a FedEx operating company that meets your requirements
Examples of FedEx Operating Companies are:", "enum": [ "FDXC", "FDXE", "FDXG", "FDXO", "FXCC", "FXFR", "FXSP" ] }, "masterTrackingId": { "$ref": "#/$defs/TrackingIds" }, "serviceDescription": { "$ref": "#/$defs/ServiceDescription" }, "packageDescription": { "$ref": "#/$defs/PackageDescription" }, "specialServiceDescription": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail_specialServiceDescription" }, "operationalDetail": { "$ref": "#/$defs/ShipmentOperationalDetail" }, "consolidationDetail": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail_consolidationDetail" }, "exportComplianceStatement": { "type": "string", "description": "For shipments requiring an EEI, enter the ITN number received from AES when you filed your shipment or the FTR (Foreign Trade Regulations) exemption number.The proper format for an ITN number is AES XYYYYMMDDNNNNNN where YYYYMMDD is date and NNNNNN are numbers generated by the AES.

Note: The ITN or FTR exemption number you submit in the Ship request prints on the international shipping label.

" }, "documentRequirements": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail_documentRequirements" }, "completedPackageDetail": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail_completedPackageDetail" } }, "description": "Returns the result of processing the desired package as a single-package shipment." }, "ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail_completedPackageDetail": { "type": "object", "properties": { "sequenceNumber": { "type": "integer", "description": "This is package sequence number. No negative value or decimals are allowed.
Example: 256" }, "trackingId": { "$ref": "#/$defs/TrackingIds" }, "groupNumber": { "type": "integer", "description": "This is group shipment number. Used with request containing PACKAGE_GROUPS, to identify which group of identical packages was used to produce a reply item.
Example: 10" }, "operationalDetail": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail_completedPackageDetail_operationalDetail" }, "label": { "$ref": "#/$defs/Label" }, "packageDocuments": { "type": "array", "items": { "$ref": "#/$defs/ShippingDocument" } }, "signatureOptions": { "type": "string", "description": "It specifies the signature option applied, to allow cases in which the value requested conflicted with other service features in the shipment.
Example: DIRECT", "enum": [ "ADULT", "DIRECT", "INDIRECT", "NO_SIGNATURE_REQUIRED", "SERVICE_DEFAULT" ] } }, "description": "Indicates the completed package details." }, "ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail_completedPackageDetail_operationalDetail": { "type": "object", "properties": { "operationalInstructions": { "$ref": "#/$defs/OperationalInstructions" }, "barcodes": { "$ref": "#/$defs/PackageBarcodes" } } }, "ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail_consolidationDetail": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INTERNATIONAL_DISTRIBUTION_FREIGHT", "INTERNATIONAL_ECONOMY_DISTRIBUTION", "INTERNATIONAL_GROUND_DISTRIBUTION", "INTERNATIONAL_PRIORITY_DISTRIBUTION", "TRANSBORDER_DISTRIBUTION" ] }, "role": { "type": "string", "enum": [ "CONSOLIDATION_DOCUMENTS_SHIPMENT", "CRN_SHIPMENT", "MASTER_AIRWAYBILL_SHIPMENT" ] } } }, "ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail_documentRequirements": { "type": "object", "properties": { "requiredDocuments": { "type": "string", "description": "Indicates the required documents information.
Example: [\"COMMERCIAL_OR_PRO_FORMA_INVOICE\",\"AIR_WAYBILL\"]", "enum": [ "AIR_WAYBILL", "CERTIFICATE_OF_ORIGIN", "COMMERCIAL_INVOICE", "COMMERCIAL_OR_PRO_FORMA_INVOICE", "COMMERCIAL_OR_PRO_FORMA_INVOICE_OR_USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN", "PRO_FORMA_INVOICE" ] }, "generationDetails": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail_documentRequirements_generationDetails" } }, "description": "Indicates the document requirements detail." }, "ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail_documentRequirements_generationDetails": { "type": "object", "properties": { "type": { "type": "string", "description": "It is an Enterprise Document Type.
Example: COMMERCIAL_INVOICE", "enum": [ "AIR_WAYBILL", "CERTIFICATE_OF_ORIGIN", "COMMERCIAL_INVOICE", "PRO_FORMA_INVOICE", "USMCA_CERTIFICATION_OF_ORIGIN", "USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN" ] }, "minimumCopiesRequired": { "type": "integer", "description": "It is a non-Negative Integer.
Example: 3" } }, "description": "Specifies the generation details." }, "ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail_specialServiceDescription": { "type": "object", "properties": { "identifier": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail_specialServiceDescription_identifier" }, "names": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail_specialServiceDescription_names" } } }, "ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail_specialServiceDescription_identifier": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "code": { "type": "string" } } }, "ConsolidationShipments_consolidationRequestedShipments_completedShipmentDetail_specialServiceDescription_names": { "type": "object", "properties": { "type": { "type": "string" }, "encoding": { "type": "string" }, "value": { "type": "string" } } }, "ConsolidationShipments_consolidationRequestedShipments_consolidationDetail": { "type": "object", "properties": { "relationshipTimeStamp": { "type": "string" }, "type": { "type": "string", "enum": [ "INTERNATIONAL_DISTRIBUTION_FREIGHT", "INTERNATIONAL_ECONOMY_DISTRIBUTION", "INTERNATIONAL_GROUND_DISTRIBUTION", "INTERNATIONAL_PRIORITY_DISTRIBUTION", "TRANSBORDER_DISTRIBUTION" ] }, "role": { "type": "string", "enum": [ "CONSOLIDATION_DOCUMENTS_SHIPMENT", "CRN_SHIPMENT", "MASTER_AIRWAYBILL_SHIPMENT" ] }, "internationalDistribtuionDetail": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_consolidationDetail_internationalDistribtuionDetail" }, "transborderDistributionDetail": { "$ref": "#/$defs/TransborderDistributionDetail" } }, "description": "Specify the consolidation details" }, "ConsolidationShipments_consolidationRequestedShipments_consolidationDetail_internationalDistribtuionDetail": { "type": "object", "properties": { "summaryDetail": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_consolidationDetail_internationalDistribtuionDetail_summaryDetail" } } }, "ConsolidationShipments_consolidationRequestedShipments_consolidationDetail_internationalDistribtuionDetail_summaryDetail": { "type": "object", "properties": { "totalWeight": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_consolidationDetail_internationalDistribtuionDetail_summaryDetail_totalWeight" }, "totalPackageCount": { "type": "integer", "description": "non-negative number" }, "totalUniqueAddressCount": { "type": "integer", "description": "non-negative number" }, "totalCustomsValue": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_consolidationDetail_internationalDistribtuionDetail_summaryDetail_totalCustomsValue" } } }, "ConsolidationShipments_consolidationRequestedShipments_consolidationDetail_internationalDistribtuionDetail_summaryDetail_totalCustomsValue": { "type": "object", "properties": { "currency": { "type": "string" }, "amount": { "type": "string" } } }, "ConsolidationShipments_consolidationRequestedShipments_consolidationDetail_internationalDistribtuionDetail_summaryDetail_totalWeight": { "type": "object", "properties": { "units": { "type": "string", "enum": [ "KG", "LB" ] }, "value": { "type": "string" } } }, "ConsolidationShipments_consolidationRequestedShipments_labelSpecification": { "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" ] }, "labelPrintingOrientation": { "type": "string", "description": "This is applicable only to documents produced on thermal printers with roll stock.", "enum": [ "BOTTOM_EDGE_OF_TEXT_FIRST", "TOP_EDGE_OF_TEXT_FIRST" ] } }, "description": "Details about the image type, printer format, and label stock for label. Can also specify customer specific details such as doc-tab content, regulatory labels, and mask data on the label." }, "ConsolidationShipments_consolidationRequestedShipments_processingOptionsRequested": { "type": "object", "properties": { "options": { "type": "string", "enum": [ "ALLOW_PREVIOUS_SHIP_DATE", "BYPASS_REGULATORY_VALIDATION", "CONVENIENCE_MULTIPLE_PACKAGES", "CUSTOM_TRANSIT_TIME", "FUTURE_DAY_SHIPMENT", "IATA_CLASS_AND_AIRCRAFT_ONLY", "MANUAL_AIRBILL", "NO_COMMITMENT_DATE_REQUESTED", "PACKAGE_LEVEL_COMMODITIES", "PRE_EIG_PROCESSING", "PRE_ETD_ENHANCEMENTS", "PRE_FXF2020_HANDLING_UNIT_DETAILS", "PRE_GPR", "PRE_GRAPE2_SHIPMENT", "PRE_MULTIPLIER_PROCESSING", "REQUEST_LEGACY_GROUND_ECONOMY_LABEL", "REQUEST_LEGACY_SMARTPOST_LABEL", "REQUIRE_PRE_EPIC_BARCODE" ] } } }, "ConsolidationShipments_consolidationRequestedShipments_requestedPackageLineItems": { "type": "object", "properties": { "sequenceNumber": { "type": "string", "description": "Optional.
Used only with individual packages as a unique identifier of each requested package. Will be adjusted at the shipment level as pieces are added." }, "groupNumber": { "type": "string", "description": "This is group shipment number. Used with request containing PACKAGE_GROUPS, to identify which group of identical packages was used to produce a reply item.
Example: 10" }, "groupPackageCount": { "type": "string", "description": "Indicate the grouped package count. These are number of identical package(s) each with one or more commodities.
Example: 2" }, "trackingId": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_requestedPackageLineItems_trackingId" }, "weights": { "allOf": [ { "$ref": "#/$defs/Weight" } ] }, "dimensions": { "allOf": [ { "$ref": "#/$defs/Dimensions" } ] }, "customerReferences": { "$ref": "#/$defs/ConsolidationShipments_consolidationRequestedShipments_requestedPackageLineItems_customerReferences" } }, "description": "These are one or more package-attribute descriptions, each of which describes an individual package, a group of identical packages, or (for the total-piece-total-weight case) common characteristics of all packages in the shipment." }, "ConsolidationShipments_consolidationRequestedShipments_requestedPackageLineItems_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_LADING", "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": "These are additional customer reference data for commercial invoice.
Note: The groupPackageCount must be specified to retrieve customer references." }, "ConsolidationShipments_consolidationRequestedShipments_requestedPackageLineItems_trackingId": { "type": "object", "properties": { "trackindIdType": { "type": "string", "description": "Indicates the tracking details of the package.", "enum": [ "EXPRESS", "FEDEX", "FREIGHT", "GROUND", "INTERNAL", "UNKNOWN", "USPS" ] }, "formId": { "type": "string", "description": "This is FedEx tracking Identifier associated with the package.
Example: 8600" }, "trackingNumber": { "type": "string", "description": "This is the number associated with the package that is used to track it.
Example: 49XXX0000XXX20032835" } }, "description": "Indicates the tracking details of the package." }, "Contact": { "type": "object", "properties": { "personName": { "type": "string", "description": "Specify person name.
Example: John Taylor" }, "tollFreePhoneNumber": { "type": "string", "description": "Specify toll free phone number.
Example: XXXX7812" }, "emailAddress": { "type": "string", "description": "Specify email address.
Example: sample@company.com" }, "phoneNumber": { "type": "string", "description": "Specify phone number.
Example: XXX567890" }, "phoneExtension": { "type": "string", "description": "Specify phone extension.
Example: 91" }, "companyName": { "type": "string", "description": "Specify Company Name." }, "pagerNumber": { "type": "string", "description": "Specify pager number.
Example: XXX7812" }, "faxNumber": { "type": "string", "description": "Specify fax number.
Example: XXXX567890" }, "title": { "type": "string", "description": "Specify the Title of the Contact." } }, "description": "Specifies the Contact information." }, "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." }, "CurrencyExchangeRate": { "type": "object", "properties": { "rate": { "type": "number", "description": "Multiplier used to convert from Currency units to into Currency units.
Example: 25.6", "format": "double" }, "fromCurrency": { "type": "string", "description": "The currency code for the original (converted FROM) currency.
Click here to see Currency Codes" }, "intoCurrency": { "type": "string", "description": "The currency code for the final(converted INTO) currency.
Click here to see Currency Codes" } }, "description": "Specifies the currency exchange performed on financial amounts on this rate." }, "CustomerReference": { "type": "object", "properties": { "customerReferenceType": { "type": "string", "description": "This is a customer reference type. Note: Use type Type, RMA_ASSOCIATION and value as the RMA Number to associate Ground Call Tag shipments to the outbound shipment.
Example: DEPARTMENT_NUMBER", "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" } } }, "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." }, "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." }, "DocumentGenerationDetail": { "type": "object", "properties": { "letterhead": { "type": "string", "description": "Indicates the letterhead requirement type." }, "electronicSignature": { "type": "string", "description": "Indicates electronic signature requirement type." }, "minimumCopiesRequired": { "type": "integer", "description": "Is a non negative integer.", "format": "int32" }, "type": { "type": "string", "description": "Is an Enterprise Document Type." } }, "description": "Provides the document generation detail info." }, "DocumentRequirementsDetail": { "type": "object", "properties": { "requiredDocuments": { "type": "array", "description": "Provides the required documents info.", "items": { "type": "string" } }, "prohibitedDocuments": { "type": "array", "description": "Provides the prohibited Documents info.", "items": { "type": "string" } }, "generationDetails": { "type": "array", "description": "Provides the generation details.", "items": { "$ref": "#/$defs/DocumentGenerationDetail" } } }, "description": "Provides the document requirements detail." }, "EdtCommodityTax": { "description": "The shipment/package Duties and taxes.", "type": "object", "properties": { "harmonizedCode": { "description": "Harmonized code is used by customer to classify the product being shipped and define the duties and taxes to be paid.", "type": "string" }, "taxes": { "$ref": "#/$defs/EdtTaxDetail_1" }, "total": { "description": "Total of Duties and taxes", "allOf": [ { "$ref": "#/$defs/Money_1" } ] } } }, "EdtTaxDetail_1": { "description": "Estimated duties and taxes detail.", "type": "object", "properties": { "taxType": { "description": "Estimated taxes type", "type": "string", "enum": [ "ADDITIONAL_TAXES", "CONSULAR_INVOICE_FEE", "CUSTOMS_SURCHARGES", "DUTY", "EXCISE_TAX", "FOREIGN_EXCHANGE_TAX", "GENERAL_SALES_TAX", "IMPORT_LICENSE_FEE", "INTERNAL_ADDITIONAL_TAXES", "INTERNAL_SENSITIVE_PRODUCTS_TAX", "OTHER", "SENSITIVE_PRODUCTS_TAX", "STAMP_TAX", "STATISTICAL_TAX", "TRANSPORT_FACILITIES_TAX" ] }, "taxcode": { "type": "string" }, "effectiveDate": { "description": "Estimated duties and taxes effective date. Format [YYYY-MM-DD].", "type": "string" }, "name": { "description": "The localized name of the surcharge.", "type": "string" }, "taxableValue": { "description": "Estimated duties and taxes taxable Value.", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "description": { "description": "FedEx pays the Duty and Tax charges on your behalf to ensure we can deliver your shipment as quickly as possible", "type": "string" }, "formula": { "description": "Indicates the formula.", "type": "string" }, "amount": { "description": "Amount for the estimated duties and taxes type.", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "taxRates": { "description": "Estimated duties and taxes taxRates", "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "currency": { "type": "string" }, "quantity": { "format": "double", "type": "number" }, "unitOfMeasure": { "type": "string" } } } }, "appliedPreferentialTradeAgreement": { "description": "provides details about PTA applied between countries for specific product. ", "type": "object", "properties": { "id": { "description": "", "type": "string" }, "name": { "description": "", "type": "string" }, "description": { "description": "", "type": "string" } } } } }, "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." }, "HazardousCommodityContent001": { "type": "object", "properties": { "quantity": { "$ref": "#/$defs/HazardousCommodityQuantityDetail" }, "innerReceptacles": { "type": "array", "items": { "$ref": "#/$defs/HazardousCommodityInnerReceptacleDetail01" } }, "options": { "$ref": "#/$defs/HazardousCommodityOptionDetail01" }, "description": { "$ref": "#/$defs/HazardousCommodityDescription01" } }, "description": "Customer-provided specifications for handling individual commodities." }, "HazardousCommodityDescription01": { "required": [ "packingGroup", "reportableQuantity" ], "type": "object", "properties": { "sequenceNumber": { "type": "integer", "description": "RequiredSpecify the sequence number.", "format": "int32" }, "processingOptions": { "type": "array", "description": "Indicates any special processing options to be applied to the description of the dangerous goods commodity", "items": { "type": "string", "enum": [ "INCLUDE_SPECIAL_PROVISIONS" ] } }, "subsidiaryClasses": { "type": "array", "description": "Required. Provides list of subsidiary classes", "items": { "type": "string" } }, "labelText": { "type": "string", "description": "Specifies the text for the label.\n" }, "technicalName": { "type": "string", "description": "'The element specifies the technical name for the hazardous material.'\n\n" }, "packingDetails": { "$ref": "#/$defs/HazardousCommodityPackingDetail01" }, "authorization": { "type": "string", "description": "Authorization" }, "reportableQuantity": { "type": "boolean", "description": "Reportable Quantity", "enum": [ true, false ] }, "percentage": { "type": "number", "description": "Percentage", "format": "double" }, "id": { "type": "string", "description": "ID" }, "packingGroup": { "type": "string", "description": "Identifies DOT packing group for a hazardous commodity", "enum": [ "DEFAULT", "I", "II", "III" ] }, "properShippingName": { "type": "string", "description": "The proper shipping name as defined by the regulation. The name can also include qualifying words" }, "hazardClass": { "type": "string", "description": "'Specifies the hazard class for the commodity.'\n" } }, "description": "RequiredDetails of HazardousCommodityDescription" }, "HazardousCommodityInnerReceptacleDetail01": { "type": "object", "properties": { "quantity": { "$ref": "#/$defs/HazardousCommodityQuantityDetail002" } } }, "HazardousCommodityOptionDetail01": { "type": "object", "properties": { "labelTextOption": { "type": "string", "description": "Provides the label text option", "enum": [ "APPEND", "OVERRIDE", "STANDARD" ] }, "customerSuppliedLabelText": { "type": "string", "description": "'DG Data Upload Mode:- Optional.,DG Full Validation Mode:- Optional,Text used in labeling the commodity under control of the LabelTextOption field.'\n" } }, "description": "Provides details of Hazardous Commodity Option Detail" }, "HazardousCommodityPackingDetail01": { "required": [ "cargoAircraftOnly" ], "type": "object", "properties": { "packingInstructions": { "type": "string", "description": "Coded specification for how commodity is to be packed." }, "cargoAircraftOnly": { "type": "boolean", "description": "Shipment is packaged/documented for movement ONLY on cargo aircraft", "enum": [ true, false ] } }, "description": "Specifies documentation and limits for validation of an individual packing group/category. DG Data Upload Mode: Required (IATA), Optional (Other), DG Full Validation Mode: Required (IATA), Optional (Other)," }, "HazardousCommodityQuantityDetail": { "required": [ "amount", "quantityType" ], "type": "object", "properties": { "quantityType": { "type": "string", "description": "Specifies which measure of quantity is to be validated.", "enum": [ "GROSS", "NET" ] }, "amount": { "type": "number", "description": "Number of units of the type below.", "format": "double" }, "units": { "type": "string", "description": "Indicates the units of the package quantity." } }, "description": "Provides Hazardous Commodity Quantity Detail" }, "HazardousCommodityQuantityDetail002": { "required": [ "amount", "quantityType" ], "type": "object", "properties": { "quantityType": { "type": "string", "description": "Specifies which measure of quantity is to be validated.", "enum": [ "GROSS", "NET" ] }, "amount": { "type": "number", "description": "Number of units of the type below.", "format": "double" }, "units": { "type": "string", "description": "specifies the units." } }, "description": "Provides Hazardous Commodity Quantity Detail" }, "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" } ] }, "Label": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of label being used for the package", "enum": [ "AUXILIARY_LABEL - CERTIFICATE_OF_ORIGIN - COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_2_D_BARCODE - COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_LABEL - COD_RETURN_2_D_BARCODE - COD_RETURN_LABEL - COMMERCIAL_INVOICE - CUSTOM_PACKAGE_DOCUMENT - CUSTOM_SHIPMENT_DOCUMENT - DANGEROUS_GOODS_SHIPPERS_DECLARATION - DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_2_D_BARCODE - DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_LABEL - ETD_LABEL - EXPORT_DECLARATION - FEDEX_FREIGHT_STRAIGHT_BILL_OF_LADING - FREIGHT_ADDRESS_LABEL - GENERAL_AGENCY_AGREEMENT - GROUND_BARCODE - OP_900 - OUTBOUND_2_D_BARCODE - OUTBOUND_LABEL - PENDING_SHIPMENT_EMAIL_NOTIFICATION - PRO_FORMA_INVOICE - RECIPIENT_ADDRESS_BARCODE - RECIPIENT_POSTAL_BARCODE - RETURN_INSTRUCTIONS - TERMS_AND_CONDITIONS - USMCA_CERTIFICATION_OF_ORIGIN - USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN - USPS_BARCODE - VICS_BILL_OF_LADING" ] }, "shippingDocumentDisposition": { "type": "string", "description": "Use this object to provide all data required for additional (non-label) shipping documents to be produced.", "enum": [ "CONFIRMED", "DEFERRED_QUEUED", "DEFERRED_RETURNED", "DEFERRED_STORED", "EMAILED", "QUEUED", "RETURNED", "STORED" ] }, "imageType": { "type": "string", "description": "Specify the image format used for a shipping document.
click here to see label format types", "enum": [ "DIB", "DOC", "DPL", "EPL2", "GIF", "PDF", "PNG", "RTF", "TEXT", "ZPLII" ] }, "resolution": { "type": "integer", "description": "Specifies the image resolution in DPI (Dots per inch)." }, "copiesToPrint": { "type": "integer", "description": "Indicates the number of copies to print. It can be zero for document with disposition as no content is included." }, "parts": { "$ref": "#/$defs/Label_parts" } }, "description": "Label details for the package" }, "LabelResponseVO": { "type": "object", "properties": { "copiesToPrint": { "type": "integer", "description": "These are the number of copies to print for the specific document type.
Example: 10", "format": "int32" }, "contentType": { "type": "string", "description": "Indicates the type of document/label.", "enum": [ "LABEL", "BILL_OF_LADING", "GAA_FORM", "HAZMAT_LABEL", "END_OF_DAY_HAZMAT_REPORT", "MANIFEST_REPORT", "MULTIWEIGHT_REPORT", "MERGED_LABEL_DOCUMENTS", "AUXILIARY", "RETURN_INSTRUCTIONS", "ACCEPTANCE_LABEL", "COMMERCIAL_INVOICE", "PROFORMA_INVOICE", "USMCA_CERTIFICATION_OF_ORIGIN", "CERTIFICATE_OF_ORIGIN", "MERGED_LABELS_ONLY" ] }, "trackingNumber": { "type": "string", "description": "This is the tracking number of the package.
Example: 49XXX0000XXX20032835
" }, "docType": { "type": "string", "description": "This is the document type.
Example: PDF" }, "encodedLabel": { "type": "string", "description": "Specifies if the document is encoded.
Example: encoded label" }, "url": { "type": "string", "description": "The URL of the shipping document/label
Example: https://.../document/v2/document/retrieve/SH,794816968200_Merge/isLabel=true&autoPrint=false
Note: The URL once created will be active for 24 hours." } }, "description": "These are shipping document/label specific information." }, "Label_parts": { "type": "object", "properties": { "documentPartSequenceNumber": { "type": "integer", "description": "Specifies the one-origin position of this part within a document." }, "image": { "description": "Specifies the one-origin position of this part within a document." } }, "description": "Indicates documentation part details." }, "LicenseOrPermitDetail": { "type": "object", "properties": { "number": { "type": "string", "description": "Specifies License Or PermitDetail number." }, "effectiveDate": { "type": "string", "description": "Specifies Effective Date.
Format [YYYY-MM-DD]" }, "expirationDate": { "type": "string", "description": "Specifies Expiration Date.
Format [YYYY-MM-DD]
Example: 2019-04-09" } }, "description": "This contains the ADR License information, which identifies the license number, the effective date and the expiration date under which the customer is allowed to ship." }, "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." }, "NetExplosiveDetail": { "type": "object", "properties": { "amount": { "type": "number", "description": "Specifies Amount.", "format": "double" }, "units": { "type": "string", "description": "Specifies Net Explosive units." }, "type": { "type": "string", "description": "Specifies Net Explosive Classification type." } }, "description": "specifies the total mass of the contained explosive substances, without the mass of any casings, bullets, shells, etc." }, "OperationalInstructions": { "type": "object", "properties": { "number": { "type": "integer", "description": "Specifies the number of operational instructions returned for this shipment.
Example: 17", "format": "int32" }, "content": { "type": "string", "description": "This is an operational instruction printed or available on the shipping document.
Example: SECURED" } }, "description": "These are operational instruction such as Ground Information printed on a given area of the label, one-dimensional barcode with only x-axis that contains the details of the shipment in encrypted form, COD Return operational instructions data such as COD amount, SECURED or UNSECURED." }, "Origin": { "type": "object", "properties": { "address": { "$ref": "#/$defs/PartyAddress" }, "contact": { "$ref": "#/$defs/PartyContact" } }, "description": "The descriptive information for the customer origin." }, "PackageBarcodes": { "type": "object", "properties": { "binaryBarcodes": { "type": "array", "items": { "$ref": "#/$defs/BinaryBarcode" } }, "stringBarcodes": { "type": "array", "items": { "$ref": "#/$defs/StringBarcode" } } }, "description": "Each instance of this data type represents the set of barcodes (of all types) which are associated with a specific package." }, "PackageDescription": { "type": "object", "properties": { "packagingType": { "type": "string", "description": "Specify the packaging used.
Note: For Express Freight shipments, the packaging will default to YOUR_PACKAGING irrespective of the user provided package type in the request.
Example: FEDEX_PAK
click here to see Package Types" }, "code": { "type": "string", "description": "Specifies code of the Service.
example: 80" }, "names": { "type": "array", "description": "Branded, translated, and/or localized names for this service.", "items": { "$ref": "#/$defs/ProductName" } }, "astraDescription": { "type": "string", "description": "Specifies astra description.
Example: SMART POST" }, "description": { "type": "string" } }, "description": "Provides Service Description." }, "PackageOperationalDetail": { "type": "object", "properties": { "astraHandlingText": { "type": "string", "description": "Human-readable text for pre-January 2011 clients.
Example: astraHandlingText" }, "barcodes": { "$ref": "#/$defs/PackageBarcodes" }, "operationalInstructions": { "type": "array", "items": { "$ref": "#/$defs/OperationalInstructions" } } }, "description": "Package-level data required for labeling and/or movement." }, "PackageRateDetail": { "type": "object", "properties": { "ratedWeightMethod": { "type": "string", "description": "Indicates which weight was used in calculating this rate, such as actual weight or dimensional weight." }, "totalFreightDiscounts": { "type": "number", "description": "The sum of all discounts on this package.", "format": "double" }, "totalTaxes": { "type": "number", "description": "The sum of all taxes on this package.", "format": "double" }, "minimumChargeType": { "type": "string", "description": "Indicates the type for minumum charges. INTERNAL FEDEX USE ONLY." }, "baseCharge": { "type": "number", "description": "The transportation charge only (prior to any discounts applied) for this package.", "format": "double" }, "totalRebates": { "type": "number", "description": "Specifies Total Rebates on this package.", "format": "double" }, "rateType": { "type": "string", "description": "Type used for this specific set of rate data." }, "billingWeight": { "$ref": "#/$defs/Weight" }, "netFreight": { "type": "number", "description": "This is base charge minus total freight discounts for a package.", "format": "double" }, "surcharges": { "type": "array", "description": "All surcharges that apply to this shipment.
click here to see Surcharges", "items": { "$ref": "#/$defs/Surcharge" } }, "totalSurcharges": { "type": "number", "description": "The total amount of all surcharges applied to this shipment.
Example: 9.88", "format": "double" }, "netFedExCharge": { "type": "number", "description": "This is sum of net freight and total surcharges (not including totalTaxes) for this package.", "format": "double" }, "netCharge": { "type": "number", "description": "This is the sum of net freight, total surcharges and total taxes for a package.", "format": "double" }, "currency": { "type": "string", "description": "The currency code. Click here to see Currency Codes" } }, "description": "Details of the rates associated with the package, as calculated per a specific rate type." }, "PackageRating": { "type": "object", "properties": { "effectiveNetDiscount": { "type": "number", "description": "This is the difference between the list and account net charge.", "format": "double" }, "actualRateType": { "type": "string", "description": "This rate type identifies which entry in the following array is considered as presenting the actual rates for the package." }, "packageRateDetails": { "type": "array", "items": { "$ref": "#/$defs/PackageRateDetail" } } }, "description": "This class groups together all package-level rate data for a single package (across all rate types) as part of the response to a shipping request, which groups shipment-level data together and groups package-level data by package." }, "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." }, "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": "" }, "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." }, "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. " }, "PendingShipmentAccessDetail": { "type": "object", "properties": { "accessorDetails": { "type": "array", "description": "Indicates the details about the users who can access the shipment.", "items": { "$ref": "#/$defs/PendingShipmentAccessorDetail" } } }, "description": "This information describes how and when a online email return label shipment may be accessed for completion." }, "PendingShipmentAccessorDetail": { "type": "object", "properties": { "password": { "type": "string", "description": "Specifies the accessor password." }, "role": { "type": "string", "description": "Specifies the accessor role." }, "emailLabelUrl": { "type": "string", "description": "Specifies the URL for the email label." }, "userId": { "type": "string", "description": "Specifies the accessor User ID." } }, "description": "Specifies details for how to access the pending email return label." }, "PieceResponse": { "type": "object", "properties": { "packageDocuments": { "type": "array", "description": "These are package documents returned in the response", "items": { "$ref": "#/$defs/PieceResponses_1" } } }, "description": "Piece Response information." }, "PieceResponses_1": { "type": "object", "properties": { "masterTrackingNumber": { "type": "string", "description": "This is a master tracking number for the shipment (must be unique for stand-alone open shipments, or unique within consolidation if consolidation key is provided).
Example: 794953535000" }, "trackingNumber": { "type": "string", "description": "This is a tracking number associted with this package.
Example: 49XXX0000XXX20032835" }, "additionalChargesDiscount": { "type": "number", "description": "These are additional charges or discounts.
Example: 621.45", "format": "double" }, "netRateAmount": { "type": "number", "description": "Returns the net rate amount.
Example: 1.45", "format": "double" }, "netChargeAmount": { "type": "number", "description": "Indicates Net charge amount.
Example: 21.45", "format": "double" }, "netDiscountAmount": { "type": "number", "description": "Returns the net discount amount.
Example: 121.45", "format": "double" }, "packageDocuments": { "type": "array", "description": "These are package documents returned in the response", "items": { "$ref": "#/$defs/LabelResponseVO" } }, "customerReferences": { "type": "array", "description": "Additional customer reference data", "items": { "$ref": "#/$defs/CustomerReference" } }, "codcollectionAmount": { "type": "number", "description": "Returns the Collect on Delivery charges.
Example: 231.45", "format": "double" }, "baseRateAmount": { "type": "number", "description": "Returns the base rate amount.
Example: 321.45", "format": "double" } }, "description": "These are shipping document/label specific information." }, "ProductName": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of name (long, medium, short, etc.) to which this value refers.
Example: long" }, "encoding": { "type": "string", "description": "The character encoding used to represent this product name.
Example: UTF-8" }, "value": { "type": "string", "description": "Specifies the value of the Product.
Example: F-2" } }, "description": "Product Name information." }, "RateDiscount": { "type": "object", "properties": { "amount": { "type": "number", "description": "Specifies the amount.", "format": "double" }, "rateDiscountType": { "type": "string", "description": "The type of rate discount.
Valid Values are BONUS, COUPON,EARNED,OTHER,VOLUME." }, "percent": { "type": "number", "description": "Specifies the percentage of Rate discount.", "format": "double" }, "description": { "type": "string", "description": "Specifies the description of the discounted rate." } }, "description": "Specifies discount Rate for Shipment." }, "RateDiscount_2": { "type": "object", "properties": { "rateDiscountType": { "description": "Indicates the type.", "type": "string", "enum": [ "BONUS", "COUPON", "EARNED", "INCENTIVE", "OTHER", "VOLUME" ] }, "description": { "description": "Indicates the description for the rate discount.", "type": "string" }, "amount": { "description": "Indicates the amount for the rate discount.", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "percent": { "format": "double", "type": "number" } } }, "Rebate": { "type": "object", "properties": { "rebateType": { "description": "The type of rebate.", "type": "string", "enum": [ "BONUS", "EARNED", "OTHER" ] }, "description": { "description": "The description of the rebate", "type": "string" }, "amount": { "description": "provides the calculated rebate amount based on customer details, transaction information, and applicable rules. ", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "percent": { "format": "double", "type": "number" } } }, "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." }, "ServiceDescription": { "type": "object", "properties": { "serviceType": { "type": "string", "description": "Indicates the type of service that is used to ship the package. Click here to see Service Types" }, "code": { "type": "string", "description": "Specifies code of the Service." }, "names": { "type": "array", "description": "Branded, translated, and/or localized names for this service.", "items": { "$ref": "#/$defs/ProductName" } }, "operatingOrgCodes": { "type": "array", "description": "FOR FEDEX INTERNAL USE ONLY. The operating org code in a service.", "items": { "type": "string" } }, "astraDescription": { "type": "string", "description": "Specifies astra Description.
Example: 2 DAY FRT" }, "description": { "type": "string", "description": "Specifies the description." }, "serviceId": { "type": "string", "description": "FOR FEDEX INTERNAL USE ONLY, Designates the service ID.
Example: EP1000000027" }, "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.
Example: EXPRESS_PARCEL" } }, "description": "Provides Service Description." }, "ShipmentConsolidationDetail": { "type": "object", "properties": { "type": { "type": "string", "description": "Provides the type of shipment consolidation.
Example: INTERNATIONAL_PRIORITY_DISTRIBUTION", "enum": [ "INTERNATIONAL_DISTRIBUTION_FREIGHT", "INTERNATIONAL_ECONOMY_DISTRIBUTION", "INTERNATIONAL_GROUND_DISTRIBUTION", "INTERNATIONAL_PRIORITY_DISTRIBUTION", "TRANSBORDER_DISTRIBUTION" ] }, "role": { "type": "string", "description": "Provides the role of consolidation shipment.
Example: CRN_SHIPMENT", "enum": [ "CONSOLIDATION_DOCUMENTS_SHIPMENT", "CRN_SHIPMENT", "MASTER_AIRWAYBILL_SHIPMENT" ] }, "associatedTrackingIds": { "type": "array", "description": "Provides the associated tracking id", "items": { "$ref": "#/$defs/AssociatedTrackingDetails" } } }, "description": "Provides the shipment consolidation details." }, "ShipmentDryIceDetail": { "required": [ "packageCount", "totalWeight" ], "type": "object", "properties": { "totalWeight": { "description": "Specifies the Dry Ice Total Weight for the shipment", "allOf": [ { "$ref": "#/$defs/Weight" } ] }, "packageCount": { "type": "integer", "description": "specifies the package Count for the shipment.", "format": "int32" }, "processingOptions": { "$ref": "#/$defs/ShipmentDryIceProcessingOptionsRequested" } }, "description": "Shipment-level totals of dry ice data across all packages." }, "ShipmentDryIceProcessingOptionsRequested": { "type": "object", "properties": { "options": { "type": "array", "description": "Specifies the options.
Example: [\"options\"]", "items": { "type": "string" } } }, "description": "Specify that dry ice information is only applicable at the shipment level. Package level dry ice information would not apply." }, "ShipmentLegRateDetail": { "type": "object", "properties": { "rateZone": { "type": "string", "description": "Indicates the rate zone used (based on origin and destination)." }, "pricingCode": { "type": "string", "description": "Specifies the Pricing Code." }, "taxes": { "type": "array", "description": "Specifies the taxes.", "items": { "$ref": "#/$defs/Tax" } }, "totalDimWeight": { "description": "Sum of dimensional weights for all packages.", "allOf": [ { "$ref": "#/$defs/Weight" } ] }, "totalRebates": { "type": "number", "description": "Specifies the total rebate.", "format": "double" }, "fuelSurchargePercent": { "type": "number", "description": "Specifies a fuel surcharge percentage.", "format": "double" }, "currencyExchangeRate": { "description": "Specifies currency exchange rate.", "allOf": [ { "$ref": "#/$defs/CurrencyExchangeRate" } ] }, "dimDivisor": { "type": "integer", "description": "The value used to calculate the weight based on the dimensions.", "format": "int32" }, "rateType": { "type": "string", "description": "Type used for this specific set of rate data." }, "legDestinationLocationId": { "type": "string", "description": "Specifies the location id the destination of shipment leg." }, "dimDivisorType": { "type": "string", "description": "Identifies the type of dim divisor that was applied." }, "totalBaseCharge": { "type": "number", "description": "The total freight charge that was calculated before surcharges, discounts and taxes.", "format": "double" }, "ratedWeightMethod": { "type": "string", "description": "Indicates which weight was used." }, "totalFreightDiscounts": { "type": "number", "description": "The sum of all discounts.", "format": "double" }, "totalTaxes": { "type": "number", "description": "Total of the transportation-based taxes.", "format": "double" }, "minimumChargeType": { "type": "string", "description": "Specifies minimum Charge Type." }, "totalDutiesAndTaxes": { "type": "number", "description": "Total of shipments duties and taxes; only provided if estimated duties and taxes were calculated for this shipment.", "format": "double" }, "totalNetFreight": { "type": "number", "description": "The freight charge minus discounts.
Example: 6.0", "format": "double" }, "totalNetFedExCharge": { "type": "number", "description": "Total of shipments total net freight and total surcharges (not including total taxes).", "format": "double" }, "surcharges": { "type": "array", "description": "All surcharges that apply to this shipment.", "items": { "$ref": "#/$defs/Surcharge" } }, "totalSurcharges": { "type": "number", "description": "The total of all surcharges.", "format": "double" }, "totalBillingWeight": { "description": "The weight used to calculate these rates.", "allOf": [ { "$ref": "#/$defs/Weight" } ] }, "freightDiscounts": { "type": "array", "items": { "$ref": "#/$defs/RateDiscount" } }, "rateScale": { "type": "string", "description": "Indicates the rate scale used." }, "totalNetCharge": { "type": "number", "description": "The net charge after applying all discounts and surcharges.", "format": "double" }, "totalNetChargeWithDutiesAndTaxes": { "type": "number", "description": "Sum of total net charge, total duties and taxes; only provided if estimated duties and taxes were calculated for this shipment and duties, taxes and transportation charges are all paid by the same sender account.", "format": "double" }, "currency": { "type": "string", "description": "This is the currency code for the amount. Click here to see Currency Codes" } }, "description": "This is data for a single leg of a shipment's total/summary rates, as calculated per a specific rate type." }, "ShipmentOperationalDetail": { "type": "object", "properties": { "originServiceArea": { "type": "string", "description": "Indicates the origin service area.
Example: A1" }, "serviceCode": { "type": "string", "description": "Indicates the service code.
Example: 010" }, "airportId": { "type": "string", "description": "Indicates the airport identifier.
Example: DFW" }, "postalCode": { "type": "string", "description": "Specifies the postal code.
Example: 38010
click here to see Postal aware countries" }, "scac": { "type": "string", "description": "Indicates standard carrier alpha code." }, "deliveryDay": { "type": "string", "description": "Specifies expected/estimated day of week of the delivery.
Example: TUE" }, "originLocationId": { "type": "string", "description": "This is the origin Location identifier.
Example: 678" }, "countryCode": { "type": "string", "description": "Specifies the Country Code.
Example: US
Click here to see Country Codes" }, "astraDescription": { "type": "string", "description": "Specifies astra description.
Example: SMART POST" }, "originLocationNumber": { "type": "integer", "description": "Specifies origin location number.
Example: 243", "format": "int32" }, "deliveryDate": { "type": "string", "description": "Specifies delivery date for the shipment. Format [YYYY-MM-DD]
Example: 2001-04-05" }, "deliveryEligibilities": { "type": "array", "description": "FedEx Ground delivery features for which this shipment may be eligible.
Example: [\"deliveryEligibilities\"]", "items": { "type": "string" } }, "ineligibleForMoneyBackGuarantee": { "type": "boolean", "description": "Indicates that this shipment is not eligible for money back guarantee" }, "maximumTransitTime": { "type": "string", "description": "Maximum expected transit time.
Example: SEVEN_DAYS" }, "destinationLocationStateOrProvinceCode": { "type": "string", "description": "This is the state of the shipment destination location, and is not necessarily the same as the postal state." }, "astraPlannedServiceLevel": { "type": "string", "description": "Text describing planned delivery.
Example: TUE - 15 OCT 10:30A" }, "destinationLocationId": { "type": "string", "description": "Specifies the FedEx Destination Location Identifier.
Example: DALA" }, "transitTime": { "type": "string", "description": "Standard transit time per origin, destination, and service.
Example: TWO_DAYS" }, "stateOrProvinceCode": { "type": "string", "description": "This is a placeholder for State or Province code.
Example: CA
click here to see State or Province Code" }, "destinationLocationNumber": { "type": "integer", "description": "Indicates destination location number.
Example: 876", "format": "int32" }, "packagingCode": { "type": "string", "description": "Specifes Packaging Code.
Example: 03" }, "commitDate": { "type": "string", "description": "Committed date of delivery.
Example: 2019-10-15" }, "publishedDeliveryTime": { "type": "string", "description": "This is delivery time, as published in Service Guide.
Example: 10:30A" }, "ursaSuffixCode": { "type": "string", "description": "Specifies ursa Suffix Code.
Example: Ga" }, "ursaPrefixCode": { "type": "string", "description": "Specifies ursa Prefix Code.
Example: XH" }, "destinationServiceArea": { "type": "string", "description": "Specifies destination service area.
Example: A1" }, "commitDay": { "type": "string", "description": "Committed day of week of delivery.
Example: TUE" }, "customTransitTime": { "type": "string", "description": "Transit time based on customer eligibility.
Example: ONE_DAY" } }, "description": "Shipment level operational information." }, "ShipmentRateDetail": { "type": "object", "properties": { "rateZone": { "type": "string", "description": "Indicates the rate zone used (based on origin and destination)." }, "ratedWeightMethod": { "type": "string", "description": "Indicates which weight was used." }, "totalDutiesTaxesAndFees": { "type": "number", "description": "The total of the total duties & taxes and the total ancillary fees & taxes.", "format": "double" }, "pricingCode": { "type": "string", "description": "Specifies pricing Code." }, "totalFreightDiscounts": { "type": "number", "description": "The total discounts used in the rate calculation.", "format": "double" }, "totalTaxes": { "type": "number", "description": "Total of the transportation-based taxes.
Example: 3.45", "format": "double" }, "totalDutiesAndTaxes": { "type": "number", "description": "Total of all values under this shipment's duties and taxes; only provided if estimated duties and taxes were calculated for this shipment.", "format": "double" }, "totalAncillaryFeesAndTaxes": { "type": "number", "description": "Identifies the total amount of the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.", "format": "double" }, "taxes": { "type": "array", "description": "All transportation-based taxes applicable to this shipment.", "items": { "allOf": [ { "$ref": "#/$defs/Tax" } ] } }, "totalRebates": { "type": "number", "description": "The total sum of all rebates applied to this shipment.", "format": "double" }, "fuelSurchargePercent": { "type": "number", "description": "Specifies a fuel surcharge percentage.", "format": "double" }, "currencyExchangeRate": { "$ref": "#/$defs/CurrencyExchangeRate" }, "totalNetFreight": { "type": "number", "description": "The freight charge minus discounts.", "format": "double" }, "totalNetFedExCharge": { "type": "number", "description": "This is the sum of shipment total Net freight, total surchages (not including totalTaxes).", "format": "double" }, "shipmentLegRateDetails": { "type": "array", "items": { "$ref": "#/$defs/ShipmentLegRateDetail" } }, "dimDivisor": { "type": "integer", "description": "The value used to calculate the weight based on the dimensions.", "format": "int32" }, "rateType": { "type": "string", "description": "The Type used for this specific set of rate data." }, "surcharges": { "type": "array", "description": "All surcharges that apply to this shipment.", "items": { "$ref": "#/$defs/Surcharge" } }, "totalSurcharges": { "type": "number", "description": "The total amount of all surcharges applied to this shipment.", "format": "double" }, "totalBillingWeight": { "description": "The weight used to calculate these rates.", "allOf": [ { "$ref": "#/$defs/Weight" } ] }, "freightDiscounts": { "type": "array", "items": { "$ref": "#/$defs/RateDiscount" } }, "rateScale": { "type": "string", "description": "Indicates the rate scale used." }, "totalNetCharge": { "type": "number", "description": "The net charge after applying all discounts and surcharges.", "format": "double" }, "totalBaseCharge": { "type": "number", "description": "The total freight charge that was calculated before surcharges, discounts and taxes.", "format": "double" }, "totalNetChargeWithDutiesAndTaxes": { "type": "number", "description": "This is the sum of shipment's total net charges and total duties and taxes; only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender account.", "format": "double" }, "currency": { "type": "string", "description": "The currency code. Click here to see Currency Codes" } }, "description": "This is a placeholder for the shipment's total/summary rates details, as calculated per a specific rate type. The totals may differ from the sum of corresponding package data for Multiweight or Express MPS." }, "ShipmentRating": { "type": "object", "properties": { "actualRateType": { "type": "string", "description": "This rate type identifies which entry in the following array is considered as presenting the \"actual\" rates for the shipment." }, "shipmentRateDetails": { "type": "array", "description": "Each element of this field provides shipment-level rate totals for a specific rate type.", "items": { "$ref": "#/$defs/ShipmentRateDetail" } }, "totalNetTransportationAndPickupCharge": { "description": "Sum of totalNetCharge from pickupRateDetail and shipmentRateDetail. This charge will be populated regardless of pickup.", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "totalNetFedExTransportationAndPickupCharge": { "description": "Sum of totalNetFedExCharge from pickupRateDetail and shipmentRateDetail. This charge will be populated regardless of a pickup.", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "pickupRateDetail": { "description": "Charges associated with a scheduled shipment pickup", "type": "object", "properties": { "rateType": { "description": "Type used for this specific set of rate data.", "type": "string", "enum": [ "INCENTIVE", "NEGOTIATED", "PAYOR_ACCOUNT_PACKAGE", "PAYOR_ACCOUNT_SHIPMENT", "PAYOR_CUSTOM_PACKAGE", "PAYOR_CUSTOM_SHIPMENT", "PAYOR_LIST_PACKAGE", "PAYOR_LIST_SHIPMENT", "PAYOR_RETAIL_PACKAGE", "PAYOR_RETAIL_SHIPMENT", "PREFERRED_ACCOUNT_PACKAGE", "PREFERRED_ACCOUNT_SHIPMENT", "PREFERRED_CUSTOM_PACKAGE", "PREFERRED_CUSTOM_SHIPMENT", "PREFERRED_INCENTIVE", "PREFERRED_LIST_PACKAGE", "PREFERRED_LIST_SHIPMENT", "PREFERRED_NEGOTIATED", "PREFERRED_RETAIL_PACKAGE", "PREFERRED_RETAIL_SHIPMENT", "RATED_ACCOUNT_PACKAGE", "RATED_ACCOUNT_SHIPMENT", "RATED_CUSTOM_PACKAGE", "RATED_CUSTOM_SHIPMENT", "RATED_LIST_PACKAGE", "RATED_LIST_SHIPMENT", "RATED_RETAIL_PACKAGE", "RATED_RETAIL_SHIPMENT", "UNKNOWN" ] }, "rateScale": { "type": "string", "description": "Indicates the rate scale used." }, "rateZone": { "description": "Indicates the rate zone used (based on origin and destination).", "type": "string" }, "ratingBasis": { "description": "Allows clients to determine whether to add charges at the package level when Per Piece Rating details are returned.
", "type": "string", "enum": [ "SHIPMENT_WEIGHT_BASED", "FLAT_RATE_PER_PAK", "PACK_WEIGHT_BASED", "UNKNOWN" ] }, "pricingCode": { "description": "Identifies the type of pricing used for this shipment.", "type": "string", "enum": [ "ACTUAL", "ALTERNATE", "BASE", "HUNDREDWEIGHT", "HUNDREDWEIGHT_ALTERNATE", "INTERNATIONAL_DISTRIBUTION", "INTERNATIONAL_ECONOMY_SERVICE", "LTL_FREIGHT", "PACKAGE", "SHIPMENT", "SHIPMENT_FIVE_POUND_OPTIONAL", "SHIPMENT_OPTIONAL", "SPECIAL", "UNKNOWN" ] }, "minimumChargeType": { "description": "provides the minimum charge type applicable to the rates.", "type": "string", "enum": [ "CUSTOMER", "CUSTOMER_FREIGHT_WEIGHT", "EARNED_DISCOUNT", "MIXED", "RATE_SCALE", "UNKNOWN" ] }, "currencyExchangeRate": { "$ref": "#/$defs/CurrencyExchangeRate" }, "specialRatingApplied": { "type": "array", "description": "Indicates which special rating cases applied to this shipment.", "items": { "type": "string", "enum": [ "FEDEX_ONE_RATE", "FIXED_FUEL_SURCHARGE", "IMPORT_PRICING" ] } }, "fuelSurchargePercent": { "description": "Specify a fuel surcharge percentage.", "format": "double", "type": "number" }, "pickupBaseChargeDescription": { "description": "Will indicate the pickup charge description of the on call pickup", "type": "string", "enum": [ "Regularly Scheduled Pickup Mon-Fri", "Automated Pickup Mon-Fri", "Same Day OC Pickup Mon-Fri (CS)", "Same Day OC Pickup Mon-Fri (Online)", "Fut. Day OC Pickup Mon-Fri (CS)", "Fut. Day OC Pickup Mon-Fri (Online)", "Regularly Scheduled Pickup Sat", "Automated Pickup Sat", "Same Day OC Pickup Sat (CS)", "Same Day OC Pickup Sat (Online)", "Fut. Day OC Pickup Sat (CS)", "Fut. Day OC Pickup Sat (Online)", "Regularly Scheduled Pickup Sun", "Automated Pickup Sun", "Same Day OC Pickup Sun (CS)", "Same Day OC Pickup Sun (Online)", "Fut. Day OC Pickup Sun (CS)", "Fut. Day OC Pickup Sun (Online)", "Residential On-Call Pickup Surcharge", "Pickup Area Surcharge", "Extended Pickup Area Surcharge", "Remote Pickup Area Surcharge", "Fuel Surcharge" ] }, "totalBaseCharge": { "description": "Total base charges for the shipment.", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "totalFreightDiscounts": { "description": "The total discounts used in the rate calculation.
Example: 1257.26", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "totalNetFreight": { "description": "This shipment's totalNetFreight.", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "totalSurcharges": { "description": "The sum of all surcharges on the package.", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "totalNetFedExCharge": { "description": "This shipment's totalNetFedExCharge, which is totalNetFreight plus totalSurcharges (not including totalTaxes).", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "totalTaxes": { "description": "The sum of all taxes on this package.
Example: 1257.25", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "totalNetCharge": { "description": "Total net charges for the shipment.", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "totalRebates": { "description": "The total sum of all rebates applied to this package.", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "totalDutiesAndTaxes": { "description": "The sum of shipment/package Duties and taxes.", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "totalAncillaryFeesAndTaxes": { "description": "Identifies the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "totalDutiesTaxesAndFees": { "description": "The total amount of the duties and taxes plus the total ancillary fees and taxes.", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "totalNetChargeWithDutiesAndTaxes": { "description": "Total netChargesWithDutiesAndTaxes for the shipment.", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "freightDiscounts": { "description": "All rate discounts that apply to this shipment", "type": "array", "items": { "$ref": "#/$defs/RateDiscount_2" } }, "rebates": { "description": "The all rebates applied to this package.", "type": "array", "items": { "$ref": "#/$defs/Rebate" } }, "surcharges": { "description": "The amount of surcharges applied to this shipment.", "type": "array", "items": { "$ref": "#/$defs/Surcharge_2" } }, "taxes": { "description": "List of taxes.", "type": "array", "items": { "$ref": "#/$defs/Tax_2" } }, "dutiesAndTaxes": { "description": "List of The shipment/package Duties and taxes.", "type": "array", "items": { "$ref": "#/$defs/EdtCommodityTax" } }, "ancillaryFeesAndTaxes": { "description": "Identifies the total amount of the shipment-lvel fees and taxes that are not based on transportation charges of commodity-level estimated duties and taxes.", "type": "array", "items": { "$ref": "#/$defs/AncillaryFeeAndTax" } }, "variableHandlingCharges": { "description": "Optional. The variable handling charge amount calculated based on the requested variable handling charge detail.", "allOf": [ { "$ref": "#/$defs/VariableHandlingCharges_1" } ] }, "totalVariableHandlingCharges": { "description": "Optional. The variable handling charge amount calculated based on the requested variable handling charge detail.", "allOf": [ { "$ref": "#/$defs/VariableHandlingCharges_1" } ] } } } }, "description": "All shipment-level rating data for this shipment, which may include data for multiple rate types." }, "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." }, "ShippingDocument": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of label being used for the package", "enum": [ "AUXILIARY_LABEL - CERTIFICATE_OF_ORIGIN - COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_2_D_BARCODE - COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_LABEL - COD_RETURN_2_D_BARCODE - COD_RETURN_LABEL - COMMERCIAL_INVOICE - CUSTOM_PACKAGE_DOCUMENT - CUSTOM_SHIPMENT_DOCUMENT - DANGEROUS_GOODS_SHIPPERS_DECLARATION - DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_2_D_BARCODE - DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_LABEL - ETD_LABEL - EXPORT_DECLARATION - FEDEX_FREIGHT_STRAIGHT_BILL_OF_LADING - FREIGHT_ADDRESS_LABEL - GENERAL_AGENCY_AGREEMENT - GROUND_BARCODE - OP_900 - OUTBOUND_2_D_BARCODE - OUTBOUND_LABEL - PENDING_SHIPMENT_EMAIL_NOTIFICATION - PRO_FORMA_INVOICE - RECIPIENT_ADDRESS_BARCODE - RECIPIENT_POSTAL_BARCODE - RETURN_INSTRUCTIONS - TERMS_AND_CONDITIONS - USMCA_CERTIFICATION_OF_ORIGIN - USMCA_COMMERCIAL_INVOICE_CERTIFICATION_OF_ORIGIN - USPS_BARCODE - VICS_BILL_OF_LADING" ] }, "shippingDocumentDisposition": { "type": "string", "description": "Use this object to provide all data required for additional (non-label) shipping documents to be produced.", "enum": [ "CONFIRMED", "DEFERRED_QUEUED", "DEFERRED_RETURNED", "DEFERRED_STORED", "EMAILED", "QUEUED", "RETURNED", "STORED" ] }, "imageType": { "type": "string", "description": "Specify the image format used for a shipping document.
click here to see label format types", "enum": [ "DIB", "DOC", "DPL", "EPL2", "GIF", "PDF", "PNG", "RTF", "TEXT", "ZPLII" ] }, "resolution": { "type": "integer", "description": "Specifies the image resolution in DPI (Dots per inch)." }, "copiesToPrint": { "type": "integer", "description": "Indicates the number of copies to print. It can be zero for document with disposition as no content is included." }, "parts": { "type": "array", "description": "Indicates documentation part details.", "items": { "$ref": "#/$defs/ShippingDocument_parts" } } }, "description": "Label details for the package" }, "ShippingDocument_parts": { "properties": { "documentPartSequenceNumber": { "type": "integer", "description": "Specifies the one-origin position of this part within a document." }, "image": { "type": "string", "description": "Specifies the one-origin position of this part within a document." } } }, "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." }, "StringBarcode": { "type": "object", "properties": { "type": { "type": "string", "description": "The kind of barcode data in this instance. Valid values are:
ADDRESS - Represents the recipient address
GROUND - FedEx Ground parcel barcode
Example: ADDRESS" }, "value": { "type": "string", "description": "The data content of this instance." } }, "description": "Each instance of this data type represents a barcode whose content must be represented as ASCII text (i.e. not binary data)." }, "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" }, "Surcharge": { "type": "object", "properties": { "amount": { "description": "This is the surcharge amount.
Example: 15.35", "allOf": [ { "$ref": "#/$defs/Money" } ] }, "surchargeType": { "type": "string", "description": "Specifies the Surcharge Type.
Example: APPOINTMENT_DELIVERY" }, "level": { "type": "string", "description": "Specifies if the surcharge applies to the entire shipment, or to an individual package.
Example: PACKAGE" }, "description": { "type": "string", "description": "Specifies the description of the surcharge. Indicates delivery and returns information for FedEx Ground Economy services.
Example: Fuel Surcharge" } }, "description": "All surcharges that apply to this shipment.
click here to see Surcharges" }, "Surcharge_2": { "type": "object", "properties": { "surchargeType": { "description": "The type of surcharge.", "type": "string", "enum": [ "ACCOUNT_NUMBER_PROCESSING_FEE", "ADDITIONAL_HANDLING", "ADDRESS_CORRECTION", "ANCILLARY_FEE", "APPOINTMENT_DELIVERY", "BLIND_SHIPMENT", "BROKER_SELECT_OPTION", "CANADIAN_DESTINATION", "CHARGEABLE_PALLET_WEIGHT", "COD", "CUT_FLOWERS", "DANGEROUS_GOODS", "DELIVERY_AREA", "DELIVERY_CONFIRMATION", "DELIVERY_ON_INVOICE_ACCEPTANCE", "DEMAND", "DEMAND_ADDITIONAL_HANDLING", "DEMAND_OVERSIZE", "DEMAND_RESIDENTIAL_DELIVERY", "DETENTION", "DOCUMENTATION_FEE", "DRY_ICE", "EMAIL_LABEL", "ENHANCED_SECURITY", "EUROPE_FIRST", "EXCESS_VALUE", "EXCLUSIVE_USE", "EXHIBITION", "EXPEDITED", "EXPORT", "EXTRA_LABOR", "EXTRA_SURFACE_HANDLING_CHARGE", "EXTREME_LENGTH", "FEDEX_INTRACOUNTRY_FEES", "FEDEX_TAG", "FICE", "FLATBED", "FREIGHT_DIRECT_BASIC_BY_APPOINTMENT_DELIVERY", "FREIGHT_DIRECT_BASIC_BY_APPOINTMENT_PICKUP", "FREIGHT_DIRECT_BASIC_DELIVERY", "FREIGHT_DIRECT_BASIC_PICKUP", "FREIGHT_DIRECT_PREMIUM_DELIVERY", "FREIGHT_DIRECT_PREMIUM_PICKUP", "FREIGHT_DIRECT_STANDARD_DELIVERY", "FREIGHT_DIRECT_STANDARD_PICKUP", "FREIGHT_GUARANTEE", "FREIGHT_ON_VALUE", "FREIGHT_TO_COLLECT", "FUEL", "HIGH_COST_SERVICE_AREA_DESTINATION", "HIGH_COST_SERVICE_AREA_ORIGIN", "HIGH_DENSITY", "HOLD_AT_LOCATION", "HOLIDAY_DELIVERY", "HOLIDAY_GUARANTEE", "HOME_DELIVERY_APPOINTMENT", "HOME_DELIVERY_DATE_CERTAIN", "HOME_DELIVERY_EVENING", "INSIDE_DELIVERY", "INSIDE_PICKUP", "INSURED_VALUE", "INTERHAWAII", "LIFTGATE_DELIVERY", "LIFTGATE_PICKUP", "LIMITED_ACCESS_DELIVERY", "LIMITED_ACCESS_PICKUP", "MARKING_OR_TAGGING", "METRO_DELIVERY", "METRO_PICKUP", "MONITORING_AND_INTERVENTION", "NON_BUSINESS_TIME", "NON_MACHINABLE", "OFFSHORE", "ON_CALL_PICKUP", "ON_DEMAND_CARE", "OTHER", "OUT_OF_DELIVERY_AREA", "OUT_OF_PICKUP_AREA", "OVER_DIMENSION", "OVER_LENGTH", "OVERSIZE", "OVERWEIGHT", "PALLET_SHRINKWRAP", "PALLETS_PROVIDED", "PEAK", "PEAK_ADDITIONAL_HANDLING", "PEAK_OVERSIZE", "PEAK_RESIDENTIAL_DELIVERY", "PERMIT", "PIECE_COUNT_VERIFICATION", "PORT", "PRE_DELIVERY_NOTIFICATION", "PRIORITY_ALERT", "PROTECTION_FROM_FREEZING", "REGIONAL_MALL_DELIVERY", "REGIONAL_MALL_PICKUP", "REROUTE", "RESCHEDULE", "RESIDENTIAL_DELIVERY", "RESIDENTIAL_PICKUP", "RETURN_LABEL", "SATURDAY_DELIVERY", "SATURDAY_PICKUP", "SHIPMENT_ASSEMBLY", "SIGNATURE_OPTION", "SINGLE_PIECE", "SORT_AND_SEGREGATE", "SPECIAL_DELIVERY", "SPECIAL_EQUIPMENT", "STORAGE", "SUNDAY_DELIVERY", "TARP", "THIRD_PARTY_BILLING", "THIRD_PARTY_CONSIGNEE", "TRANSMART_SERVICE_FEE", "USPS", "WEIGHING" ] }, "level": { "description": "The level of surcharge.", "type": "string", "enum": [ "PACKAGE", "SHIPMENT" ] }, "description": { "description": "The description of the surcharge.", "type": "string" }, "amount": { "description": "Identifies the total amount of the shipment-level fees and taxes that are not based on transportation charges or commodity-level estimated duties and taxes.", "allOf": [ { "$ref": "#/$defs/Money_1" } ] } } }, "Tax": { "type": "object", "properties": { "amount": { "type": "number", "description": "Indicates the amount of tax", "format": "double" }, "level": { "type": "string", "description": "Indicates the Level of Tax." }, "description": { "type": "string", "description": "Placeholder for the tax description.
Example: descrption" }, "type": { "type": "string", "description": "Specifies the type of the tax." } }, "description": "All transportation-based taxes applicable to this shipment.." }, "Tax_2": { "description": "Tax surcharge details", "type": "object", "properties": { "taxType": { "description": "Specifies the type of Surcharge/Tax.", "type": "string", "enum": [ "EXPORT", "GST", "HST", "INTRACOUNTRY", "OTHER", "PST", "SST", "VAT" ] }, "description": { "description": "Specifies the description of the Surcharge/Tax.", "type": "string" }, "amount": { "description": "Specifies the list of tax amounts.", "allOf": [ { "$ref": "#/$defs/Money_1" } ] } } }, "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" }, "TrackingId": { "type": "object", "properties": { "formId": { "type": "string", "description": "This is FedEx tracking Identifier associated with the package." }, "trackingIdType": { "type": "string", "description": "Specify the FedEx transportation type (EXPRESS, GROUND, FREIGHT). " }, "uspsApplicationId": { "type": "string", "description": "Specify the USPS tracking Identifier associated with FedEx SmartPost shipment." }, "trackingNumber": { "type": "string", "description": "This is the tracking number associated with this package.
Example: 49XXX0000XXX20032835" } }, "description": "The field is present to allow use of preassigned Master Airway Bill tracking number." }, "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." }, "TransactionConsolidationOutputVO": { "type": "object", "properties": { "completedConsolidationDetail": { "$ref": "#/$defs/TransactionConsolidationOutputVO_completedConsolidationDetail" }, "pieceResponses": { "type": "array", "description": "Specifies the information about the pieces, received in the response.", "items": { "$ref": "#/$defs/PieceResponse" } }, "shipmentDocuments": { "type": "array", "description": "These are shipping document details.", "items": { "$ref": "#/$defs/LabelResponseVO" } } }, "description": "Specifies shipping transaction output details" }, "TransactionConsolidationOutputVO_completedConsolidationDetail": { "type": "object", "properties": { "consolidationShipments": { "$ref": "#/$defs/ConsolidationShipments" }, "consolidationDocumentTypes": { "$ref": "#/$defs/ConsolidationDocumentSpec" } }, "description": "Specifies Complete Consolidation Details when user selected ASYCHRONOUSLY_PROCESSED" }, "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." }, "UploadDocumentReferenceDetail": { "type": "object", "properties": { "documentId": { "type": "string", "description": "Returns the value specified in the ship shipment request for your uploaded documents in addition to other values for FedEx generated documents such as shipping labels." } }, "description": "Specify the document upload reference details." }, "ValidatedHazardousCommodityContent": { "type": "object", "properties": { "quantity": { "description": "Provides Hazardous Commodity quantity details.", "allOf": [ { "$ref": "#/$defs/HazardousCommodityQuantityDetail" } ] }, "options": { "$ref": "#/$defs/HazardousCommodityContent001" }, "description": { "$ref": "#/$defs/ValidatedHazardousCommodityDescription" }, "netExplosiveDetail": { "$ref": "#/$defs/NetExplosiveDetail" }, "massPoints": { "type": "number", "description": "The mass points are a calculation used by ADR regulations for measuring the risk of a particular hazardous commodity.", "format": "double" } }, "description": "Documents the kind and quantity of an individual hazardous commodity in a package." }, "ValidatedHazardousCommodityDescription": { "type": "object", "properties": { "sequenceNumber": { "type": "integer", "description": "In conjunction with the regulatory identifier, this field uniquely identifies a specific hazardous materials commodity.", "format": "int32" }, "packingInstructions": { "type": "string", "description": "Specifies Packing Instructions." }, "subsidiaryClasses": { "type": "array", "description": "Specifies subsidiary Classes.", "items": { "type": "string" } }, "labelText": { "type": "string", "description": "Specifies Hazard Label Text." }, "tunnelRestrictionCode": { "type": "string", "description": "There are five categories of tunnel categorization with A representing the least restrictive and E as the most restrictive. Category A, as the least restrictive, will not be sign-posted. Category E, the most restrictive, only allows the passage of UN2919, UN3291, UN3331, UN3359 and UN3373." }, "specialProvisions": { "type": "string", "description": "Specifies Special Provisions if any." }, "properShippingNameAndDescription": { "type": "string", "description": "Fully-expanded descriptive text for a hazardous commodity." }, "technicalName": { "type": "string", "description": "Specifies Technical Name." }, "symbols": { "type": "string", "description": "Specifies Symbols." }, "authorization": { "type": "string", "description": "Information related to quantity limitations and operator or state variations as may be applicable to the dangerous goods commodity." }, "attributes": { "type": "array", "description": "Specifies attributes.", "items": { "type": "string" } }, "id": { "type": "string", "description": "Specifies the Identification." }, "packingGroup": { "type": "string", "description": "Specifies packing Group." }, "properShippingName": { "type": "string", "description": "Specifies Proper Shipping Name." }, "hazardClass": { "type": "string", "description": "Specifies hazard Class." } }, "description": "Identifies and describes an individual hazardous commodity. For 201001 load, this is based on data from the FedEx Ground Hazardous Materials Shipping Guide." }, "ValidatedHazardousContainer": { "type": "object", "properties": { "qvalue": { "type": "number", "description": "Indicates that the quantity of the dangerous goods packaged is permissible for shipping. This is used to ensure that the dangerous goods commodities do not exceed the net quantity per package restrictions.", "format": "double" }, "hazardousCommodities": { "type": "array", "description": "Indicates the details of the hazardousCommodities in the completed package.", "items": { "$ref": "#/$defs/ValidatedHazardousCommodityContent" } } }, "description": "Specifies the concept of a container used to package dangerous goods commodities." }, "VariableHandlingCharges_1": { "description": "Optional. The variable handling charge amount calculated based on the requested variable handling charge detail.", "type": "object", "properties": { "variableHandlingCharge": { "description": "Optional. The variable handling charge amount calculated based on the requested variable handling charge detail", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "fixedVariableHandlingCharge": { "description": "Optional. The variable handling charge amount calculated based on the requested variable handling charge detail.", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "percentVariableHandlingCharge": { "description": "Optional. The variable handling charge amount calculated based on the requested variable handling charge detail", "allOf": [ { "$ref": "#/$defs/Money_1" } ] }, "totalCustomerCharge": { "description": "Specifies the total customer assessed handling charges.
Example: 445.54", "allOf": [ { "$ref": "#/$defs/Money_1" } ] } } }, "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: " } } }