--- title: "A synchronous bulk orchestration in front of the MegaShipmentProcess, allowing concurrent requests to be created and return results together. Please note that this endpoint is will block while the the full request is completely processed. Failures will not block and are returned alongside the results." method: POST path: "/api/v1/shipment/bulkprocessing/labels" tags: ["bulk-processing-orchestration"] --- # A synchronous bulk orchestration in front of the MegaShipmentProcess, allowing concurrent requests to be created and return results together. Please note that this endpoint is will block while the the full request is completely processed. Failures will not block and are returned alongside the results. `POST /api/v1/shipment/bulkprocessing/labels` ## Query parameters - `includeLedgerInOrchestrationMetadata` boolean ## Request body - BulkLabelRequest - `shipmentRequests` MegaShipmentProcessCreate[] - `currencyCode` string, required — Currency in which all the rates for shipping carrier selection costs will be calculated in. - `multiParcelShipmentParameters` MultiParcelShipmentParameters — Used for multi parcel shipment requests; mutually exclusive with createUsingExistingShipment and shipmentParameters. Details of the shipment plus each of its packages, including weight, package type, items, tags, and to/from addresses. - `partnerShipmentId` string — An optional unique identifier that may be used for this shipment. - `orderedDateTime` string, date-time — The timestamp for when customer placed an order for this product. The timestamp must be a valid ISO 8601 timestamp. - `shippedDateTime` string, date-time — The timestamp for when you (or your fulfillment partner) shipped the product from your (or their) warehouse. The timestamp must be a valid ISO 8601 timestamp. - `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 - `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. - `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. - `businessDaysOfTransit` integer — Indicates the number of business days from the ship time by when the shipment needs to be delivered. - `ignoreUpgradeSpendLimits` boolean — Indicates that this shipment can ignore all the partner-configured upgrade limits for the potential upgrade required to deliver the shipment by the desired delivery date. - `includePackagesArray` boolean — Forces the packages array to be populated for all non multi parcel shipments. - `carrierName` string — The carrier that was used for delivering the package to your customer. - `shipFromAddress` 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. - `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. - `returnToAddress` 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. - `shipOption` string — A high-level shipping option shown to or selected by a customer. - `shipmentTags` string[] — A collection of free-form tags that may be added to this shipment. - `saturdayDelivery` boolean — Indicates that this shipment is marked for Saturday delivery. Does not guarantee delivery on Saturday - `deliverySignatureOption` 'None' | 'Signature' | 'ResidentSignature' | 'AdultSignature' | 'AdultResidentSignature' | 'Unknown' — Defaults to None - `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' - `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 - `pickupWindow` 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 - `deliveryNote` string — String passed to carriers for a delivery note. - `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. - `purchaseOrderIdentifier` string — String passed to carriers as a purchase order identifier. - `partnerReferenceIdentifier` string — Partner supplied string passed to carriers as a reference. - `partnerReferenceIdentifier2` string — Partner supplied string passed to carriers as a reference2. - `carrierProcessingId` string — Carrier-provided identifier, supplied when it is needed to process the shipment. - `fulfillmentContext` string — When present, this is used to limit carrier selection to carrier accounts that contain a matching fulfillmentContext - `fulfillmentType` 'customer' | 'at_large' | 'returns' | 'hundredweight' | 'reship' | 'unknown' — Fulfillment methodology of the shipment. - `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. - `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 - `fulfillmentContextIds` string[] — A collection of fulfillmentContextIds or fulfillmentContext aliases to use in the FulfillmentContextDetail search. - `originId` string — A shipiumOriginId or partnerOriginId to identify which originthe shipment will be processed at. - `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 - … - `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. - … - `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. - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - `testMode` boolean — Indicates that a testMode shipment will be created. Carrier selection will consider carriers and service methods in test mode and label generation will generate a test label. - `orderSourceName` string — Field that is used to determine source of order. This field may be utilized to inform carrier of the source of the order for handling. - `emergencyResponseInfo` EmergencyResponseInfo — Emergency Response Info Provider (ERIP) contact details for 24/7 emergency response. Used for hazmat shipments. If not provided, falls back to shipFrom contact info. - `phoneNumber` string — 24 Hour Emergency Phone Number. For US: 1 + area code + 7-digit number. For international: country code + area code + number. - `contactName` string — Emergency contact name or ERIP provider name. - `contractNumber` string — ERIP contract/account number. - `packages` MultiParcelShipmentPackageParameters[], required - `packageReferenceIdentifier` string, required — Used to correlate parcels to label documents from the carrier. - `partnerProvidedPackageId` string — Partner provided identifier for this package. - `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. - `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. - `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. - `deliveredDateTime` string, date-time — The timestamp for when the package was delivered to the customer. The timestamp must be a valid ISO 8601 timestamp. - `thirdPartyBillingAccounts` ThirdPartyBillingAccounts[] — Used to indicate the third-party billing account associated with the shipment. Each account is tied to a specific carrier and will only be used if the associated carrier is selected for label creation. If a selected carrier does not have a corresponding third-party billing account in this list and lacks a configuration in the fulfillment context, third-party billing will not be applied for that label. Conversely, if a third-party billing configuration exists in the fulfillment context and this value is provided, the value specified here will take precedence over the configured value. - `carrierId` string, required — Internal carrier account id as represented in Shipium. - `thirdPartyBillingCredentials` ThirdPartyBillingCredentials, required — Partner Credentials for this account used to connect to carrier APIs. - `accountNumber` string - `countryCode` string - `postalCode` string - `billThirdPartyForShippingCost` boolean — Describes whether the third party should be billed for the cost of shipping the package - `billThirdPartyDutiesAndTaxes` boolean — Describes whether the third party should be billed for duties and taxes - `collectBilling` CarrierCollectBilling — Describes the details for a shipment having billing term as Collect. - `accountNumber` string — The payor's account number used for collect billing. - `collectBillingAddress` 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. - `configurationOverrides` ConfigurationOverrides - `maximumAdditionalDaysToHold` integer — Configuration used to define maximum additional days to hold a package - `labelToDockDoorHours` number, float — The estimated time between a label being printed and the shipment reaching the dock door. To be used in the effectiveShipDate calculation. - `payorAccounts` PayorAccounts[] — Represents the list of payor accounts associated with the shipment Each account corresponds to a specific carrier and is used to determine the entity responsible for shipping charges when billing terms require a designated payor. If a selected carrier does not have a corresponding payor account in this list,standard billing configurations will apply. - `accountType` 'consignee' | 'collect' | 'third_party' | 'recipient' | 'sender', required — Type of account used for billing. Possible values: 'recipient', 'third_party', 'sender'. - `carrierId` string — Internal carrier account ID as represented in Shipium. Required only for 'collect' and 'third_party' payer types. - `payorAccountCredentials` PayorAccountCredentials, required — Partner credentials for this account used to authenticate and connect to carrier APIs. - `accountNumber` string - `accountCountryCode` string - `accountPostalCode` string - `payorAccountAddress` 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. - `registrationInformation` RegistrationInformation — Billing registration information associated with the payor account. - `typeCode` 'VAT' | 'EIN' | 'GST' | 'SSN' | 'EOR' | 'DUN' | 'FED' | 'STA' | 'CNP' | 'IE' | 'INN' | 'KPP' | 'OGR' | 'OKP' | 'MRN' | 'SDT' | 'FTZ' | 'DAN' | 'TAN' | 'DTF' | 'RGP' | 'DLI' | 'NID' | 'PAS' | 'MID' | 'IMS' | 'EIC' - `registrationNumber` string - `issuerCountryCode` string - `additionalCarrierSpecificInformation` AdditionalCarrierSpecificInformation — Credentials associated with the payor account. - `usps` UspsInformation — USPS-specific additional carrier information. - `customerRegistrationId` string — Customer Registration ID (CRID) assigned by USPS. - `mailerId` string — Mailer ID (MID) associated with your USPS account. - `manifest` string — Mailer ID used specifically for manifesting shipments. - `permitNumber` string — USPS postage permit number. - `permitPostalCode` string — PostalCode for international consistency. - `billForShippingCost` boolean — Indicates whether the payor should be billed for the cost of shipping the package. - `billDutiesAndTaxes` boolean — Indicates whether the third party should be billed for duties and taxes. - `endorsementType` 'AddressServiceRequested' | 'ForwardingServiceRequested' | 'ChangeServiceRequested' | 'ReturnServiceRequested' | 'CarrierLeaveIfNoResponse' — AddressServiceRequested, ForwardingServiceRequested, ChangeServiceRequested, ReturnServiceRequested, CarrierLeaveIfNoResponse - `useShipFromAddressInRequest` boolean — Describes whether or not to use the shipFromAddress in the request (instead of the address which is configured on the origin. - `documentGenerationRequests` DocumentGenerationRequest[] — A list of document generation requests. Each entry references a document blueprint by its Shipium ID or partner-provided alias. When present, the system will generate the requested documents and include them in the response. - `documentBlueprintId` string — The document blueprint ID. Accepts either a Shipium-generated UUID or a partner-provided alias (e.g., "bootBarnPackSlip"). - `shipmentParameters` ShipmentParameters — Request parameters used to create a shipment (not as part of the megaMethod flow). - `partnerShipmentId` string — An optional unique identifier that may be used for this shipment. - `orderedDateTime` string, date-time — The timestamp for when customer placed an order for this product. The timestamp must be a valid ISO 8601 timestamp. - `shippedDateTime` string, date-time — The timestamp for when you (or your fulfillment partner) shipped the product from your (or their) warehouse. The timestamp must be a valid ISO 8601 timestamp. - `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 - `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. - `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. - `businessDaysOfTransit` integer — Indicates the number of business days from the ship time by when the shipment needs to be delivered. - `includePackagesArray` boolean — Forces the packages array to be populated for all non multi parcel shipments. - `ignoreUpgradeSpendLimits` boolean — Indicates that this shipment can ignore all the partner-configured upgrade limits for the potential upgrade required to deliver the shipment by the desired delivery date. - `deliveredDateTime` string, date-time — The timestamp for when the package was delivered to the customer. The timestamp must be a valid ISO 8601 timestamp. - `carrierName` string — The carrier that was used for delivering the package to your customer. - `carrierTrackingId` string — Carrier's tracking identification for the package. - `orderItemQuantities` OrderItem[] — 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. - `shipFromAddress` 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. - `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. - `returnToAddress` 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. - `shipOption` string — A high-level shipping option shown to or selected by a customer. - `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. - `shipmentTags` string[] — A collection of free-form tags that may be added to this shipment. - `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 - … - `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. - … - `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. - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - `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. - `saturdayDelivery` boolean — Indicates that this shipment is marked for Saturday delivery. Does not guarantee delivery on Saturday - `deliverySignatureOption` 'None' | 'Signature' | 'ResidentSignature' | 'AdultSignature' | 'AdultResidentSignature' | 'Unknown' — The delivery Signature Option to be passed on to the carrier. Defaults to none. - `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' - `pickupWindow` 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 - `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 - `originId` string — A shipiumOriginId or partnerOriginId to identify which originthe shipment will be processed at. - `deliveryNote` string — A string passed to carriers for a delivery note. - `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. - `purchaseOrderIdentifier` string — String passed to carriers as a purchase order identifier. - `carrierProcessingId` string — Carrier-provided identifier, supplied when it is needed to process the shipment. - `fulfillmentContext` string — When present, this is used to limit carrier selection to carrier accounts that contain a matching fulfillmentContext - `fulfillmentType` 'customer' | 'at_large' | 'returns' | 'hundredweight' | 'reship' | 'unknown' — Fulfillment methodology of the shipment. - `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. - `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 - `fulfillmentContextIds` string[] — A collection of fulfillmentContextIds or fulfillmentContext aliases to use in the FulfillmentContextDetail search. - `orderSourceName` string — Field that is used to determine source of order. This field may be utilized to inform carrier of the source of the order for handling. - `testMode` boolean — Indicates that a testMode shipment will be created. Carrier selection will consider carriers and service methods in test mode and label generation will generate a test label. - `thirdPartyBillingAccounts` ThirdPartyBillingAccounts[] — Used to indicate the third-party billing account associated with the shipment. Each account is tied to a specific carrier and will only be used if the associated carrier is selected for label creation. If a selected carrier does not have a corresponding third-party billing account in this list and lacks a configuration in the fulfillment context, third-party billing will not be applied for that label. Conversely, if a third-party billing configuration exists in the fulfillment context and this value is provided, the value specified here will take precedence over the configured value. - `carrierId` string, required — Internal carrier account id as represented in Shipium. - `thirdPartyBillingCredentials` ThirdPartyBillingCredentials, required — Partner Credentials for this account used to connect to carrier APIs. - `accountNumber` string - `countryCode` string - `postalCode` string - `billThirdPartyForShippingCost` boolean — Describes whether the third party should be billed for the cost of shipping the package - `billThirdPartyDutiesAndTaxes` boolean — Describes whether the third party should be billed for duties and taxes - `collectBilling` CarrierCollectBilling — Describes the details for a shipment having billing term as Collect. - `accountNumber` string — The payor's account number used for collect billing. - `collectBillingAddress` 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. - `configurationOverrides` ConfigurationOverrides - `maximumAdditionalDaysToHold` integer — Configuration used to define maximum additional days to hold a package - `labelToDockDoorHours` number, float — The estimated time between a label being printed and the shipment reaching the dock door. To be used in the effectiveShipDate calculation. - `payorAccounts` PayorAccounts[] — Represents the list of payor accounts associated with the shipment Each account corresponds to a specific carrier and is used to determine the entity responsible for shipping charges when billing terms require a designated payor. If a selected carrier does not have a corresponding payor account in this list,standard billing configurations will apply. - `accountType` 'consignee' | 'collect' | 'third_party' | 'recipient' | 'sender', required — Type of account used for billing. Possible values: 'recipient', 'third_party', 'sender'. - `carrierId` string — Internal carrier account ID as represented in Shipium. Required only for 'collect' and 'third_party' payer types. - `payorAccountCredentials` PayorAccountCredentials, required — Partner credentials for this account used to authenticate and connect to carrier APIs. - `accountNumber` string - `accountCountryCode` string - `accountPostalCode` string - `payorAccountAddress` 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. - `registrationInformation` RegistrationInformation — Billing registration information associated with the payor account. - `typeCode` 'VAT' | 'EIN' | 'GST' | 'SSN' | 'EOR' | 'DUN' | 'FED' | 'STA' | 'CNP' | 'IE' | 'INN' | 'KPP' | 'OGR' | 'OKP' | 'MRN' | 'SDT' | 'FTZ' | 'DAN' | 'TAN' | 'DTF' | 'RGP' | 'DLI' | 'NID' | 'PAS' | 'MID' | 'IMS' | 'EIC' - `registrationNumber` string - `issuerCountryCode` string - `additionalCarrierSpecificInformation` AdditionalCarrierSpecificInformation — Credentials associated with the payor account. - `usps` UspsInformation — USPS-specific additional carrier information. - `customerRegistrationId` string — Customer Registration ID (CRID) assigned by USPS. - `mailerId` string — Mailer ID (MID) associated with your USPS account. - `manifest` string — Mailer ID used specifically for manifesting shipments. - `permitNumber` string — USPS postage permit number. - `permitPostalCode` string — PostalCode for international consistency. - `billForShippingCost` boolean — Indicates whether the payor should be billed for the cost of shipping the package. - `billDutiesAndTaxes` boolean — Indicates whether the third party should be billed for duties and taxes. - `packageReferenceIdentifier` string — Used to correlate parcels to label documents from the carrier. - `endorsementType` 'AddressServiceRequested' | 'ForwardingServiceRequested' | 'ChangeServiceRequested' | 'ReturnServiceRequested' | 'CarrierLeaveIfNoResponse' — AddressServiceRequested, ForwardingServiceRequested, ChangeServiceRequested, ReturnServiceRequested, CarrierLeaveIfNoResponse - `useShipFromAddressInRequest` boolean — Describes whether or not to use the shipFromAddress in the request (instead of the address which is configured on the origin. - `emergencyResponseInfo` EmergencyResponseInfo — Emergency Response Info Provider (ERIP) contact details for 24/7 emergency response. Used for hazmat shipments. If not provided, falls back to shipFrom contact info. - `phoneNumber` string — 24 Hour Emergency Phone Number. For US: 1 + area code + 7-digit number. For international: country code + area code + number. - `contactName` string — Emergency contact name or ERIP provider name. - `contractNumber` string — ERIP contract/account number. - `documentGenerationRequests` DocumentGenerationRequest[] — A list of document generation requests. Each entry references a document blueprint by its Shipium ID or partner-provided alias. When present, the system will generate the requested documents and include them in the response. - `documentBlueprintId` string — The document blueprint ID. Accepts either a Shipium-generated UUID or a partner-provided alias (e.g., "bootBarnPackSlip"). - `createUsingExistingShipment` CreateUsingExistingShipment — Used to reference an existing shipment; mutually exclusive with shipmentParameters and multiParcelShipmentParameters. Pass in a partnerShipmentId or shipiumShipmentId and we will look to see if the shipment exists. If both are supplied and point to the same shipment then we will continue on. If both are supplied and are not referencing the same shipment we will throw and error. - `partnerShipmentId` string — An optional unique identifier that may be used for this shipment. - `shipiumShipmentId` string — The Shipium generated unique identifier for a shipment. - `createUsingExistingOrder` CreateUsingExistingOrder — Used to reference an existing order; fields required to complete the shipment should be passed in shipmentParameters. Pass in a partnerOrderId or shipiumOrderIand we will look to see if the shipment exists. If both are supplied and point to the same shipment then we will continue on. If both are supplied and are not referencing the same shipment we will throw and error. - `partnerOrderId` string — An optional unique identifier that may be used for this order. - `shipiumOrderId` string — The Shipium generated unique identifier for an order. - `orderIdForLookup` string - `generateLabel` boolean — When "true" a request to the selected carrier will be sent to generate a label for the shipment based on the information provided in the "labelParameters" field of this object. When "false"this step is skipped and the system will record what carrier service method would have generated a label for. - `includeEvaluatedServiceMethodsInResponse` boolean — When "true" a request will expand information on the response to include unselected service methods that made it through filtering. - `includeLineItemsInEvaluatedServiceMethods` boolean — When "true" a response will include line item information for the returned evaluated service methods, provided that includeEvaluatedServiceMethodsInResponse is also set to true. - `labelParameters` CarrierLabelCreate — Information on the types of labels to be generated by the carrier, as will as if a manifest for the shipment is generated. This field is ignored if the "generateLabel" field is set to "false". - `currencyCode` string — Currency in which all the rates for shipping carrier selection costs will be calculated in. - `labelFormats` string[] — List of formats to generate the package label in. Supported formats are pdf, png, zpl, and printerless. - `printerlessParameters` PrinterlessLabelParameters — If one of the labelFormats is "printerless", these parameters are required. - `type` string — Type of printerless label to generate. Supported types: qrcode. Default is qrcode. - `imageFormat` string — Image format for the printerless label. Currently only jpeg is supported. Default is jpeg. - `includeLabelImagesInResponse` boolean — When "true" the response will include the raw image data of the labels that were requested to be generated by the carrier. - `customLabelEntries` object — List of formats to generate the package label in. - `testMode` boolean — When true, calls to generate the labels will be made to the carrier sandbox servers. No actual labels are created, only a representation of the label. No money is charged to the underlying account either. If this value is null, it will inherit from the Shipment. A non-testMode label cannot be combined with a testMode Shipment. - `eligibleForManifest` boolean — When true, or null, this label will be included in end-of-day and scheduled manifests. False indicates that the label should not be included in any manifests. - `contentDescription` string — A short description (under 35 characters) of the package contents being returned that is passed on to the carrier. Required for returns shipments only. - `holdAtLocation` HoldAtLocation — Use HoldAtLocation to indicate the package should be held at a carrier location for pickup. - `holdAtLocationId` string - `useHoldAtLocation` boolean - `carrierServiceMethodAllowList` string[] — A list of carrierServiceMethodId and/or carriers that should be considered for selection. - `ignoreRuleSets` boolean — When "true", rule sets will be ignored during carrier selection. - `includeInjectionProfiles` boolean — When "true", service methods from the configured InjectionProfiles will be considered during carrier selection. - `injectionParameters` InjectionParameter[] — A list of Injection Profiles and/or Injection Profile/Site tuples that should be considered during carrier selection. If an InjectionSite is specified, it must be accompanied by an InjectionProfile. - `injectionProfileId` string — The shipium ID or the partner-provided ID of an InjectionProfile that should be considered during carrier selection. - `injectionSiteId` string — The shipium ID or the partner-provided ID of an InjectionSite that should be considered during carrier selection. If an injectionSiteId is specified, it must be accompanied by an injectionProfileId - `inlineReturnsLabel` ReturnLabelCreate — Details of the shipment to be returned and its corresponding destination addresses, contact and fulfillmentContext details. - `partnerShipmentId` string — An optional unique identifier that may be used for this shipment. - `returnToAddress` 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. - `returnToContactInfo` Contact — The Contact to use as the return-to contact the package is being returned. - `contactName` string — Name of the contact. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Optional country code for the phone number of the contact. - `email` string — Email address of the contact. - `fulfillmentContext` string — When present, this is used to limit carrier selection to carrier accounts that contain a matching fulfillmentContext for the returns. - `inlineReturnReferenceIdentifier` string — String passed to carriers as a reference. - `inlineReturnReferenceIdentifier2` string — String passed to carriers as a reference2. - `inlineReturnReferenceIdentifier3` string — String passed to carriers as a reference3. - `inlineReturnReferenceIdentifier4` string — String passed to carriers as a reference4. - `inlineReturnReferenceIdentifier5` string — String passed to carriers as a reference5. - `inlineReturnPartnerReferenceIdentifier` string — Partner custom reference to a return label. - `inlineReturnPartnerReferenceIdentifier2` string — Partner custom reference to a return label. - `saturdayDelivery` boolean — Indicates that this inline return is marked for Saturday delivery. Does not guarantee delivery on Saturday - `customerForwardLabels` CustomerForwardLabelCreate[] — List of forward shipments originating from the customer. Each entry contains details about the individual package - `partnerShipmentId` string, required — A unique identifier for this forward shipment. - `fulfillmentContext` string — When present, this is used to limit carrier selection to fulfillment contexts that contain a matching fulfillmentContext. - `fulfillmentContextId` string — When present, this is used to identify the fulfillment context which should be used for this request. - `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 - `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. - `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. - `packagingType` PackagingTypeParameters, required — 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. - `labelParameters` CarrierLabelCreate, required — Information on the types of labels to be generated by the carrier, as will as if a manifest for the shipment is generated. This field is ignored if the "generateLabel" field is set to "false". - `currencyCode` string — Currency in which all the rates for shipping carrier selection costs will be calculated in. - `labelFormats` string[] — List of formats to generate the package label in. Supported formats are pdf, png, zpl, and printerless. - `printerlessParameters` PrinterlessLabelParameters — If one of the labelFormats is "printerless", these parameters are required. - `type` string — Type of printerless label to generate. Supported types: qrcode. Default is qrcode. - `imageFormat` string — Image format for the printerless label. Currently only jpeg is supported. Default is jpeg. - `includeLabelImagesInResponse` boolean — When "true" the response will include the raw image data of the labels that were requested to be generated by the carrier. - `customLabelEntries` object — List of formats to generate the package label in. - `testMode` boolean — When true, calls to generate the labels will be made to the carrier sandbox servers. No actual labels are created, only a representation of the label. No money is charged to the underlying account either. If this value is null, it will inherit from the Shipment. A non-testMode label cannot be combined with a testMode Shipment. - `eligibleForManifest` boolean — When true, or null, this label will be included in end-of-day and scheduled manifests. False indicates that the label should not be included in any manifests. - `contentDescription` string — A short description (under 35 characters) of the package contents being returned that is passed on to the carrier. Required for returns shipments only. - `holdAtLocation` HoldAtLocation — Use HoldAtLocation to indicate the package should be held at a carrier location for pickup. - `holdAtLocationId` string - `useHoldAtLocation` boolean - `totalWeight` Weight, required — 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. - `orderItemQuantities` OrderItem[] — 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. - `generateLabel` boolean — When "true" a request to the selected carrier will be sent to generate a label for the shipment based on the information provided in the "labelParameters" field of this object. When "false"this step is skipped and the system will record what carrier service method would have generated a label for. - `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. - `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 - … - `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. - … - `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. - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - … - `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 - `ignoreCarrierMinimumDimensions` boolean — When "true", the minimum dimensions of carriers will effectively be ignored when deciding if a carrier service method is eligible to be considered during carrier selection. - `options` BulkLabelRequestOptions - `tenantId` string — The default tenantId to be specified across all requests. If this is specified on the individual request's shipmentParamaeters payload, that value will be used instead for that shipment. - `fulfillmentContext` string — The default fulfillmentContext to be specified across all requests. If this is specified on the individual request's shipmentParamaeters payload, that value will be used instead for that shipment. - `currencyCode` string — The default currency in which all the rates for shipping carrier selection costs will be calculated in. If this is specified on an individual shipment request, that value will be used instead for that shipment. - `includeFullShipmentResponses` boolean — Whether to return the full ShipmentResponse from the MegaShipmentCreateProcess. If not specified, will not return the full payload by default. ## Response `200` The orchestrated results of the bulk request. - OrchestratedAssetBatchResults - `orchestratedAssetMetadata` OrchestratedAssetMetadata — If the asset is the top level asset being orchestrated, this will provide a reference for the instance being built. - `orchestrationId` string - `orchestrationTimeStamp` string, date-time - `orchestrationLedger` OrchestrationLedger — Optionally included ledger for the orchestration which is saved on the Orchestration. - `generatedAssets` object - `resultIds` string[] - `log` string[] - `results` object[] — Successful results from processing. - `failures` object[] — Any failures resulting from processing. ## 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)