FedEx · Schema
ConsolidationShipmentResultsResponse
Wrapper class for ConsolidationShipmentResultsOutputVO. It holds transactionId and output.
Address ValidationFreightLogisticsPickupRatingsShippingTrackingWebhookFortune 100
Properties
| Name | Type | Description |
|---|---|---|
| transactionId | string | The transaction ID is a special set of numbers that defines each transaction. Example: 624deea6-b709-470c-8c39-4b5511281492 |
| customerTransactionId | string | 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 | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/fedex/json-schema/fedex-consolidation-shipment-results-response-schema.json",
"title": "ConsolidationShipmentResultsResponse",
"description": "Wrapper class for ConsolidationShipmentResultsOutputVO. 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/ConsolidationShipmentResultsResponse",
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"description": "The transaction ID is a special set of numbers that defines each transaction.<br>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. <br> Example: AnyCo_order123456789"
},
"output": {
"$ref": "#/$defs/BaseProcessOutputVO_ConsolidationShipmentResults"
}
},
"$defs": {
"Address": {
"required": [
"countryCode",
"streetLines"
],
"type": "object",
"properties": {
"streetLines": {
"type": "array",
"description": "This is a combination of number, street name, etc. <br>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. <br>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. <br>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.<br>Note: The postal code is required for postal-aware countries."
},
"countryCode": {
"type": "string",
"description": "This is the Two-letter country code. <a href=\"/developer-portal/en-us/reference-guide.html#countrycodes\" target=\"_blank\">Click here to see Country Codes</a>"
},
"residential": {
"type": "boolean",
"description": "Indicate whether this address is Residential as opposed to Commercial.<br>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)."
},
"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.<br> Example: CONSOLIDATION_MASTER",
"enum": [
"COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN",
"COD_RETURN",
"CONSOLIDATION_DOCUMENTS",
"CONSOLIDATION_MASTER",
"DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN"
]
}
}
},
"BaseProcessOutputVO_ConsolidationShipmentResults": {
"type": "object",
"properties": {
"transactionShipments": {
"type": "array",
"description": "a list of consolidation shipments within the open shipment",
"items": {
"$ref": "#/$defs/TransactionConsolidationShipmentResultsOutputVO"
}
},
"alerts": {
"type": "array",
"description": "The alerts received when processing a shipment request.",
"items": {
"$ref": "#/$defs/Alert"
}
}
}
},
"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)."
},
"CommodityClarificationDetail": {
"type": "object",
"properties": {
"commodityIndex": {
"type": "integer",
"description": "This is a index identifying the commodity in the request that resulted in this COMMODITY or DOCUMENT type prohibition.<br>Example: 25",
"format": "int32"
},
"suggestions": {
"type": "array",
"description": "These are suggested commodity details.",
"items": {
"$ref": "#/$defs/SuggestedCommodityDetail"
}
}
},
"description": "Indicates the Commodity clarifications."
},
"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.<br>Example: IATA"
},
"accessibility": {
"type": "string",
"description": "Specifies the hazardous package accessibility.<br>Example: ACCESSIBLE"
},
"labelType": {
"type": "string",
"description": "Specifies the label type of hazardous package.<br>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.<br>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. <br>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<br>Examples of FedEx Operating Companies are:<ul><li>FDXE - FedEx Express</li><li>FDXG - FedEx Ground</li><li>FXSP - FedEx SmartPost</li><li>FXCC - FedEx Custom Critical.</li></ul>"
},
"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."
},
"Contact": {
"type": "object",
"properties": {
"personName": {
"type": "string",
"description": "Specify person name.<br>Example: John Taylor"
},
"tollFreePhoneNumber": {
"type": "string",
"description": "Specify toll free phone number.<br>Example: XXXX7812"
},
"emailAddress": {
"type": "string",
"description": "Specify email address.<br>Example: sample@company.com"
},
"phoneNumber": {
"type": "string",
"description": "Specify phone number.<br>Example: XXX567890"
},
"phoneExtension": {
"type": "string",
"description": "Specify phone extension.<br>Example: 91"
},
"companyName": {
"type": "string",
"description": "Specify Company Name."
},
"pagerNumber": {
"type": "string",
"description": "Specify pager number.<br>Example: XXX7812"
},
"faxNumber": {
"type": "string",
"description": "Specify fax number.<br>Example: XXXX567890"
},
"title": {
"type": "string",
"description": "Specify the Title of the Contact."
}
},
"description": "Specifies the Contact information."
},
"CurrencyExchangeRate": {
"type": "object",
"properties": {
"rate": {
"type": "number",
"description": "Multiplier used to convert from Currency units to into Currency units.<br>Example: 25.6",
"format": "double"
},
"fromCurrency": {
"type": "string",
"description": "The currency code for the original (converted FROM) currency.<br><a href=\"/developer-portal/en-us/reference-guide.html#currencycodes\" target=\"_blank\">Click here to see Currency Codes</a>"
},
"intoCurrency": {
"type": "string",
"description": "The currency code for the final(converted INTO) currency.<br><a href=\"/developer-portal/en-us/reference-guide.html#currencycodes\" target=\"_blank\">Click here to see Currency Codes</a>"
}
},
"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.<br>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.<br>Example: 3686"
}
}
},
"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"
}
}
}
}
},
"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"
},
"LabelResponseVO": {
"type": "object",
"properties": {
"copiesToPrint": {
"type": "integer",
"description": "These are the number of copies to print for the specific document type.<br>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. <br>Example: 49XXX0000XXX20032835<br>"
},
"docType": {
"type": "string",
"description": "This is the document type.<br>Example: PDF"
},
"encodedLabel": {
"type": "string",
"description": "Specifies if the document is encoded.<br>Example: encoded label"
},
"url": {
"type": "string",
"description": "The URL of the shipping document/label<br>Example: https://.../document/v2/document/retrieve/SH,794816968200_Merge/isLabel=true&autoPrint=false<br><i>Note: The URL once created will be active for 24
# --- truncated at 32 KB (99 KB total) ---
# Full source: https://artifacts.apis.io/fedex/json-schema/fedex-consolidation-shipment-results-response-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/fedex-consolidation-shipment-results-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.