--- title: "Retrieve the costs for a shipment using either LTL or parcel shipping." method: POST path: "/api/v1/ltl/shipment/costCompare" tags: ["ltl-shipment-cost"] --- # Retrieve the costs for a shipment using either LTL or parcel shipping. `POST /api/v1/ltl/shipment/costCompare` ## Headers - `X-DELEGATED-PARTNER-ID` string ## Request body - LtlCostCompareRequest - `businessDaysOfTransit` integer — Indicates the number of business days from the ship time by when the shipment needs to be delivered. - `currencyCode` string — ISO-4217 currency code in which all the rates for shipping will be calculated and returned. This will override the value configured in the root level `units` object. If the root level `units` object is not provided, this field will be required. - `desiredDeliveryDate` string — The string representation of either an ISO-8601 date or a LocalDate: yyyy-mm-dd. The date or datetime the package is intended to arrive to the customer. This will be used to determine the most appropriate service method when generating a label - `desiredDeliveryDateOptions` DesiredDeliveryDateOptions — Options for how the system will use the desiredDeliveryDate - `exactDateDelivery` boolean — This will restrict carrier selection to only use service methods that we have a high chance of making it there on time. - `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. - `existingShipmentIds` string[] — The Shipium or partner shipment IDs that should be included in this LTL shipment. These must be IDs for shipments created using the `/api/v1/deliveryexperience/shipment` endpoint, or an equivalent endpoint. These cannot be LTL shipments, must have `nmfcFreightClass` configured, and must have the same ship from and destination addresses as this LTL shipment. This can be used in conjunction with `shipments` and/or `packedShipments`. At least one of `existingShipmentIds`, `shipments`, and `packedShipments` must not be empty or null. - `includeEvaluatedServiceMethodsInResponse` boolean — When "true" a request will expand information on the response to include unselected carriers and 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. - `ltlShipmentParameters` LtlShipmentParameters, required — Request parameters that informed LTL costing and carrier selection. - `billToContact` LtlBillToContact — Whom should be billed for the LTL shipment. By default, the carrier contracts in the fulfillment context will be used for billing. - `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. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `city` string — The name of the city for the address. - `company` string — The company name for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `emailAddress` string — Email address of the contact. - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `state` string — The name of the state for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `thirdPartyBillingSetId` string, required — Either the Shipium-generated or the partner-provided third party billing set ID. Used to look up the account number each LTL carrier uses to determine pricing agreement. - `carrierServiceMethodAllowList` string[] — A list of carrierServiceMethodIds, and/or SCAC codes, and/or carriers that should be considered for LTL carrier selection. - `collectOnDelivery` CurrencyAmount — The amount that should be paid by the recipient upon delivery of the package. - `amount` number, float, required — The amount of money. - `currency` string — The ISO-4217 currency code that the amount is in. This is required unless a default currency unit is supplied elsewhere. If this and a default are both supplied, this will take priority. - `fulfillmentContextIds` string[] — A collection of Shipium generated IDs or partner provided aliases for the fulfillment context that are eligible to be used for LTL carrier selection.There must be exactly one fulfillment context that can ship from the origin to the destination, for the specified tenant, regardless of whether or not this list is populated. - `originId` string — A shipiumOriginId or partnerOriginId to identify which originthe shipment will be processed at. - `fulfillmentType` 'customer' | 'at_large' | 'returns' | 'hundredweight' | 'reship' | 'unknown' — Fulfillment methodology of the shipment. - `hazmatContact` LtlHazmatContact — Who the carrier should contact if they have a question regarding hazmat in the shipment. If this is not supplied, and their are hazardous materials in the shipment, the contact information in either the `shipFromAddress`, or the Fulfillment Context's Origin, will be used for this purpose. - `contactName` string, required — Name of the contact. - `phoneNumber` string, required — Phone number of the contact. - `phoneNumberCountryCode` string — Optional country code for the phone number of the contact. - `email` string — Email address of the contact. - `packagingOptions` LoadPackagingDetailsRequest[] — How the LTL shipment can be packaged. This is required if there are any existingShipmentIds or shipments in the LtlCostRequest. - `loadPackagingType` 'loose' | 'overboxed' | 'piece' | 'wrapped' | 'pallet' — How the parcels in the load will be packaged together. - `loadPackagingSize` LoadPackagingSizeRequest, required — Dimensions for packaging containing the parcels, used to estimate how parcels could be packed together. - `height` number, float, required — The maximum height that parcels can be stacked within the packaging. - `length` number, float, required — The longer horizontal dimension that parcels can occupy within the packaging. - `linearUnit` 'in' | 'cm' — The unit of measure for linear dimensions (length, width, height). This will override the value configured in the root level `units` object. If the root level `units` object is not provided, this field will be required. - `maximumWeight` number, float — The maximum weight of parcels within the packaging. If not specified, no maximum weight will be used when determining how to pack parcels. - `packagingWeight` number, float — The weight of the packaging without any parcels. - `weightUnit` 'g' | 'kg' | 'oz' | 'lb' — The unit of measure for maximum weight of parcels within the packaging, and the packaging itself. This will override the value configured in the root level `units` object. If the root level `units` object is not provided, this field will be required. - `width` number, float, required — The shorter horizontal dimension that parcels can occupy within the packaging. - `paymentDetails` LtlPaymentDetails, required — How the LTL shipment will be paid for. - `payerType` 'consignee' | 'shipper' | 'thirdParty', required — Who is paying the carrier to deliver the shipment. - `paymentTerms` 'collect' | 'prePaid' | 'thirdParty', required — How the shipment is being paid for. - `pickupDate` string, date, required — Date when LTL shipment will be picked up by the carrier. - `pricingTypes` string[] — The pricing types that should be eligible for LTL carrier selection. - `serviceLevels` string[] — The time-definite delivery options that should be eligible for LTL carrier selection. - `accessorialCodes` string[] — A list of codes representing the accessorial codes applicable for the shipment. - `packedShipments` LoadPackagingDetails[] — The already packed LTL shipments that should be included in this LTL shipment. Items in this list will only be used for LTL costing and will not have their packaging modified, nor be eligible for parcel carrier selection. Items in this list do not require corresponding Shipium shipments, nor will they create shipments. This can be used in conjunction with `existingShipmentIds` and/or `shipments`. At least one of `existingShipmentIds`, `shipments`, and `packedShipments` must not be empty or null. - `declaredValue` CurrencyAmount — The amount that should be paid by the recipient upon delivery of the package. - `amount` number, float, required — The amount of money. - `currency` string — The ISO-4217 currency code that the amount is in. This is required unless a default currency unit is supplied elsewhere. If this and a default are both supplied, this will take priority. - `loadPackagingType` 'loose' | 'overboxed' | 'piece' | 'wrapped' | 'pallet' — How the parcels in the load are packaged together. - `loadPackagingSize` LoadPackagingSize, required — Dimensions for packaging containing the parcels. - `height` number, float, required — The height that parcels are stacked within the packaging. - `length` number, float, required — The longer horizontal dimension that parcels occupy within the packaging. - `linearUnit` 'in' | 'cm' — The unit of measure for linear dimensions (length, width, height). This will override the value configured in the root level `units` object. If the root level `units` object is not provided, this field will be required. - `weight` number, float, required — The total weight of parcels within the packaging. - `weightUnit` 'g' | 'kg' | 'oz' | 'lb' — The unit of measure for weight of parcels within the packaging. This will override the value configured in the root level `units` object. If the root level `units` object is not provided, this field will be required. - `width` number, float, required — The shorter horizontal dimension that parcels occupy within the packaging. - `nmfcFreightClass` string, required — A string representing the broad class of products being shipped in this load. This should be the largest (i.e. 51 > 50) NMFC class of any of the products in the load. For example, both bricks and steel pipes have a NMFC class of `50` - `partnerLtlCostId` string — An optional unique identifier that may be used for this LTL cost. - `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. - `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. - `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. - `shipments` LtlShipmentItem[] — The shipments that should be included in this LTL shipment. This can be used in conjunction with `existingShipmentIds` and/or `packedShipments`. At least one of `existingShipmentIds`, `shipments`, and `packedShipments` must not be empty or null. - `carrierProcessingId` string — Carrier-provided identifier, supplied when it is needed to process the shipment. - `deliveryNote` string — A string passed to carriers for a delivery note. - `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. - `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. - `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 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `ultimateConsigneeAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `ultimateConsigneeType` 'direct_consumer' | 'government_entity' | 'reseller' | 'unknown' — The type of the ultimate consignee - `aesInternalTransactionNumber` string — The number received if the Electronic Export Information (EEI) was filed and has been accepted in the Automated Export System (AES) - `electronicExportInformation` ElectronicExportInformation — Information for the Electronic Export Information (EEI) customs form, only used when the EEI will be filed directly by the carrier (i.e. not filed by the partner using AES Direct or otherwise) - `exportDate` string, date — The date the goods will be exiting the country - `pointOfOrigin` string — The 2-character state abbreviation from which the goods were shipped to the port of export. - `b13AFilingOption` 'NOT_REQUIRED' | 'MANUALLY_ATTACHED' | 'FILED_ELECTRONICALLY' | 'SUMMARY_REPORTING' | 'CARRIER_TO_STAMP' | 'UNKNOWN' — Specify the filing option being exercised. Required for non-document shipments originating in Canada destinated for any country other than Canada, the United States, Puerto Rico, or the U.S. Virgin Islands. - `exportComplianceStatement` string — For US export shipments requiring an EEI, enter the ITN number received from AES when you filed your shipment or the FTR (Foreign Trade Regulations) exemption number. The proper format for an ITN number is AES XYYYYMMDDNNNNNN where YYYYMMDD is date and NNNNNN are numbers generated by the AES. Example: AESX20220714987654 Note: The ITN or FTR exemption number you submit in the ship request prints on the international shipping label. For CA export shipments, it can be Proof of report number(15-32 alphanumeric), Summary proof of report number(7-32 alphanumeric) or Exemption number(2 digit) based on the selected b13AFilingOption. Example: 98765432107654321(POR number), 7654321(Summary POR number) and 02(Exemption number). For FTR exemption number you need provide a predefined value as NO_EEI_30_37_A. - `permitNumber` string — This is a Permit Number. This field is applicable only to Canada export non-document shipments of any value to any destination. No special characters are allowed. - `customsItems` CustomsItemData[] — Contains customs information for each item in the shipment. - `customsValue` number, float — The value of each individual item to report to customs in customsValueCurrency - `customsValueCurrency` string — The ISO-4217 currency code representing the customsValue - `commodityDescription` string — A description of this product to be provided to customs - `countryOfManufacture` string — The ISO-3166 2 digit country code that manufactured the this product - `customsWeight` Weight — The weight of this type of packaging empty. - `weightUnit` 'g' | 'kg' | 'oz' | 'lb' — The unit that weight values are provided in. g for grams kg for kilograms oz for ounces lb for pounds - `weight` number, float — The value of the weight. - `quantity` integer — The number of units of this customs item - `productId` string — The merchant's product identifier (SKU) for this customs item. - `standardizedProductIds` StandardizedProductId[] — Standardized product identifiers (GTIN/EAN/UPC/ISBN) for this customs item. - `type` 'GTIN' | 'EAN' | 'UPC' | 'ISBN' | 'unknown' — The standard that a standardized product identifier conforms to (e.g. a barcode standard). - `value` string — The standardized product identifier value. - `manufacturerProductId` string — The manufacturer's non-standardised product identifier (EU C128) for this customs item — a free-form code assigned by the manufacturer or brand (e.g. internal SKU / part number). Distinct from the merchant productId and the standardized barcodes. - `quantityUnitOfMeasurement` 'bag' | 'barrel' | 'box' | 'case_of_goods' | 'container' | 'crate' | 'cylinder' | 'envelope' | 'pallet' | 'piece' | 'roll' | 'tube' | 'unknown' — The unit of measurement of the item - `harmonizedTariffNumber` string — The 6-15 digit Harmonized System Tariff classification code - `commodityPartNumber` string — The part number or reference number for the product - `marksAndNumbers` string — Any special marks, codes, and numbers that may identify the package - `electronicExportCommodityInformation` ElectronicExportCommodityInformation — Customs item information that is particular to the Electronic Export Information (EEI) - `exportType` 'domestic' | 'foreign' | 'unknown', required — The type of the export. - `exportInformationCode` string, required — The 2-digit export information code for the commodity. - `scheduleBInformation` ScheduleBInformation, required — The Schedule B information for the commodity. - `scheduleBNumber` string, required — The 10-digit Schedule B classification code for the item being exported - `scheduleBQuantity` integer, required — The count of how many Schedule B units are in the shipment - `scheduleBUnitOfMeasurement` 'barrels' | 'carat' | 'content_kilogram' | 'square_centimeter' | 'content_ton' | 'curie' | 'clean_yield_kilogram' | 'dozen' | 'dozen_pieces' | 'dozen_pairs' | 'fiber_meter' | 'gross_container' | 'gram' | 'gross' | 'hundred' | 'kilogram' | 'cubic_kilometer' | 'kilogram_total_sugars' | 'liter' | 'meter' | 'square_meter' | 'cubic_meter' | 'millicurie' | 'number' | 'pieces' | 'proof_liter' | 'pack' | 'pairs' | 'running_bales' | 'square' | 'ton' | 'thousand' | 'no_quantity_required' | 'unknown', required — The unit of measure for the Schedule B quantity - `eccnNumber` string, required — The 5-digit product ECCN number as issued by the Bureau of Industry and Security. The format is #A###. - `exportLicenseInformation` ExportLicenseInformation, required — The license information for the export. - `licenseType` string, required — The standard license type code as published by the US government. - `licenseExemptionCode` string — The license exemption code, if the license type does not require a license number. - `exportLicense` ExportLicense — The export license, if the license type requires a valid license. - … - `b13AFilingOption` 'NOT_REQUIRED' | 'MANUALLY_ATTACHED' | 'FILED_ELECTRONICALLY' | 'SUMMARY_REPORTING' | 'CARRIER_TO_STAMP' | 'UNKNOWN' — Specify the filing option being exercised. Required for non-document shipments originating in Canada destinated for any country other than Canada, the United States, Puerto Rico, or the U.S. Virgin Islands. - `exportComplianceStatement` string — For US export shipments requiring an EEI, enter the ITN number received from AES when you filed your shipment or the FTR (Foreign Trade Regulations) exemption number. The proper format for an ITN number is AES XYYYYMMDDNNNNNN where YYYYMMDD is date and NNNNNN are numbers generated by the AES. Example: AESX20220714987654 Note: The ITN or FTR exemption number you submit in the ship request prints on the international shipping label. For CA export shipments, it can be Proof of report number(15-32 alphanumeric), Summary proof of report number(7-32 alphanumeric) or Exemption number(2 digit) based on the selected b13AFilingOption. Example: 98765432107654321(POR number), 7654321(Summary POR number) and 02(Exemption number). For FTR exemption number you need provide a predefined value as NO_EEI_30_37_A. - `cpscCertificateOfCompliance` CpscCertificateOfCompliance — CPSC Certificate of Compliance data for US import of CPSC-regulated consumer products. Supports two filing modes: FULL (all certificate data inline) or REFERENCE (pointer to CPSC Product Registry). - `filingMode` 'FULL' | 'REFERENCE', required — CPSC Certificate of Compliance filing mode - `cpscProductId` string — CPSC product certification identifier — distinct from the SKU-level productId on CustomsItem or OrderItemQuantity (required for FULL mode) - `applicableCpscRules` string[] — CPSC rules or standards the product was tested against (required for FULL mode, e.g. "16 CFR 1219", "ASTM F2194") - `dateOfManufacture` string, date — Date the product was manufactured (required for FULL mode) - `manufacturerName` string — Name of the manufacturer (required for FULL mode) - `manufacturerAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - … - `lastComplianceTestingDate` string, date — Date of most recent compliance testing (required for FULL mode) - `testingLabName` string — Name of the accredited testing laboratory (required for FULL mode) - `testingLabAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - … - `testingLabContactInfo` string — Testing laboratory phone or email contact (required for FULL mode) - `importerRecordKeeperContact` string — Importer or record-keeper contact information (required for FULL mode) - `registryProductId` string — Product ID in the CPSC Product Registry (required for REFERENCE mode) - `registryVersionId` string — Version ID in the CPSC Product Registry (required for REFERENCE mode) - `registryCertifierId` string — Certifier ID in the CPSC Product Registry (required for REFERENCE mode) - `incoterm` 'DDP' | 'DDU' | 'DAP' | 'DPU' | 'FCA' | 'CPT' | 'FOB' | 'EXW' — Enum used to represent desired incoterm. - `declarationStatement` string — A customs declaration statement for the shipment that, if provided, will appear on generated commercial invoices. - `taxIdentificationNumber` string — The EIN tax identification number of the shipper - `importerOfRecord` ImporterOfRecord — Address details of the importer for customs purposes for the vast majority of Express import shipments - `importerAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `accountNumber` string — Account Number of importer - `taxIdentificationNumbers` RequestTaxIdentificationNumber[] — Tax Identification numbers of importer - `number` string — Tax Identification Number - `tinType` 'PERSONAL_NATIONAL' | 'PERSONAL_STATE' | 'FEDERAL' | 'BUSINESS_NATIONAL' | 'BUSINESS_STATE' | 'BUSINESS_UNION' — Type of Tax Identification Number - `brokers` Broker[] — Address details of the broker for customs purposes - `brokerAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `accountNumber` string — Account Number of the broker - `taxIdentificationNumbers` RequestTaxIdentificationNumber[] — Tax Identification numbers of broker - `number` string — Tax Identification Number - `tinType` 'PERSONAL_NATIONAL' | 'PERSONAL_STATE' | 'FEDERAL' | 'BUSINESS_NATIONAL' | 'BUSINESS_STATE' | 'BUSINESS_UNION' — Type of Tax Identification Number - `deliveryInstructions` string — Delivery Instructions of broker - `type` 'IMPORT' | 'EXPORT' — Type of the broker - `soldTo` SoldTo — Address details of the sold to party for customs purposes - `address` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `accountNumber` string — Account Number of the sold to party - `taxIdentificationNumbers` RequestTaxIdentificationNumber[] — Tax Identification numbers of the sold to party - `number` string — Tax Identification Number - `tinType` 'PERSONAL_NATIONAL' | 'PERSONAL_STATE' | 'FEDERAL' | 'BUSINESS_NATIONAL' | 'BUSINESS_STATE' | 'BUSINESS_UNION' — Type of Tax Identification Number - `orderedDateTime` string, date-time — The timestamp for when customer placed an order for this product. The timestamp must be a valid ISO 8601 timestamp. - `packages` MultiParcelShipmentPackageParameters[], required — The packages containing the items in this shipment - `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. - `partnerShipmentId` string — An optional unique identifier that may be used for this shipment. - `shipiumShipmentId` string — The Shipium-generated unique identifier for this shipment. - `tenantId` string — Either the Shipium tenant ID or the partner-provided tenant ID that the shipment is for. If this is not supplied, the shipment will be associated with the partner, and only partner-wide fulfillment contexts will be considered. - `testMode` boolean — Indicates that a testMode LTL cost and shipment will be created. LTL costing and parcel carrier selection will consider carriers and service methods in test mode, and label generation will generate a test label. - `units` Units — The units that all dimensions and currencies in the response are in, unless overridden in a narrower scope. If `units` was supplied in the request, this will use the same units. - `currencyCode` string, required — The ISO-4217 currency code that monetary amounts are represented in. - `linearUnit` 'in' | 'cm', required — The unit that linear dimensions are represented in. - `weightUnit` 'g' | 'kg' | 'oz' | 'lb', required — The unit that the weights are represented in. - `packageShipmentParameters` LtlParcelShipmentParameters — Request parameters that informed package shipments and carrier selection. Only present if these parameters were in the cost request. - `carrierServiceMethodAllowList` string[] — A list of carrierServiceMethodIds and/or carriers that should be considered for parcel carrier selection. - `deliverySignatureOption` 'None' | 'Signature' | 'ResidentSignature' | 'AdultSignature' | 'AdultResidentSignature' | 'Unknown' — Whether the recipient's signature should be required. - `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 - `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 Shipium generated IDs or partner provided aliases for the fulfillment context that are eligible to be used for parcel carrier selection.There must be exactly one fulfillment context that can ship from the origin to the destination, for the specified tenant, regardless of whether or not this list is populated. - `originId` string — A shipiumOriginId or partnerOriginId to identify which originthe shipment will be processed at. - `fulfillmentType` 'customer' | 'at_large' | 'returns' | 'hundredweight' | 'reship' | 'unknown' — Fulfillment methodology of the shipment. - `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. - `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. - `includeInjectionProfiles` boolean — When "true", service methods from the configured InjectionProfiles will be considered during carrier selection. - `injectionParameters` InjectionParameter[] — A list of Injection Profile and/or Injection Profile/Site tuples that should be considered during parcel 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 - `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 - `preferredCarrierDeliveryDateTime` string, date-time — The string representation of either an ISO-8601 date. The datetime the package is intended to arrive to the customer. This will be passed through to the carrier. - `saturdayDelivery` boolean — Indicates that this shipment is marked for Saturday delivery. Does not guarantee delivery on Saturday - `serviceMethodPoBoxAllowList` string[] — A list of serviceMethodIds that will be considered for USPS PO box delivery that otherwise would be filtered out as they don't support USPS PO box delivery for the shipment. - `shipOption` string — A high-level shipping option shown to or selected by a customer. This is only applicable when calculating the parcel carrier selection for this item. - `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. ## Response `200` The estimated cost of the LTL shipment with a comparison to using parcel shipping. - LtlCostResponse - `shipiumLtlCostId` string, required — Shipium-generated unique id of the LTL cost, for later lookup. - `partnerLtlCostId` string — An optional unique identifier that may be used for this LTL cost. - `partnerTenantId` string — The partner provided tenant ID. When present, this is used to indicate the tenant associated with the LTL shipment. - `shipiumTenantId` string — The shipium generated tenant ID. When present, this is used to indicate the tenant associated with the LTL shipment. - `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. - `shipFromTimeZoneId` string - `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. - `destinationTimeZoneId` string - `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. - `rawDesiredDeliveryDate` string — The timestamp passed in by you (or your fulfillment partner) for the intended date the package will arrive to the customer. The timestamp must be a valid ISO 8601 timestamp. - `recommendedTransportationType` 'ltlTransportation' | 'packageTransportation', required — Whether using LTL or parcel shipping will be less expensive, and able to meet the request parameters. - `recommendedTransportationTypeCost` number, float, required — The cost of using the recommended transportation type for this shipment. - `testMode` boolean, required — Indicates that a testMode LTL cost and shipment will be created. LTL costing and package carrier selection will consider carriers and service methods in test mode, and label generation will generate a test label. - `currencyCode` string — ISO-4217 currency code for all the rates for shipping. - `units` Units — The units that all dimensions and currencies in the response are in, unless overridden in a narrower scope. If `units` was supplied in the request, this will use the same units. - `currencyCode` string, required — The ISO-4217 currency code that monetary amounts are represented in. - `linearUnit` 'in' | 'cm', required — The unit that linear dimensions are represented in. - `weightUnit` 'g' | 'kg' | 'oz' | 'lb', required — The unit that the weights are represented in. - `allTransportationTypeCosts` LtlCostSummary[], required — The cost of all transportation types considered by costing. Sorted from least expensive to most expensive. - `transportationType` 'ltlTransportation' | 'packageTransportation', required — The transportation type used for this cost estimate. - `transportationTypeCost` number, float, required — The cost of using this transportation type for the shipment. {This will be zero if no carrier could be found for this shipment. - `ltlCostDetails` LtlCarrierSelection, required — The costing details of using LTL to transport this shipment. - `loadPackaging` LtlLoadPackagingRecommendation[], required — How the parcels in the LTL shipment are packaged or should be packaged. - `details` LoadPackagingDetails, required — The already packed LTL shipments that should be included in this LTL shipment. Items in this list are used for LTL costing and do not have their packaging modified, nor are eligible for package carrier selection. Items in this list do not have corresponding Shipium shipments. - `declaredValue` CurrencyAmount — The amount that should be paid by the recipient upon delivery of the package. - `amount` number, float, required — The amount of money. - `currency` string — The ISO-4217 currency code that the amount is in. This is required unless a default currency unit is supplied elsewhere. If this and a default are both supplied, this will take priority. - `loadPackagingType` 'loose' | 'overboxed' | 'piece' | 'wrapped' | 'pallet' — How the parcels in the load are packaged together. - `loadPackagingSize` LoadPackagingSize, required — Dimensions for packaging containing the parcels. - `height` number, float, required — The height that parcels are stacked within the packaging. - `length` number, float, required — The longer horizontal dimension that parcels occupy within the packaging. - `linearUnit` 'in' | 'cm' — The unit of measure for linear dimensions (length, width, height). This will override the value configured in the root level `units` object. If the root level `units` object is not provided, this field will be required. - `weight` number, float, required — The total weight of parcels within the packaging. - `weightUnit` 'g' | 'kg' | 'oz' | 'lb' — The unit of measure for weight of parcels within the packaging. This will override the value configured in the root level `units` object. If the root level `units` object is not provided, this field will be required. - `width` number, float, required — The shorter horizontal dimension that parcels occupy within the packaging. - `nmfcFreightClass` string, required — A string representing the broad class of products being shipped in this load. This should be the largest (i.e. 51 > 50) NMFC class of any of the products in the load. For example, both bricks and steel pipes have a NMFC class of `50` - `shipments` LtlLoadPackagingItem[] — The shipments that are included in this load. This will be empty or null if this corresponds to a item in `packedShipments` in the request. - `partnerShipmentId` string — An optional unique identifier that may be used for this shipment. - `shipiumShipmentId` string — The Shipium-generated unique identifier for this shipment. - `packageReferenceIdentifier` string — Used to differentiate parcels in a multiparcel shipment. Required when the shipment is multiparcel. - `evaluatedCarriers` LtlCarrierCost[] — Information about the other carriers considered, but rejected because they either: cannot meet the desired delivery date, cannot carry the shipment, cannot pick up the shipment on the requested date, or cost more than the selected carrier. Requires `includeEvaluatedServiceMethodsInResponse` to be true in the request. - `billableWeight` 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. - `billToThirdPartyId` string — Either the Shipium-generated or the partner-provided third party billing ID. Used to look up the account number each LTL carrier uses to determine pricing agreement. - `carrier` string, required — The carrier who provided this quote. - `carrierAccountId` string — Unique id of the carrier account used for this cost. - `carrierServiceMethodId` string, required — The carrier's service method that would be used for transporting the load in this quote. - `estimatedDeliveryDate` string, date-time — The carrier's estimate for when the load will be delivered. This will be missing if the carrier service method does not meet the request's requirements. - `lineItems` LtlRateLineItem[] — The components of the carrier's cost estimate. This will be missing or empty if the carrier service method does not meet the request's requirements, or the carrier does not return the costing details. Requires `includeLineItemsInEvaluatedServiceMethods` to be true in the request. - `name` string, required — The name of the rate modification - `rate` number, float, required — The amount of the rate modification - `carrierSurchargeId` string — The identifier for the carrier surcharge - `surchargeType` 'additional_handling_weight' | 'additional_handling_volume' | 'additional_handling_length' | 'additional_handling_extra_length' | 'additional_handling_width' | 'additional_handling_packaging' | 'alaska_delivery_commercial_air' | 'alaska_delivery_commercial_ground' | 'alaska_delivery_residential_air' | 'alaska_delivery_residential_ground' | 'base' | 'delivery_commercial_air' | 'delivery_commercial_ground' | 'delivery_residential_air' | 'delivery_residential_ground' | 'extended_delivery_commercial_air' | 'extended_delivery_commercial_ground' | 'extended_delivery_residential_air' | 'extended_delivery_residential_ground' | 'fuel_air_domestic' | 'fuel_air_international_export' | 'fuel_air_international_import' | 'fuel_ground' | 'hawaii_delivery_commercial_air' | 'hawaii_delivery_commercial_ground' | 'hawaii_delivery_residential_air' | 'hawaii_delivery_residential_ground' | 'hazmat' | 'incentive' | 'international_delivery_area' | 'international_extended_delivery_area' | 'large_package_commercial' | 'large_package_residential' | 'peak' | 'peak_additional_handling' | 'peak_residential_delivery_air' | 'peak_residential_delivery_ground' | 'peak_large_package' | 'remote_delivery_commercial_air' | 'remote_delivery_commercial_ground' | 'remote_delivery_residential_air' | 'remote_delivery_residential_ground' | 'residential_air' | 'residential_ground' | 'saturday_delivery' | 'signature' | 'signature_resident' | 'signature_adult' | 'signature_adult_resident' | 'surcharge' | 'zone_weight' — The type of surcharge for this item. Null value for non-surcharges - `lineItemType` string — The type of rate line item for this rate modification - `hiddenFromCarrierCompare` boolean — Indicates line item exclusion from the `carrierCompareCost`. - `hiddenFromInvoice` boolean — Indicates line item exclusion from the `carrierInvoiceCost`. - `hiddenFromOperational` boolean — Indicates line item exclusion in the `operationalCost`. - `nmfcFreightClass` string — For LTL container line items, a string representing the most costly class of product being shipped in the container. For example, both bricks and steel pipes have a NMFC class of `50` - `weight` 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. - `loadDeficitCost` LtlLoadDeficitCost — If the LTL carrier has a cheaper rate that would require adding weight to the load, this contains the details about the amount of weight needed and the cheaper rate. - `amount` number, float, required — The difference in cost between the current shipment and a shipment at the optimal weight. - `nmfcClass` string — The NMFC class of product being shipped. For example, both bricks and steel pipes have a NMFC class of `50` - `weight` 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. - `rate` number, float, required — The best rate (e.g. cost per hundredweight) for a shipment at or above the shipment's weight. - `pickupDateTime` string, date-time — When the carrier can pick up the shipment. Some carriers may specify an exact time, whereas others will only specify the date and leave the time as 00:00:00.000 - `pricingType` 'all' | 'contract' | 'contractPallet' | 'dynamic' | 'volume' | 'unknown' — The pricing type used by the carrier for this quote. - `quoteId` string — The carrier-provided identifier for the quote. - `quoteEffectiveDateTime` string, date-time — When the carrier's quote is valid until. - `quoteExpirationDateTime` string, date-time — When the carrier's quote is valid until. - `scacCode` string, required — The SCAC code for the carrier and service method. - `serviceLevel` 'all' | 'guaranteedMorning' | 'guaranteedNoon' | 'guaranteedEndOfDay' | 'standard' | 'unknown', required — The service level, or time-definite delivery option, that will be used by the carrier. - `totalCost` number, float — The quoted cost of the shipment. - `selectedCarrier` LtlCarrierCost — Information about the selected carrier. - `billableWeight` 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. - `billToThirdPartyId` string — Either the Shipium-generated or the partner-provided third party billing ID. Used to look up the account number each LTL carrier uses to determine pricing agreement. - `carrier` string, required — The carrier who provided this quote. - `carrierAccountId` string — Unique id of the carrier account used for this cost. - `carrierServiceMethodId` string, required — The carrier's service method that would be used for transporting the load in this quote. - `estimatedDeliveryDate` string, date-time — The carrier's estimate for when the load will be delivered. This will be missing if the carrier service method does not meet the request's requirements. - `lineItems` LtlRateLineItem[] — The components of the carrier's cost estimate. This will be missing or empty if the carrier service method does not meet the request's requirements, or the carrier does not return the costing details. Requires `includeLineItemsInEvaluatedServiceMethods` to be true in the request. - `name` string, required — The name of the rate modification - `rate` number, float, required — The amount of the rate modification - `carrierSurchargeId` string — The identifier for the carrier surcharge - `surchargeType` 'additional_handling_weight' | 'additional_handling_volume' | 'additional_handling_length' | 'additional_handling_extra_length' | 'additional_handling_width' | 'additional_handling_packaging' | 'alaska_delivery_commercial_air' | 'alaska_delivery_commercial_ground' | 'alaska_delivery_residential_air' | 'alaska_delivery_residential_ground' | 'base' | 'delivery_commercial_air' | 'delivery_commercial_ground' | 'delivery_residential_air' | 'delivery_residential_ground' | 'extended_delivery_commercial_air' | 'extended_delivery_commercial_ground' | 'extended_delivery_residential_air' | 'extended_delivery_residential_ground' | 'fuel_air_domestic' | 'fuel_air_international_export' | 'fuel_air_international_import' | 'fuel_ground' | 'hawaii_delivery_commercial_air' | 'hawaii_delivery_commercial_ground' | 'hawaii_delivery_residential_air' | 'hawaii_delivery_residential_ground' | 'hazmat' | 'incentive' | 'international_delivery_area' | 'international_extended_delivery_area' | 'large_package_commercial' | 'large_package_residential' | 'peak' | 'peak_additional_handling' | 'peak_residential_delivery_air' | 'peak_residential_delivery_ground' | 'peak_large_package' | 'remote_delivery_commercial_air' | 'remote_delivery_commercial_ground' | 'remote_delivery_residential_air' | 'remote_delivery_residential_ground' | 'residential_air' | 'residential_ground' | 'saturday_delivery' | 'signature' | 'signature_resident' | 'signature_adult' | 'signature_adult_resident' | 'surcharge' | 'zone_weight' — The type of surcharge for this item. Null value for non-surcharges - `lineItemType` string — The type of rate line item for this rate modification - `hiddenFromCarrierCompare` boolean — Indicates line item exclusion from the `carrierCompareCost`. - `hiddenFromInvoice` boolean — Indicates line item exclusion from the `carrierInvoiceCost`. - `hiddenFromOperational` boolean — Indicates line item exclusion in the `operationalCost`. - `nmfcFreightClass` string — For LTL container line items, a string representing the most costly class of product being shipped in the container. For example, both bricks and steel pipes have a NMFC class of `50` - `weight` 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. - `loadDeficitCost` LtlLoadDeficitCost — If the LTL carrier has a cheaper rate that would require adding weight to the load, this contains the details about the amount of weight needed and the cheaper rate. - `amount` number, float, required — The difference in cost between the current shipment and a shipment at the optimal weight. - `nmfcClass` string — The NMFC class of product being shipped. For example, both bricks and steel pipes have a NMFC class of `50` - `weight` 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. - `rate` number, float, required — The best rate (e.g. cost per hundredweight) for a shipment at or above the shipment's weight. - `pickupDateTime` string, date-time — When the carrier can pick up the shipment. Some carriers may specify an exact time, whereas others will only specify the date and leave the time as 00:00:00.000 - `pricingType` 'all' | 'contract' | 'contractPallet' | 'dynamic' | 'volume' | 'unknown' — The pricing type used by the carrier for this quote. - `quoteId` string — The carrier-provided identifier for the quote. - `quoteEffectiveDateTime` string, date-time — When the carrier's quote is valid until. - `quoteExpirationDateTime` string, date-time — When the carrier's quote is valid until. - `scacCode` string, required — The SCAC code for the carrier and service method. - `serviceLevel` 'all' | 'guaranteedMorning' | 'guaranteedNoon' | 'guaranteedEndOfDay' | 'standard' | 'unknown', required — The service level, or time-definite delivery option, that will be used by the carrier. - `totalCost` number, float — The quoted cost of the shipment. - `totalCost` number, float — The least expensive quoted cost of the shipment, using LTL. This will be zero in case no carrier could be selected - `ltlShipmentParameters` LtlShipmentParameters, required — Request parameters that informed LTL costing and carrier selection. - `billToContact` LtlBillToContact — Whom should be billed for the LTL shipment. By default, the carrier contracts in the fulfillment context will be used for billing. - `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. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `city` string — The name of the city for the address. - `company` string — The company name for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `emailAddress` string — Email address of the contact. - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `state` string — The name of the state for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `thirdPartyBillingSetId` string, required — Either the Shipium-generated or the partner-provided third party billing set ID. Used to look up the account number each LTL carrier uses to determine pricing agreement. - `carrierServiceMethodAllowList` string[] — A list of carrierServiceMethodIds, and/or SCAC codes, and/or carriers that should be considered for LTL carrier selection. - `collectOnDelivery` CurrencyAmount — The amount that should be paid by the recipient upon delivery of the package. - `amount` number, float, required — The amount of money. - `currency` string — The ISO-4217 currency code that the amount is in. This is required unless a default currency unit is supplied elsewhere. If this and a default are both supplied, this will take priority. - `fulfillmentContextIds` string[] — A collection of Shipium generated IDs or partner provided aliases for the fulfillment context that are eligible to be used for LTL carrier selection.There must be exactly one fulfillment context that can ship from the origin to the destination, for the specified tenant, regardless of whether or not this list is populated. - `originId` string — A shipiumOriginId or partnerOriginId to identify which originthe shipment will be processed at. - `fulfillmentType` 'customer' | 'at_large' | 'returns' | 'hundredweight' | 'reship' | 'unknown' — Fulfillment methodology of the shipment. - `hazmatContact` LtlHazmatContact — Who the carrier should contact if they have a question regarding hazmat in the shipment. If this is not supplied, and their are hazardous materials in the shipment, the contact information in either the `shipFromAddress`, or the Fulfillment Context's Origin, will be used for this purpose. - `contactName` string, required — Name of the contact. - `phoneNumber` string, required — Phone number of the contact. - `phoneNumberCountryCode` string — Optional country code for the phone number of the contact. - `email` string — Email address of the contact. - `packagingOptions` LoadPackagingDetailsRequest[] — How the LTL shipment can be packaged. This is required if there are any existingShipmentIds or shipments in the LtlCostRequest. - `loadPackagingType` 'loose' | 'overboxed' | 'piece' | 'wrapped' | 'pallet' — How the parcels in the load will be packaged together. - `loadPackagingSize` LoadPackagingSizeRequest, required — Dimensions for packaging containing the parcels, used to estimate how parcels could be packed together. - `height` number, float, required — The maximum height that parcels can be stacked within the packaging. - `length` number, float, required — The longer horizontal dimension that parcels can occupy within the packaging. - `linearUnit` 'in' | 'cm' — The unit of measure for linear dimensions (length, width, height). This will override the value configured in the root level `units` object. If the root level `units` object is not provided, this field will be required. - `maximumWeight` number, float — The maximum weight of parcels within the packaging. If not specified, no maximum weight will be used when determining how to pack parcels. - `packagingWeight` number, float — The weight of the packaging without any parcels. - `weightUnit` 'g' | 'kg' | 'oz' | 'lb' — The unit of measure for maximum weight of parcels within the packaging, and the packaging itself. This will override the value configured in the root level `units` object. If the root level `units` object is not provided, this field will be required. - `width` number, float, required — The shorter horizontal dimension that parcels can occupy within the packaging. - `paymentDetails` LtlPaymentDetails, required — How the LTL shipment will be paid for. - `payerType` 'consignee' | 'shipper' | 'thirdParty', required — Who is paying the carrier to deliver the shipment. - `paymentTerms` 'collect' | 'prePaid' | 'thirdParty', required — How the shipment is being paid for. - `pickupDate` string, date, required — Date when LTL shipment will be picked up by the carrier. - `pricingTypes` string[] — The pricing types that should be eligible for LTL carrier selection. - `serviceLevels` string[] — The time-definite delivery options that should be eligible for LTL carrier selection. - `accessorialCodes` string[] — A list of codes representing the accessorial codes applicable for the shipment. - `packageCostDetails` LtlParcelCarrierSelection — The costing details of using package shipping to transport this shipment. Only present if package costing was compared to LTL costing, or used for a subset of packages. - `totalCost` number, float, required — How much it would cost to ship all of the parcels individually. - `packageDetails` CarrierSelectionSummary[], required — Information about each package's carrier selection. - `status` 'success' | 'uncosted' | 'no_decision' — Defines the result of the carrier selection call. Values returned will be success, or no_decision - `statusDetails` string — Details explaining the result status. Pertinent when the status is "no_decision". - `carrierSelectionId` string — Unique id of the carrier selection for later lookup. - `shipiumShipmentId` string — The unique identifier for this shipment. - `partnerShipmentId` string — The optional unique identifier that may be used for this shipment. - `partnerId` string — Unique id of the partner. - `carrierAccountId` string — Unique id of the carrier account selected for shipping. - `serviceMethodUrn` string — Specific version of the service level of the shipping carrier selected - `serviceMethodIdentifier` string — Identifier of the specific version of the service method of the shipping carrier selected - `carrier` string — The carrier that was used for delivering the package to your customer. - `carrierServiceMethodId` string — Maps to the unique internal Shipium ID which represents a carrier service method definition. - `serviceMethodName` string — Name of the carrier service method selected during the carrier selection process. - `costAdjustConfigId` string — If specified, this is the dynamic costing config applied for the carrier selection - `totalCost` number, float — Cost used for carrier selection. - `carrierCompareCost` number, float — Expected cost from the carrier label create. - `carrierInvoiceCost` number, float — Expected cost that carrier will charge at billing time. - `operationalCost` number, float — Carrier invoice cost plus operational costs like injection line haul. - `thirdPartyBilling` boolean — Indicates if the selected service method will be billed to a third party. - `carrierSelectionDateTime` string, date-time — ISO-8601 formatted date when the carrier selection decision was made. - `injectionDetails` InjectionSummary — InjectionProfile and InjectionSite details - `requestInjectionProfileId` string — The partner can provide either partnerInjectionProfileId or shipiumInjectionProfileId in the request and this attribute records / indicates the injectionProfile identifier provided by the partner in the request. - `partnerInjectionProfileId` string — Unique to the partner asset ID that is provided by the partner to the injectionProfile. - `shipiumInjectionProfileId` string — InjectionProfile identifier. - `requestInjectionSiteId` string — The partner can provide either partnerInjectionSiteId or shipiumInjectionSiteId in the request and this attribute records / indicates the injectionProfile address provided by the partner in the request. - `partnerInjectionSiteId` string — Unique to the partner asset ID that is provided by the partner to the injectionSite. - `shipiumInjectionSiteId` string — InjectionSite identifier - `carrierZoneId` string — The carrier zone that is being considered. - `calculatedBillableWeight` 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. - `calculatedBillableCubicVolume` CubicVolume — Cubic volume that was used to generate the rate - `cubicVolumeUnit` 'in' | 'ft' | 'cm' | 'm' — The unit for the cubic volume - `cubicVolume` number, float — The value of the cubic volume. - `laneMatch` LaneMatch — The matched lane for the carrier that was selected. This will be empty if nothing is configured for lanes. - `laneId` string — The laneId that was matched on and used. - `partnerLaneId` string — The lane sort match name that was configured on the lane. - `evaluatedServiceMethods` CarrierSelectionExpansion[] — An optional expansion of what carrier service methods were eligible but went unselected. - `carrier` string — The carrier that was used for delivering the package to your customer. - `carrierServiceMethodId` string — carrier service method id for the service method. - `serviceMethodName` string — Name of the carrier service method selected during the carrier selection process. - `carrierAccountId` string — Unique id of the carrier account selected for shipping. - `totalCost` number, float — Cost used for carrier selection. - `estimatedDeliveryDate` string, date-time — The estimated date that the shipment will arrive at its destinations. - `injectionDetails` InjectionDetails — InjectionProfile and InjectionSite details - `requestInjectionProfileId` string — The partner can provide either partnerInjectionProfileId or shipiumInjectionProfileId in the request and this attribute records / indicates the injectionProfile identifier provided by the partner in the request. - `partnerInjectionProfileId` string — Unique to the partner asset ID that is provided by the partner to the injectionProfile. - `shipiumInjectionProfileId` string — InjectionProfile identifier. - `requestInjectionSiteId` string — The partner can provide either partnerInjectionSiteId or shipiumInjectionSiteId in the request and this attribute records / indicates the injectionSite identifier provided by the partner in the request. - `partnerInjectionSiteId` string — Unique to the partner asset ID that is provided by the partner to the injectionSite. - `shipiumInjectionSiteId` string — InjectionSite identifier - `injectionCostDetails` InjectionCostDetails — Injection cost details - `injectionLineItemRate` number, float — The amount of the rate modification - `injectionLineItemCurrencyCode` string — The currency that the rate is in. - `injectionRateModifier` InjectionRateModifier — The RateModifier to be applied if the service method is for Injection - … - `rateCurrency` string — The currency that the rate is in, which also applies to line items. - `lineItems` RateLineItem[] — List of rate modifications that were used to calculate the rate - `name` string, required — The name of the rate modification - `rate` number, float, required — The amount of the rate modification - `carrierSurchargeId` string — The identifier for the carrier surcharge - `surchargeType` 'additional_handling_weight' | 'additional_handling_volume' | 'additional_handling_length' | 'additional_handling_extra_length' | 'additional_handling_width' | 'additional_handling_packaging' | 'alaska_delivery_commercial_air' | 'alaska_delivery_commercial_ground' | 'alaska_delivery_residential_air' | 'alaska_delivery_residential_ground' | 'base' | 'delivery_commercial_air' | 'delivery_commercial_ground' | 'delivery_residential_air' | 'delivery_residential_ground' | 'extended_delivery_commercial_air' | 'extended_delivery_commercial_ground' | 'extended_delivery_residential_air' | 'extended_delivery_residential_ground' | 'fuel_air_domestic' | 'fuel_air_international_export' | 'fuel_air_international_import' | 'fuel_ground' | 'hawaii_delivery_commercial_air' | 'hawaii_delivery_commercial_ground' | 'hawaii_delivery_residential_air' | 'hawaii_delivery_residential_ground' | 'hazmat' | 'incentive' | 'international_delivery_area' | 'international_extended_delivery_area' | 'large_package_commercial' | 'large_package_residential' | 'peak' | 'peak_additional_handling' | 'peak_residential_delivery_air' | 'peak_residential_delivery_ground' | 'peak_large_package' | 'remote_delivery_commercial_air' | 'remote_delivery_commercial_ground' | 'remote_delivery_residential_air' | 'remote_delivery_residential_ground' | 'residential_air' | 'residential_ground' | 'saturday_delivery' | 'signature' | 'signature_resident' | 'signature_adult' | 'signature_adult_resident' | 'surcharge' | 'zone_weight' — The type of surcharge for this item. Null value for non-surcharges - `lineItemType` string — The type of rate line item for this rate modification - `hiddenFromCarrierCompare` boolean — Indicates line item exclusion from the `carrierCompareCost`. - `hiddenFromInvoice` boolean — Indicates line item exclusion from the `carrierInvoiceCost`. - `hiddenFromOperational` boolean — Indicates line item exclusion in the `operationalCost`. - `estimatedDeliveryDateLocal` string — A ISO-8601 date-time without a time-zone - `cancellationDateTime` string, date-time — The timestamp for when a carrier selection was cancelled. This field will default to null when the carrier selection is not cancelled. A carrier selection cannot be cancelled if it is associated with an active label - `effectiveShipDateTime` string, date-time — Shipium's calculation for the effective ship date time that a shipment will ship out. This date time will be used for the carrier label and for limits. - `currencyCode` string — Currency in which all the rates for shipping carrier selection costs were calculated in. - `status` 'success' | 'failure' | 'timeout', required — Summary of what happened during package carrier selection: - `success` indicates that all packages had a carrier eligible to ship them. - `failure` indicates that one or more packages had no carriers eligible to ship them. - `timeout` indicates that one or more carrier selections could not be completed due to the amount of time required to process them. - `packageShipmentParameters` LtlParcelShipmentParameters — Request parameters that informed package shipments and carrier selection. Only present if these parameters were in the cost request. - `carrierServiceMethodAllowList` string[] — A list of carrierServiceMethodIds and/or carriers that should be considered for parcel carrier selection. - `deliverySignatureOption` 'None' | 'Signature' | 'ResidentSignature' | 'AdultSignature' | 'AdultResidentSignature' | 'Unknown' — Whether the recipient's signature should be required. - `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 - `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 Shipium generated IDs or partner provided aliases for the fulfillment context that are eligible to be used for parcel carrier selection.There must be exactly one fulfillment context that can ship from the origin to the destination, for the specified tenant, regardless of whether or not this list is populated. - `originId` string — A shipiumOriginId or partnerOriginId to identify which originthe shipment will be processed at. - `fulfillmentType` 'customer' | 'at_large' | 'returns' | 'hundredweight' | 'reship' | 'unknown' — Fulfillment methodology of the shipment. - `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. - `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. - `includeInjectionProfiles` boolean — When "true", service methods from the configured InjectionProfiles will be considered during carrier selection. - `injectionParameters` InjectionParameter[] — A list of Injection Profile and/or Injection Profile/Site tuples that should be considered during parcel 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 - `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 - `preferredCarrierDeliveryDateTime` string, date-time — The string representation of either an ISO-8601 date. The datetime the package is intended to arrive to the customer. This will be passed through to the carrier. - `saturdayDelivery` boolean — Indicates that this shipment is marked for Saturday delivery. Does not guarantee delivery on Saturday - `serviceMethodPoBoxAllowList` string[] — A list of serviceMethodIds that will be considered for USPS PO box delivery that otherwise would be filtered out as they don't support USPS PO box delivery for the shipment. - `shipOption` string — A high-level shipping option shown to or selected by a customer. This is only applicable when calculating the parcel carrier selection for this item. - `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. - `packedShipments` LoadPackagingDetails[] — The already packed LTL shipments that should be included in this LTL shipment. Items in this list are used for LTL costing and do not have their packaging modified, nor are eligible for package carrier selection. Items in this list do not have corresponding Shipium shipments. - `declaredValue` CurrencyAmount — The amount that should be paid by the recipient upon delivery of the package. - `amount` number, float, required — The amount of money. - `currency` string — The ISO-4217 currency code that the amount is in. This is required unless a default currency unit is supplied elsewhere. If this and a default are both supplied, this will take priority. - `loadPackagingType` 'loose' | 'overboxed' | 'piece' | 'wrapped' | 'pallet' — How the parcels in the load are packaged together. - `loadPackagingSize` LoadPackagingSize, required — Dimensions for packaging containing the parcels. - `height` number, float, required — The height that parcels are stacked within the packaging. - `length` number, float, required — The longer horizontal dimension that parcels occupy within the packaging. - `linearUnit` 'in' | 'cm' — The unit of measure for linear dimensions (length, width, height). This will override the value configured in the root level `units` object. If the root level `units` object is not provided, this field will be required. - `weight` number, float, required — The total weight of parcels within the packaging. - `weightUnit` 'g' | 'kg' | 'oz' | 'lb' — The unit of measure for weight of parcels within the packaging. This will override the value configured in the root level `units` object. If the root level `units` object is not provided, this field will be required. - `width` number, float, required — The shorter horizontal dimension that parcels occupy within the packaging. - `nmfcFreightClass` string, required — A string representing the broad class of products being shipped in this load. This should be the largest (i.e. 51 > 50) NMFC class of any of the products in the load. For example, both bricks and steel pipes have a NMFC class of `50` - `shipments` LtlShipmentItemSummary[] — The shipment ids of all package shipments in this LTL shipment. - `partnerShipmentId` string — An optional unique identifier that may be used for this shipment. - `shipiumShipmentId` string — The Shipium-generated unique identifier for this shipment. ## Other responses - `400` — Invalid inputs were provided. - `503` — Service is at capacity; retry after a brief delay. --- [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)