ModifyConsolidationResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/fedex/json-schema/fedex-modify-consolidation-response-schema.json",
  "title": "ModifyConsolidationResponse",
  "description": "Wrapper class for ModifyConsolidationOutputVO. It holds transactionId and output.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/fedex-consolidation-api-openapi.yml#/components/schemas/ModifyConsolidationResponse",
  "type": "object",
  "properties": {
    "customerTransactionId": {
      "type": "string",
      "description": "This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply. <br> Example: AnyCo_order123456789"
    },
    "transactionId": {
      "type": "string",
      "description": "The transaction ID is a special set of numbers that defines each transaction.<br>Example: 624deea6-b709-470c-8c39-4b5511281492"
    },
    "output": {
      "$ref": "#/$defs/ModifyConsolidationOutputVO"
    }
  },
  "$defs": {
    "AccountNumber": {
      "description": "This is the FedEx Account number. <br>Example: 123456789",
      "allOf": [
        {
          "$ref": "#/$defs/PartyAccountNumber"
        }
      ]
    },
    "AddressAncillaryDetail": {
      "type": "object",
      "properties": {
        "locationInCity": {
          "type": "string",
          "description": "Subdivision or community within a city<br>Example: Forester subdivision"
        },
        "suite": {
          "type": "string",
          "description": "suite information for the address<br>Example: suite 201"
        },
        "addressVerificationOverrideReason": {
          "type": "string",
          "description": "Indicates the reason to override address verification.<br> Valid values:  CUSTOMER_PREFERENCE, CUSTOMER_PROVIDED_PROOF, MANUAL_VALIDATION"
        },
        "locationInProperty": {
          "type": "string",
          "description": "Location in a campus, such as exterior building annex A.<br>Example: south west of main office entrance"
        },
        "addtionalDescriptions": {
          "type": "string",
          "description": "Any additionl descriptions.<br>Example: north door"
        },
        "department": {
          "type": "string",
          "description": "Department information for the address.<br>Example: Claims department"
        },
        "roomFloor": {
          "type": "string",
          "description": "Room or floor information for the address.<br>Example: 5th floor"
        },
        "crossStreet": {
          "type": "string",
          "description": "Cross Street information for the address.<br>Example: Union and Main"
        },
        "building": {
          "type": "string",
          "description": "Building information for the address.<br>Example: Building 300"
        },
        "apartment": {
          "type": "string",
          "description": "Apartment information for the address.<br>Example: Apartment 1503"
        },
        "room": {
          "type": "string",
          "description": "Room specific information for the address.<br>Example: Room B-23"
        }
      },
      "description": "Indicates additional address details for the physical location."
    },
    "Address_1": {
      "required": [
        "city",
        "countryCode",
        "streetLines"
      ],
      "type": "object",
      "properties": {
        "streetLines": {
          "type": "array",
          "description": "Combination of number, street name, etc. At least one line is required for a valid physical address. Empty lines should not be included. Max Length is 35.<br>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.<br>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.<br>Example: CA"
        },
        "postalCode": {
          "type": "string",
          "description": "This is the postal code.Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247"
        },
        "countryCode": {
          "type": "string",
          "description": "The two-letter code used to identify a country. Max length is 2.<br><a href=\"/developer-portal/en-us/reference-guide.html#countrycodes\" target=\"_blank\">Click here to see Country Codes</a>"
        },
        "residential": {
          "type": "boolean",
          "description": "Indicates whether this address is residential (as opposed to commercial)."
        }
      },
      "description": "This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (such as a city-state-ZIP combination within the US)."
    },
    "Address_2": {
      "type": "object",
      "properties": {
        "streetLines": {
          "type": "array",
          "description": "Combination of number, street name, etc. At least one line is required for a valid physical address. Empty lines should not be included. Max Length is 35.<br>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.<br>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.<br>Example: CA"
        },
        "postalCode": {
          "type": "string",
          "description": "This is the postal code.Note: This is Optional for non postal-aware countries. Maximum length is 10.<br>Example: 65247"
        },
        "countryCode": {
          "type": "string",
          "description": "The two-letter code used to identify a country. Max length is 2.<br><a href=\"/developer-portal/en-us/reference-guide.html#countrycodes\" target=\"_blank\">Click here to see Country Codes</a>"
        },
        "residential": {
          "type": "boolean",
          "description": "Indicates whether this address is residential (as opposed to commercial)."
        }
      },
      "description": "This is detailed information on physical location. May be used as an actual physical address (place to which one could go), or as a container of address parts which should be handled as a unit (such as a city-state-ZIP combination within the US)."
    },
    "BrokerDetail": {
      "type": "object",
      "properties": {
        "broker": {
          "description": "These are broker details for the shipment with physical address, contact and account number information.",
          "allOf": [
            {
              "$ref": "#/$defs/Party_1"
            },
            {
              "required": [
                "address",
                "contact"
              ],
              "properties": {
                "address": {
                  "description": "Broker address details."
                },
                "contact": {
                  "description": "Broker contact details."
                }
              }
            }
          ]
        },
        "type": {
          "type": "string",
          "description": "Identifies the type of Broker."
        }
      },
      "description": "Broker details for the shipment"
    },
    "CarrierCode": {
      "type": "string",
      "description": "Specifies which carrier should be included.<br>Example: FDXE"
    },
    "ClearanceItemDetail": {
      "type": "object",
      "properties": {
        "role": {
          "type": "string",
          "description": "Role in producing or supplying the item/commodity",
          "enum": [
            "MANUFACTURER"
          ]
        },
        "id": {
          "type": "string",
          "description": "Unique identifier of the manufacturer of the commodity.<br/> For shipments to United States, refer to U.S. Customs and Border Protection website.<br/>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.<br>Example: 98 Royal Crescent",
          "items": {
            "type": "string"
          }
        },
        "city": {
          "type": "string",
          "description": "The name of city, town of the recipient.<br> 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. <br> 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. <br> Example: 35209"
        },
        "countryCode": {
          "type": "string",
          "description": "The two-letter code used to identify a country.<br>Example: US"
        },
        "residential": {
          "type": "boolean",
          "description": "Indicate whether this address is Residential (as opposed to Commercial).<br>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.<br/>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<br>Example: 125SU212061F7"
        },
        "countryOfManufacture": {
          "type": "string",
          "description": "This is commodity country of manufacture. This is required for International shipments. Maximum allowed length is 4."
        },
        "weight": {
          "$ref": "#/$defs/Weight"
        },
        "quantity": {
          "type": "integer",
          "description": "This is the units quantity (using quantityUnits as the unit of measure) per commodity. This is used to estimate duties and taxes.",
          "format": "int32"
        },
        "quantityUnits": {
          "type": "string",
          "description": "This is the unit of measure for the units quantity. This is used to estimate duties and taxes."
        },
        "unitPrice": {
          "$ref": "#/$defs/Money"
        },
        "customsValue": {
          "$ref": "#/$defs/Money"
        },
        "commodityId": {
          "type": "string",
          "description": "Value used to identify a commodity description; must be unique within the containing shipment."
        },
        "clearanceItemDetail": {
          "type": "array",
          "description": "Array of clearance item details including manufacturer info for customs clearance.",
          "items": {
            "$ref": "#/$defs/ClearanceItemDetail"
          }
        }
      }
    },
    "ConsolidationCustomsDeclarationStatementDetail": {
      "type": "object",
      "properties": {
        "types": {
          "type": "array",
          "description": "It indicates the different statements, declarations, acts, and/or certifications that apply to this shipment.",
          "items": {
            "type": "string"
          }
        }
      },
      "description": "This provides the information necessary to identify the different statements,declarations, acts, and/or certifications that apply to this shipment."
    },
    "ConsolidationDataSources": {
      "type": "object",
      "properties": {
        "consolidationDataType": {
          "type": "string",
          "description": "Identifies the field being specified.",
          "enum": [
            "TOTAL_CUSTOMS_CODE",
            "TOTAL_FREIGHT_CHARGES",
            "TOTAL_HANDLING_COSTS",
            "TOTAL_INSURANCE_CHARGES",
            "TOTAL_INSURED_VALUE",
            "TOTAL_PACKING_COSTS",
            "TOTAL_TAXES_OR_MISCELLANEOUS_CHARGES"
          ]
        },
        "consolidationDataSourceType": {
          "type": "string",
          "description": "Identifies how the content of the field should be determined.",
          "enum": [
            "ACCUMULATED",
            "CLIENT"
          ]
        }
      },
      "description": "Specifies how selected values in the consolidation are to be determined."
    },
    "ConsolidationDocumentSpec": {
      "type": "object",
      "properties": {
        "consolidationDocumentTypes": {
          "type": "array",
          "description": "Specifies consolidation document types.<br>Example:<ul><li>CONSOLIDATED_COMMERCIAL_INVOICE</li><li>CUSTOMS_PACKING_LIST</li><li>CRN_REPORT</li><li>COMMODITIES_BY_TRACKING_NUMBER_REPORT</li><li>CONDENSED_CRN_REPORT</li><li>CONSOLIDATED_CUSTOMS_LINEHAUL_REPORT</li><li>CONSOLIDATED_PARTY_REPORT</li><li>CONSOLIDATED_SOLD_TO_SUMMARY_REPORT</li><li>CUSTOM_CONSOLIDATION_DOCUMENT</li></ul>",
          "items": {
            "type": "string"
          }
        },
        "consolidatedCommercialInvoiceDetail": {
          "$ref": "#/$defs/ConsolidationDocumentSpec_consolidatedCommercialInvoiceDetail"
        },
        "customsPackingListDetail": {
          "$ref": "#/$defs/ConsolidationDocumentSpec_customsPackingListDetail"
        },
        "crnReportDetail": {
          "$ref": "#/$defs/ConsolidationDocumentSpec_crnReportDetail"
        },
        "condensedCrnReportDetail": {
          "$ref": "#/$defs/ConsolidationDocumentSpec_condensedCrnReportDetail"
        },
        "consolidatedCustomsLinehaulReportDetail": {
          "$ref": "#/$defs/ConsolidationDocumentSpec_consolidatedCustomsLinehaulReportDetail"
        },
        "consolidatedPartyReportDetail": {
          "$ref": "#/$defs/ConsolidationDocumentSpec_consolidatedPartyReportDetail"
        },
        "consolidatedSoldToSummaryReportDetail": {
          "$ref": "#/$defs/ConsolidationDocumentSpec_consolidatedSoldToSummaryReportDetail"
        },
        "commoditiesByTrackingNumberDetail": {
          "$ref": "#/$defs/ConsolidationDocumentSpec_consolidatedSoldToSummaryReportDetail"
        },
        "customDocumentDetails": {
          "type": "array",
          "description": "Specifies the child reference number report detail for consolidated SoldTo summary report detail.",
          "items": {
            "$ref": "#/$defs/Formats"
          }
        }
      },
      "description": "Details of consolidation document specification"
    },
    "ConsolidationDocumentSpec_condensedCrnReportDetail": {
      "type": "object",
      "properties": {
        "format": {
          "$ref": "#/$defs/Formats"
        }
      },
      "description": "Specifies the child reference number report detail for condensed CrnReport Detail."
    },
    "ConsolidationDocumentSpec_consolidatedCommercialInvoiceDetail": {
      "type": "object",
      "properties": {
        "format": {
          "$ref": "#/$defs/Formats"
        }
      },
      "description": "Specifies consolidated commercial invoice detail."
    },
    "ConsolidationDocumentSpec_consolidatedCustomsLinehaulReportDetail": {
      "type": "object",
      "properties": {
        "format": {
          "$ref": "#/$defs/Formats"
        }
      },
      "description": "Specifies the child reference number report detail for consolidated customs linehaul report detail."
    },
    "ConsolidationDocumentSpec_consolidatedPartyReportDetail": {
      "type": "object",
      "properties": {
        "format": {
          "$ref": "#/$defs/Formats"
        }
      },
      "description": "Specifies the child reference number report detail for consolidated party report detail."
    },
    "ConsolidationDocumentSpec_consolidatedSoldToSummaryReportDetail": {
      "type": "object",
      "properties": {
        "format": {
          "$ref": "#/$defs/Formats"
        }
      },
      "description": "Specifies the child reference number report detail for consolidated SoldTo summary report detail."
    },
    "ConsolidationDocumentSpec_crnReportDetail": {
      "type": "object",
      "properties": {
        "format": {
          "$ref": "#/$defs/Formats"
        }
      },
      "description": "Specifies the child reference number report detail."
    },
    "ConsolidationDocumentSpec_customsPackingListDetail": {
      "type": "object",
      "properties": {
        "format": {
          "$ref": "#/$defs/Formats"
        }
      },
      "description": "Specifies the customs packing list detail."
    },
    "ContactAncillaryDetail_1": {
      "type": "object",
      "properties": {
        "emailAddresses": {
          "type": "array",
          "description": "Email Addresses",
          "items": {
            "$ref": "#/$defs/EMailDetail_1"
          }
        }
      },
      "description": "Indicates additional contact details for the Party such as email information."
    },
    "ContactAndAddress": {
      "type": "object",
      "properties": {
        "contact": {
          "$ref": "#/$defs/Contact_1"
        },
        "contactAncillaryDetail": {
          "$ref": "#/$defs/ContactAncillaryDetail_1"
        },
        "address": {
          "$ref": "#/$defs/Address_1"
        },
        "addressAncillaryDetail": {
          "$ref": "#/$defs/AddressAncillaryDetail"
        }
      },
      "description": "Indicates the contact and address details of a location."
    },
    "Contact_1": {
      "type": "object",
      "properties": {
        "personName": {
          "type": "string",
          "description": "Specify contact name. First 35 chars will be printed on the label, excess characters will be truncated.<br>Note: Either the companyName or personName is mandatory.<br>Example: John Taylor"
        },
        "emailAddress": {
          "type": "string",
          "description": "Specify contact email address. Maximum length is 80.<br>Example: sample@company.com"
        },
        "phoneExtension": {
          "type": "string",
          "description": "Specify contact phone extension. Maximum length is 6.<br>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.<br>Note: For US and CA, a phone number must have exactly 10 digits, plus an optional leading country code of '1' or '+1'.<br>Example: 918xxxxx890"
        },
        "faxNumber": {
          "type": "string",
          "description": "Specify contact fax number.<br>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.<br>Note: Either the companyName or personName is mandatory."
        },
        "stateTaxId": {
          "type": "string",
          "description": "Specify State TaxID for the contact person."
        },
        "fedralTaxId": {
          "type": "string",
          "description": "Specify Fedral TaxId for the contact person."
        }
      },
      "description": "Indicate the contact details for this shipment."
    },
    "CustomerReferences": {
      "type": "object",
      "properties": {
        "customerReferenceType": {
          "type": "string",
          "description": "This is a customer reference type. The value specified here for the element is printed on the Commercial Invoice only for tracking and label information.<p>Note: <ul><li>The P_O_NUMBER value must be specified in customerReferences under requestedPackageLineItems</li><li>The INVOICE_NUMBER value that is printed on the FedEx-supplied invoice must be specified in customerReferences under commercialInvoice. Value defined in this section will print on the label that is attached to the package</li></ul> <br>Note: INTRACOUNTRY_REGULATORY_REFERENCE is applicable only in Intra-Brazil. <br> <a onclick='loadDocReference(\"customerreferencetypes\")'>Click here for more information on Cutsomer References ENUMs</a>",
          "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.<br>Example: 3686<br>Note: Maximum length for all customer references is 40 characters."
        }
      },
      "description": "These are additional customer reference data for commercial invoice."
    },
    "CustomerSpecifiedLabelDetail": {
      "type": "object",
      "properties": {
        "maskedData": {
          "type": "array",
          "description": "Controls which data/sections will be suppressed.",
          "items": {
            "type": "string",
            "enum": [
              "CUSTOMS_VALUE",
              "DIMENSIONS",
              "DUTIES_AND_TAXES_PAYOR_ACCOUNT_NUMBER",
              "FREIGHT_PAYOR_ACCOUNT_NUMBER",
              "INSURED_VALUE",
              "PACKAGE_SEQUENCE_AND_COUNT",
              "SECONDARY_BARCODE",
              "SHIPPER_ACCOUNT_NUMBER",
              "SHIPPER_INFORMATION",
              "SUPPLEMENTAL_LABEL_DOC_TAB",
              "TERMS_AND_CONDITIONS",
              "TOTAL_WEIGHT",
              "TRANSPORTATION_CHARGES_PAYOR_ACCOUNT_NUMBER"
            ]
          }
        },
        "regulatoryLabels": {
          "type": "array",
          "description": "Specifies details needed to generate any label artifacts required due to regulatory requirements",
          "items": {
            "$ref": "#/$defs/RegulatoryLabelContentDetail"
          }
        },
        "docTabContent": {
          "$ref": "#/$defs/DocTabContent"
        }
      },
      "description": "Allows customer-specified control of label content"
    },
    "CustomsClearanceDetail": {
      "type": "object",
      "properties": {
        "customsOption": {
          "$ref": "#/$defs/CustomsOptionDetail"
        },
        "importerOfRecord": {
          "description": "The descriptive data for the importer of Record for the shipment and their physical address, contact and account number information.",
          "allOf": [
            {
              "$ref": "#/$defs/ImporterOfRecord"
            }
          ]
        },
        "recipientCustomsId": {
          "$ref": "#/$defs/RecipientCustomsId"
        },
        "dutiesPayment": {
          "$ref": "#/$defs/Payment1"
        },
        "documentContent": {
          "type": "string",
          "description": "Specifies document content.",
          "enum": [
            "DOCUMENTS_ONLY",
            "NON_DOCUMENTS",
            "DERIVED"
          ]
        },
        "totalCustomsValue": {
          "$ref": "#/$defs/Money"
        },
        "regulatoryControls": {
          "type": "array",
          "description": "RegulatoryControls",
          "items": {
            "type": "string",
            "enum": [
              "FOOD_OR_PERISHABLE",
              "USMCA",
              "NOT_APPLICABLE_FOR_LOW_VALUE_CUSTOMS_EXCEPTIONS",
              "NOT_IN_FREE_CIRCULATION"
            ]
          }
        },
        "insuranceCharges": {
          "description": "Amount paid to a third party for the purpose of insuring this shipment against damage or loss.  Used to calculate estimated duties and taxes",
          "allOf": [
            {
              "$ref": "#/$defs/Money"
            }
          ]
        },
        "declarationStatementDetail": {
          "$ref": "#/$defs/ConsolidationCustomsDeclarationStatementDetail"
        },
        "commercialInvoice": {
          "$ref": "#/$defs/CustomsClearanceDetail_commercialInvoice"
        },
        "exportDetail": {
          "$ref": "#/$defs/ExportDetail"
        },
        "commodities": {
          "type": "array",
          "description": "Indicates the details about the dutiable packages. Maximum upto 999 commodities per shipment.",
          "items": {
            "$ref": "#/$defs/Commodity"
          }
        },
        "brokers": {
          "type": "array",
          "description": "Specify broker information. Use this option only if you are using Broker Select Option for your shipment. A country code must be specified in addition to one of the following address items: postal code, city, or location id.",
          "items": {
            "$ref": "#/$defs/BrokerDetail"
          }
        },
        "clearanceBrokerage": {
          "type": "string",
          "description": "Specifies the type of brokerage to be applied to a shipment.",
          "enum": [
            "BROKER_INCLUSIVE",
            "BROKER_INCLUSIVE_NON_RESIDENT_IMPORTER",
            "BROKER_SELECT",
            "BROKER_SELECT_NON_RESIDENT_IMPORTER",
            "BROKER_UNASSIGNED"
          ]
        },
        "freightOnValue": {
          "type": "string",
          "description": "Specify the risk owner for the Freight shipment.This element is only mandatory or valid for Intra India shipments.",
          "enum": [
            "CARRIER_RISK",
            "OWN_RISK"
          ]
        }
      },
      "description": "Required for International and intra-country Shipments. Information about this package that only applies to an international (export) shipment or return."
    },
    "CustomsClearanceDetail_commercialInvoice": {
      "type": "object",
      "properties": {
        "termsOfSale": {
          "type": "string",
          "description": "Specify terms Of Sale that will be populated on the Commercial Invoice (or Pro Forma). Maximum length is 3.<br>Valid values are:<ul><li>FCA/FOB (Free Carrier/Free On Board): Seller is responsible for all costs of delivering goods to destination. (Default)</li><li>CIP (Costs, Insurance Paid): Seller is responsible for miscellaneous charges to destination.</li><li>CPT (Carriage Paid To): Buyer is responsible for insurance.</li><li>EXW (Ex Works): Seller makes goods available to buyer. Buyer is responsible for delivering goods to destination.</li><li>DDU (Delivered Duty Unpaid): Seller is responsible for delivering goods to destination. Buyer is responsible for clearing goods through Bureau of Customs and Border Protection.</li><li>DDP (Delivered Duty Paid): Seller is responsible for delivering goods to destination, including duties, taxes, and miscellaneous fees.</li><li>DAP (Delivered at Place): Seller pays for carriage to the named place except for costs related to import clearance, and assumes all risks prior to the point that the goods are ready for unloading by the buyer.</li><li>DPU (Deliver at Place of Unloading)</li></ul>"
        },
        "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).<br>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.<br>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.<br>Example: payment terms"
        },
        "purposeOfShipmentDescription": {
          "type": "string",
          "description": "This is the reason for the shipment.<br>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.<br>This element is required if a FedEx generated Consolidated Commercial Invoice is requested.<br>To request a FedEx generated Consolidated Commercial Invoice include \"CONSOLIDATED_COMMERCIAL_INVOICE\" value in the \"consolidationDocumentTypes\" array, in the \"consolidationDocumentSpecification\" object.<br>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:<ul><li>COURTESY_RETURN_LABEL: Applicable for Outbound shipments.</li><li>EXHIBITION_TRADE_SHOW: For exhibition or trade-show, outbound and inbound.</li><li>FAULTY_ITEM: For faulty item being returned, inbound only.</li><li>FOLLOWING_REPAIR: For repaired or processed item being sent, outbound only.</li><li>FOR_REPAIR: For repair or processing, outbound and inbound.</li><li>ITEM_FOR_LOAN: For loan i

# --- truncated at 32 KB (105 KB total) ---
# Full source: https://artifacts.apis.io/fedex/json-schema/fedex-modify-consolidation-response-schema.json