--- title: "Cancel an existing order." method: DELETE path: "/api/v1/packShip/order/{orderId}" tags: ["pack-ship-orchestration"] --- # Cancel an existing order. `DELETE /api/v1/packShip/order/{orderId}` ## Path parameters - `orderId` string, required ## Query parameters - `tenantId` string ## Headers - `X-DELEGATED-PARTNER-ID` string ## Response `200` The results of the order cancellation. - Order - `fulfillmentType` 'customer' | 'at_large' | 'returns' | 'hundredweight' | 'reship' | 'unknown' — Fulfillment methodology of the shipment. - `orderSource` 'shipium' | 'external' — The source of this order whether it is from the shipium system or externally created - `tenantId` string — Either the shipium tenant ID or the partner provided tenant ID. When present, this is used to indicate the tenant associated with the shipment. - `shipiumOrderId` string, required — Identification use to represent the group of delivery estimates purchased. - `partnerOrderId` string — The unique identifier representing this order. - `orderedDateTime` string, date-time, required — The timestamp for when the customer ordered the product. The timestamp must be a valid ISO 8601 timestamp - `orderItemQuantities` OrderItem[], required — A list of orderItems comprising the shipment. - `orderItemReferenceIdentifier` string — An external identifier that can reference the order item that exists in an external OMS. This field will be passed to supported carriers. - `shipiumOrderId` string — Identification use to represent the group of delivery estimates purchased. - `partnerOrderId` string — The unique identifier representing this order. - `hazmat` boolean — Indicator that the item is hazmat. Defaults to false - `hazmatInfo` HazmatInfo — Contains hazmat information for this particular item. - `category` 'defined' | 'aerosols_flammable' | 'contains_lithium_ion' | 'packaged_lithium_ion' | 'lithium_ion_battery_only' | 'contains_lithium_metal' | 'packaged_lithium_metal' | 'lithium_metal_battery_only' | 'dry_ice', required — Hazmat category for this order item. Use 'defined' to specify detailed information - `quantity` number, float, required — The amount of quantityType material in quantityUnits - `quantityType` 'gross' | 'net', required — Determines whether the quantity includes the raw material (net) or also includes the material housing (gross) - `quantityUnits` 'g' | 'kg' | 'lb' | 'oz' | 'ml' | 'l', required — The units of measure for the quantity of hazardous materials specified - `containerType` 'fiberboard_box' | 'wooden_box' | 'plastic_jerrican' | 'metal_box' | 'steel_drum' | 'other' | 'plastic_box' | 'plastic_drum' | 'styrofoam_box' | 'cylinder' | 'envirotainer' | 'plywood_box' | 'aluminum_drum' | 'aluminum_cylinder' | 'plastic_pail' | 'plywood_drum' | 'fiber_drum' | 'steel_jerrican' | 'aluminum_jerrican' | 'steel_box' | 'carton' | 'aluminum_box', required — The material that the hazardous material is packaged in. - `hazmatId` string — The IATA or DOT regulatory identifier for the commodity as appropriate. Required if category is 'defined' - `properShippingName` string — Proper shipping name that is associated with the specified hazmatId. Required if category is 'defined' - `packingGroup` 'I' | 'II' | 'III' — The packing group code for the hazardous material, as defined in column (5) of § 172.101. These indicate the degree of danger presented by the material: I=great, II=medium, III=minor. A material can have multiple packing groups, for determining the correct packing group see https://www.ecfr.gov/current/title-49/subtitle-B/chapter-I/subchapter-C/part-173/subpart-D/section-173.121 - `transportMode` 'ground' | 'passenger_and_cargo_aircraft' | 'cargo_aircraft_only' — Declares that a package was prepared according to ground, passenger aircraft, or cargo aircraft only. Required if category is 'defined' - `packingInstructionCode` string — The IATA packing instruction code used for air transport (e.g., PI965-PI970). Required for 'limited_quantity_air' and 'small_battery_exception_air'. Not applicable for 'small_battery_exception_ground' (49 CFR §173.185(c)(1)(iv) is a Special Provision, not a Packing Instruction). - `hazardClass` 'class_1_explosive' | 'class_2_flammable_gas' | 'class_3_flammable_liquid' | 'class_4_flammable_solid' | 'class_5_organic_peroxide' | 'class_6_poisonous_material' | 'class_7_radioactive' | 'class_8_corrosive_material' | 'class_9_miscellaneous' | 'forbidden' | 'other' — See https://www.ecfr.gov/current/title-49/subtitle-B/chapter-I/subchapter-C/part-173 - `subsidiaryClasses` string[] — The appropriate IATA/DOT subsidiary classes associated with the material and the hazard class. - `numberOfInnerPackagings` integer — Number of inner packagings within the outer packaging. Required for 'limited_quantity_air', 'small_battery_exception_air', and 'small_battery_exception_ground' - `innerPackagingType` string — Type of inner packaging (e.g., glass bottle, plastic receptacle). Required for 'limited_quantity_air', 'small_battery_exception_air', and 'small_battery_exception_ground' - `outerPackagingType` string — Type of outer packaging (e.g., fiberboard box, plywood drum). Required for 'limited_quantity_air', 'small_battery_exception_air', and 'small_battery_exception_ground' - `shipperDeclarationStatement` 'FDG' | 'LQ_air' | 'EQ' | 'small_battery_air' | 'small_battery_ground' | 'cargo_aircraft_only' — The shipper's declaration statement type for dangerous goods shipments - `wattHours` number, float — Watt-hours rating for lithium batteries. Required for lithium battery hazmat IDs (UN3480, UN3481, UN3090, UN3091) under 'limited_quantity_air', 'small_battery_exception_air', or 'small_battery_exception_ground', if lithiumContent is not provided - `lithiumContent` number, float — Lithium content in grams. Required for lithium battery hazmat IDs (UN3480, UN3481, UN3090, UN3091) under 'limited_quantity_air', 'small_battery_exception_air', or 'small_battery_exception_ground', if wattHours is not provided - `numberOfCells` integer — Number of cells in the battery. For lithium battery hazmat IDs: required under 'limited_quantity_air'. Under 'small_battery_exception_air' or 'small_battery_exception_ground', at least one of numberOfCells/numberOfBatteries must be greater than 0 (a single loose cell is numberOfCells=1, numberOfBatteries=0) - `numberOfBatteries` integer — Number of batteries in the package. For lithium battery hazmat IDs: required under 'limited_quantity_air'. Under 'small_battery_exception_air' or 'small_battery_exception_ground', at least one of numberOfCells/numberOfBatteries must be greater than 0, and numberOfBatteries must be >= 1 when numberOfCells >= 2 - `batteryConfiguration` 'contained_in_equipment' | 'packed_with_equipment' | 'standalone' — Describes how a lithium battery is packaged relative to the equipment it powers - `productTaxCode` string — The tax code that applies to the given product. - `nmfcCode` string — Useful for LTL shipments, a string representing the narrow type of product being shipped. For example, bricks have a NMFC code of `32100.2` and steel pipes have a NMFC code of `51200` - `nmfcFreightClass` string — Required for LTL shipments, a string representing the broad class of product being shipped. For example, both bricks and steel pipes have a NMFC class of `50` - `deliveryEstimateId` string — Delivery Estimate Id associated to this product - `productId` string, required — A product ID for the product being checked, such as ISBN, UPC, etc. - `quantity` integer, required — The number of units of this product - `productDetails` string[] — A list of properties that may affect the shipping of the product - `itemWeight` Weight — The weight of this type of packaging empty. - `weightUnit` 'g' | 'kg' | 'oz' | 'lb' — The unit that weight values are provided in. g for grams kg for kilograms oz for ounces lb for pounds - `weight` number, float — The value of the weight. - `productDescription` string — A general-purpose product description suitable for display on pack slips and fulfillment documents. - `serialNumbers` string[] — Serial numbers for individual units of this item. - `associatedIdentifiers` string[] — Associated identifiers that are indexed to identify this order. This can be an LPN for instance that is bound to the order. Can be searched but not interchangeable with orderId. - `shipOption` string — A high-level shipping option shown to or selected by a customer. - `originId` string — Origin where the order is assigned to. Cannot be assigned if shipFromAddress is also populated - `shipFromAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `destinationAddress` CSAddress, required — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `customsInfo` RequestCustomsInfo — Customs information about the package for international shipping. - `totalCustomsValue` number, float — The customs value of the shipment in totalCustomsValueCurrency - `totalCustomsValueCurrency` string — The ISO-4217 currency code representing the totalCustomsValue - `customsDescription` string — The detailed description of the items being shipped - `reasonForExport` 'sale' | 'gift' | 'sample' | 'returns' | 'personal_effects' | 'unknown' — The reason to export an international shipment - `businessIndicator` 'B2C' | 'B2B' | 'unknown' — Shipment-level indicator of whether the shipment is a business-to-consumer (B2C) or business-to-business (B2B) transaction. Required for EU27-inbound customs clearance after the 2026-07-01 de minimis removal. Partner-supplied; not derived from the address type. - `invoiceDate` string, date — Date when the invoice was created. Ideally this is the same as the ship date - `invoiceNumber` string — The Commercial Invoice number, if the Commercial Invoice was generated by the partner - `invoicePrePaidAmount` InvoicePrePaidAmount — Prepaid shipping/handling charges to include on the commercial invoice. - `value` number, float — The prepaid amount value. - `currencyCode` string — The currency code for the prepaid amount. - `europeanUnionInfo` EuropeanUnionInfo — Important information to supply when shipping to the european union. - `vendorIossNumber` string — An Import One-Stop-Shop (IOSS) number is a 12-digit identification number that is used to pay VAT and declare imports to the European Union (EU). The IOSS number is a type of VAT identification, but it is not the same as a resident VAT registration. - `vendorIossAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `ultimateConsigneeAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `ultimateConsigneeType` 'direct_consumer' | 'government_entity' | 'reseller' | 'unknown' — The type of the ultimate consignee - `aesInternalTransactionNumber` string — The number received if the Electronic Export Information (EEI) was filed and has been accepted in the Automated Export System (AES) - `electronicExportInformation` ElectronicExportInformation — Information for the Electronic Export Information (EEI) customs form, only used when the EEI will be filed directly by the carrier (i.e. not filed by the partner using AES Direct or otherwise) - `exportDate` string, date — The date the goods will be exiting the country - `pointOfOrigin` string — The 2-character state abbreviation from which the goods were shipped to the port of export. - `b13AFilingOption` 'NOT_REQUIRED' | 'MANUALLY_ATTACHED' | 'FILED_ELECTRONICALLY' | 'SUMMARY_REPORTING' | 'CARRIER_TO_STAMP' | 'UNKNOWN' — 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. - `exportComplianceStatement` string — 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 b13AFilingOption. Example: 98765432107654321(POR number), 7654321(Summary POR number) and 02(Exemption number). For FTR exemption number you need provide a predefined value as NO_EEI_30_37_A. - `permitNumber` string — 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. - `customsItems` CustomsItemData[] — Contains customs information for each item in the shipment. - `customsValue` number, float — The value of each individual item to report to customs in customsValueCurrency - `customsValueCurrency` string — The ISO-4217 currency code representing the customsValue - `commodityDescription` string — A description of this product to be provided to customs - `countryOfManufacture` string — The ISO-3166 2 digit country code that manufactured the this product - `customsWeight` Weight — The weight of this type of packaging empty. - `weightUnit` 'g' | 'kg' | 'oz' | 'lb' — The unit that weight values are provided in. g for grams kg for kilograms oz for ounces lb for pounds - `weight` number, float — The value of the weight. - `quantity` integer — The number of units of this customs item - `productId` string — The merchant's product identifier (SKU) for this customs item. - `standardizedProductIds` StandardizedProductId[] — Standardized product identifiers (GTIN/EAN/UPC/ISBN) for this customs item. - `type` 'GTIN' | 'EAN' | 'UPC' | 'ISBN' | 'unknown' — The standard that a standardized product identifier conforms to (e.g. a barcode standard). - `value` string — The standardized product identifier value. - `manufacturerProductId` string — The manufacturer's non-standardised product identifier (EU C128) for this customs item — a free-form code assigned by the manufacturer or brand (e.g. internal SKU / part number). Distinct from the merchant productId and the standardized barcodes. - `quantityUnitOfMeasurement` 'bag' | 'barrel' | 'box' | 'case_of_goods' | 'container' | 'crate' | 'cylinder' | 'envelope' | 'pallet' | 'piece' | 'roll' | 'tube' | 'unknown' — The unit of measurement of the item - `harmonizedTariffNumber` string — The 6-15 digit Harmonized System Tariff classification code - `commodityPartNumber` string — The part number or reference number for the product - `marksAndNumbers` string — Any special marks, codes, and numbers that may identify the package - `electronicExportCommodityInformation` ElectronicExportCommodityInformation — Customs item information that is particular to the Electronic Export Information (EEI) - `exportType` 'domestic' | 'foreign' | 'unknown', required — The type of the export. - `exportInformationCode` string, required — The 2-digit export information code for the commodity. - `scheduleBInformation` ScheduleBInformation, required — The Schedule B information for the commodity. - `scheduleBNumber` string, required — The 10-digit Schedule B classification code for the item being exported - `scheduleBQuantity` integer, required — The count of how many Schedule B units are in the shipment - `scheduleBUnitOfMeasurement` 'barrels' | 'carat' | 'content_kilogram' | 'square_centimeter' | 'content_ton' | 'curie' | 'clean_yield_kilogram' | 'dozen' | 'dozen_pieces' | 'dozen_pairs' | 'fiber_meter' | 'gross_container' | 'gram' | 'gross' | 'hundred' | 'kilogram' | 'cubic_kilometer' | 'kilogram_total_sugars' | 'liter' | 'meter' | 'square_meter' | 'cubic_meter' | 'millicurie' | 'number' | 'pieces' | 'proof_liter' | 'pack' | 'pairs' | 'running_bales' | 'square' | 'ton' | 'thousand' | 'no_quantity_required' | 'unknown', required — The unit of measure for the Schedule B quantity - `eccnNumber` string, required — The 5-digit product ECCN number as issued by the Bureau of Industry and Security. The format is #A###. - `exportLicenseInformation` ExportLicenseInformation, required — The license information for the export. - `licenseType` string, required — The standard license type code as published by the US government. - `licenseExemptionCode` string — The license exemption code, if the license type does not require a license number. - `exportLicense` ExportLicense — The export license, if the license type requires a valid license. - `licenseNumber` string, required — The license number. - `licenseLineValue` integer, required — The export monetary amount allowed per license. - `licenseExpiration` string, date, required — The license expiration date. - `b13AFilingOption` 'NOT_REQUIRED' | 'MANUALLY_ATTACHED' | 'FILED_ELECTRONICALLY' | 'SUMMARY_REPORTING' | 'CARRIER_TO_STAMP' | 'UNKNOWN' — 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. - `exportComplianceStatement` string — 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 b13AFilingOption. Example: 98765432107654321(POR number), 7654321(Summary POR number) and 02(Exemption number). For FTR exemption number you need provide a predefined value as NO_EEI_30_37_A. - `cpscCertificateOfCompliance` CpscCertificateOfCompliance — CPSC Certificate of Compliance data for US import of CPSC-regulated consumer products. Supports two filing modes: FULL (all certificate data inline) or REFERENCE (pointer to CPSC Product Registry). - `filingMode` 'FULL' | 'REFERENCE', required — CPSC Certificate of Compliance filing mode - `cpscProductId` string — CPSC product certification identifier — distinct from the SKU-level productId on CustomsItem or OrderItemQuantity (required for FULL mode) - `applicableCpscRules` string[] — CPSC rules or standards the product was tested against (required for FULL mode, e.g. "16 CFR 1219", "ASTM F2194") - `dateOfManufacture` string, date — Date the product was manufactured (required for FULL mode) - `manufacturerName` string — Name of the manufacturer (required for FULL mode) - `manufacturerAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `lastComplianceTestingDate` string, date — Date of most recent compliance testing (required for FULL mode) - `testingLabName` string — Name of the accredited testing laboratory (required for FULL mode) - `testingLabAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `testingLabContactInfo` string — Testing laboratory phone or email contact (required for FULL mode) - `importerRecordKeeperContact` string — Importer or record-keeper contact information (required for FULL mode) - `registryProductId` string — Product ID in the CPSC Product Registry (required for REFERENCE mode) - `registryVersionId` string — Version ID in the CPSC Product Registry (required for REFERENCE mode) - `registryCertifierId` string — Certifier ID in the CPSC Product Registry (required for REFERENCE mode) - `incoterm` 'DDP' | 'DDU' | 'DAP' | 'DPU' | 'FCA' | 'CPT' | 'FOB' | 'EXW' — Enum used to represent desired incoterm. - `declarationStatement` string — A customs declaration statement for the shipment that, if provided, will appear on generated commercial invoices. - `taxIdentificationNumber` string — The EIN tax identification number of the shipper - `importerOfRecord` ImporterOfRecord — Address details of the importer for customs purposes for the vast majority of Express import shipments - `importerAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `accountNumber` string — Account Number of importer - `taxIdentificationNumbers` RequestTaxIdentificationNumber[] — Tax Identification numbers of importer - `number` string — Tax Identification Number - `tinType` 'PERSONAL_NATIONAL' | 'PERSONAL_STATE' | 'FEDERAL' | 'BUSINESS_NATIONAL' | 'BUSINESS_STATE' | 'BUSINESS_UNION' — Type of Tax Identification Number - `brokers` Broker[] — Address details of the broker for customs purposes - `brokerAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `accountNumber` string — Account Number of the broker - `taxIdentificationNumbers` RequestTaxIdentificationNumber[] — Tax Identification numbers of broker - `number` string — Tax Identification Number - `tinType` 'PERSONAL_NATIONAL' | 'PERSONAL_STATE' | 'FEDERAL' | 'BUSINESS_NATIONAL' | 'BUSINESS_STATE' | 'BUSINESS_UNION' — Type of Tax Identification Number - `deliveryInstructions` string — Delivery Instructions of broker - `type` 'IMPORT' | 'EXPORT' — Type of the broker - `soldTo` SoldTo — Address details of the sold to party for customs purposes - `address` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `accountNumber` string — Account Number of the sold to party - `taxIdentificationNumbers` RequestTaxIdentificationNumber[] — Tax Identification numbers of the sold to party - `number` string — Tax Identification Number - `tinType` 'PERSONAL_NATIONAL' | 'PERSONAL_STATE' | 'FEDERAL' | 'BUSINESS_NATIONAL' | 'BUSINESS_STATE' | 'BUSINESS_UNION' — Type of Tax Identification Number - `currencyCode` string — Currency used in the transaction resulting in the order. - `totalDeclaredValue` DeclaredValue — The total monetary amount of the declared value for the package. This is what will be reimbursed if the package is damaged. If the declared value exceeds the carrier's free threshold, there may a surcharge for passing a declared value. - `declaredValue` number, float — The value to be passed through as the total declared value. - `currencyCode` string — The currency code for the declared value. - `orderFulfillmentParameters` OrderFulfillmentParameters — These represent hints that correspond to Shipment Parameters that can be specified ahead of shipment creation on the order. These can be overridden at the time of shipment creation. - `deliveryParameters` OrderDeliveryParameters — Information used to influence the shipping experience of the order such speed of shipping, required signatures upon delivery, and saturday delivery. - `applyToSplits` boolean — Indicates if the order delivery parameters defined in this object are applied when a order is split (not shipped in full). - `businessDaysOfTransit` integer — Indicates the number of business days from the ship time by when the shipment needs to be delivered. - `deliveryNote` string — A string passed to carriers for a delivery note. - `deliverySignatureOption` 'None' | 'Signature' | 'ResidentSignature' | 'AdultSignature' | 'AdultResidentSignature' | 'Unknown' — The delivery Signature Option to be passed on to the carrier. Defaults to none. - `deliveryWindow` TimeWindow — A string passed to carriers for a delivery window. - `startWindow` string, required — A time without any date or timezone - `endWindow` string, required — A time without any date or timezone - `timeZone` string - `desiredDeliveryDate` string — The string representation of either an ISO-8601 date or a LocalDate: yyyy-mm-dd. The date or datetime the package is intended to arrive to the customer. This will be used to determine the most appropriate service method when generating a label - `desiredDeliveryDateOptions` DesiredDeliveryDateOptions — Options for how the system will use the desiredDeliveryDate - `exactDateDelivery` boolean — This will restrict carrier selection to only use service methods that we have a high chance of making it there on time. - `lastMileDeliveryOptions` LastMileDeliveryOptions — A collection of fields used for instructing carriers on how to handle last mile delivery. - `deliveryInstruction` 'LEAVE_AT_DOOR' | 'MEET_AT_DOOR' — Instructions passed to the carrier on how to handle on delivery. - `undeliverableInstruction` 'LEAVE_AT_DOOR' | 'RETURN' | 'DESTROY' — Instructions passed to the carrier on how to handle packages that go undelivered - `tip` Tip — Field passed to carriers like Uber to specify the tip - `type` 'FIXED' | 'PERCENTAGE' — Define the type of tip - `value` number, float — Fix amount or percentage value for the tip - `currency` string - `tipForLabelCreate` Tip — Field passed to carriers like Uber to specify the tip - `type` 'FIXED' | 'PERCENTAGE' — Define the type of tip - `value` number, float — Fix amount or percentage value for the tip - `currency` string - `deliverableActionForLabelCreate` 'RETURN' | 'LEAVE_AT_DOOR' | 'DISCARD' | 'MEET_AT_DOOR' - `undeliverableActionForLabelCreate` 'RETURN' | 'LEAVE_AT_DOOR' | 'DISCARD' | 'MEET_AT_DOOR' - `preferredCarrierDeliveryDateTime` string, date-time — The string representation of either an ISO-8601 date. The datetime the package is intended to arrive to the customer. This will be passed through to the carrier. - `saturdayDelivery` boolean — Indicates that this shipment is marked for Saturday delivery. Does not guarantee delivery on Saturday - `carrierServiceMethodAllowList` string[] — A list of carrierServiceMethodId and/or carriers that should be considered for selection when packing this order. - `saturdayDelivery` boolean — Indicates that this shipment is marked for Saturday delivery. Does not guarantee delivery on Saturday. Note this field is marked as deprecated and is replaced with deliveryParameters.saturdayDelivery. This field will be removed in a future release. - `thirdPartyBillingSetId` string — Either the shipium third party billing set ID or the partner provided third party billing set ID. When present, this is used to indicate the third party billing set that should be used for the billing of the shipment. - `forceThirdPartyBilling` boolean — Indicates that third party billing is a requirement for this shipment, no service method should be selected that does not support third party billing - `fulfillmentContext` string — FulfillmentContext by tag - `fulfillmentContextId` string — FulfillmentContext by ID - `holdAtLocation` HoldAtLocation — Use HoldAtLocation to indicate the package should be held at a carrier location for pickup. - `holdAtLocationId` string - `useHoldAtLocation` boolean - `referenceIdentifier` string — String passed to carriers as a reference. - `referenceIdentifier2` string — String passed to carriers as a reference2. - `referenceIdentifier3` string — String passed to carriers as a reference3. - `referenceIdentifier4` string — String passed to carriers as a reference4. - `referenceIdentifier5` string — String passed to carriers as a reference5. - `partnerReferenceIdentifier` string — Partner supplied string passed to carriers as a reference. - `partnerReferenceIdentifier2` string — Partner supplied string passed to carriers as a reference2. - `splitOrder` boolean — When true, this is a signal that the order will be split into multiple shipments. It is expected the 'splitParameters' field will be set and containing information on the makeup of the shipments to fulfill the order. - `splitParameters` OrderSplitParameters[] — When 'splitOrder' is true, this field contains the definition of the makeup of the shipments the order is split into. - `splitReferenceId` string — Unique identifier for the split params, used to associate with generated split shipments for provenance. - `reasonCode` 'customer_request' | 'item_size' | 'stock_not_available' — Defines the reason for breaking the order into multiple shipments. - `fulfilled` boolean — When true there has been a shipment generated for this set of order split parameters. and the items referenced in the split params of the order are accounted for a shipping / shipped. - `saturdayDelivery` boolean — Indicates that this split shipment is marked for Saturday delivery. Does not guarantee delivery on Saturday - `thirdPartyBillingSetId` string — Either the shipium third party billing set ID or the partner provided third party billing set ID. When present, this is used to indicate the third party billing set that should be used for the billing of the split shipment. - `forceThirdPartyBilling` boolean — Indicates that third party billing is a requirement for this split shipment, no service method should be selected that does not support third party billing - `orderItemQuantities` OrderItemReference[], required — A list of order item references comprising the split. - `orderItemReferenceIdentifier` string — An external identifier that can reference the order item that exists in an external OMS. This field will be passed to supported carriers. - `productId` string, required — A product ID for the product being checked, such as ISBN, UPC, etc. - `quantity` integer, required — The number of units of this product - `packagingType` PackagingTypeParameters — Fields describing the physical properties of the package. - `packagingMaterial` 'box' | 'envelope' | 'flat_pack' | 'fedex_one_rate_envelope' | 'fedex_one_rate_pak' | 'fedex_one_rate_extra_small_box' | 'fedex_one_rate_small_box' | 'fedex_one_rate_medium_box' | 'fedex_one_rate_large_box' | 'fedex_one_rate_extra_large_box' | 'fedex_one_rate_tube' | 'fedex_ten_kg_box' | 'fedex_twenty_five_kg_box' | 'mailing_tube' | 'parcel_pallet' | 'small_tire' | 'large_tire' | 'usps_large_box' | 'usps_large_box_to_apo_fpo_dpo' | 'usps_medium_box' | 'usps_small_box' | 'usps_legal_envelope' | 'usps_envelope' | 'usps_padded_envelope' | 'ups_express_envelope' — The type of packaging used to create the package for the shipment. - `packagingSizeName` string — A custom name for the packaging. - `packagingTypeId` string — Either the Shipium or partner-provided packagingTypeId that was used for this package. When this value is present, the dimensions defined in the partner are used. When this value is absent, linearDimensions is required. - `linearDimensions` LinearDimensions — Dimensions describing the size of the packaging. - `linearUnit` 'in' | 'cm' — The unit that linear dimensions are provided in, either in for inches or cm for centimeters. - `length` number, float — The longest linear dimension (e.g. the longest side of a box or envelope). - `width` number, float — The second longest linear dimension (e.g. the second-longest side of a box of envelope. - `height` number, float — The least long linear dimension (e.g. the shortest side of a box or envelope. Note on envelopes: This height should represent the highest product you would reasonably put in this envelope before losing more than 10% of the length of the envelope in other dimensions. - `packagingWeight` Weight — The weight of this type of packaging empty. - `weightUnit` 'g' | 'kg' | 'oz' | 'lb' — The unit that weight values are provided in. g for grams kg for kilograms oz for ounces lb for pounds - `weight` number, float — The value of the weight. - `totalWeight` Weight — The weight of this type of packaging empty. - `weightUnit` 'g' | 'kg' | 'oz' | 'lb' — The unit that weight values are provided in. g for grams kg for kilograms oz for ounces lb for pounds - `weight` number, float — The value of the weight. - `packagingType` PackagingTypeParameters — Fields describing the physical properties of the package. - `packagingMaterial` 'box' | 'envelope' | 'flat_pack' | 'fedex_one_rate_envelope' | 'fedex_one_rate_pak' | 'fedex_one_rate_extra_small_box' | 'fedex_one_rate_small_box' | 'fedex_one_rate_medium_box' | 'fedex_one_rate_large_box' | 'fedex_one_rate_extra_large_box' | 'fedex_one_rate_tube' | 'fedex_ten_kg_box' | 'fedex_twenty_five_kg_box' | 'mailing_tube' | 'parcel_pallet' | 'small_tire' | 'large_tire' | 'usps_large_box' | 'usps_large_box_to_apo_fpo_dpo' | 'usps_medium_box' | 'usps_small_box' | 'usps_legal_envelope' | 'usps_envelope' | 'usps_padded_envelope' | 'ups_express_envelope' — The type of packaging used to create the package for the shipment. - `packagingSizeName` string — A custom name for the packaging. - `packagingTypeId` string — Either the Shipium or partner-provided packagingTypeId that was used for this package. When this value is present, the dimensions defined in the partner are used. When this value is absent, linearDimensions is required. - `linearDimensions` LinearDimensions — Dimensions describing the size of the packaging. - `linearUnit` 'in' | 'cm' — The unit that linear dimensions are provided in, either in for inches or cm for centimeters. - `length` number, float — The longest linear dimension (e.g. the longest side of a box or envelope). - `width` number, float — The second longest linear dimension (e.g. the second-longest side of a box of envelope. - `height` number, float — The least long linear dimension (e.g. the shortest side of a box or envelope. Note on envelopes: This height should represent the highest product you would reasonably put in this envelope before losing more than 10% of the length of the envelope in other dimensions. - `packagingWeight` Weight — The weight of this type of packaging empty. - `weightUnit` 'g' | 'kg' | 'oz' | 'lb' — The unit that weight values are provided in. g for grams kg for kilograms oz for ounces lb for pounds - `weight` number, float — The value of the weight. - `totalWeight` Weight — The weight of this type of packaging empty. - `weightUnit` 'g' | 'kg' | 'oz' | 'lb' — The unit that weight values are provided in. g for grams kg for kilograms oz for ounces lb for pounds - `weight` number, float — The value of the weight. - `orderStatus` 'open' | 'open_split' | 'complete' | 'complete_multiship' | 'cancelled' | 'partial_ship' | 'error' — State of the order. - `orderFulfillmentInfo` OrderFulfillmentInfo — Information on shipments fulfilling the order, and items remaining unshipped. - `shipments` OrderShipmentInfo[] — Shipments currently generated to fulfill items on the order. - `shipiumShipmentId` string — The unique identifier for the shipment. Generated by shipium. - `partnerShipmentId` string — The optional unique identifier provided by the partner to identify the shipment. - `shipiumOrderId` string — The unique identifier for the order. Generated by shipium. - `partnerOrderId` string — The optional unique identifier provided by the partner to identify the order. - `parametersReferenceId` string — ID of the parameters used to generated the shipment. - `type` 'complete' | 'consolidation' | 'split' — High level description of how the shipment fulfills the order. - `carrierTrackingId` string — Tracking number provided by the carrier for the shipment - `carrier` string — Carrier fulfilling the shipment. - `carrierServiceMethodId` string — Service level of the shipment. - `orderItemQuantities` OrderItemReference[] — Items shipped from the order. - `orderItemReferenceIdentifier` string — An external identifier that can reference the order item that exists in an external OMS. This field will be passed to supported carriers. - `productId` string, required — A product ID for the product being checked, such as ISBN, UPC, etc. - `quantity` integer, required — The number of units of this product - `unfulfilledItems` OrderItemReference[] — Balance of items not shipped remaining on the order. - `orderItemReferenceIdentifier` string — An external identifier that can reference the order item that exists in an external OMS. This field will be passed to supported carriers. - `productId` string, required — A product ID for the product being checked, such as ISBN, UPC, etc. - `quantity` integer, required — The number of units of this product ## Other responses - `400` — Invalid inputs were provided. --- [API](https://skmtc.net/shipium/apis/shipium-api.md) · [All operations](https://skmtc.net/shipium/apis/shipium-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shipium/shipium-api/revisions/7ef5dbd6a025/schema)