--- title: "All-in-one Cancel" method: POST path: "/api/v1/deliveryexperience/cancel" tags: ["delivery-experience"] --- # All-in-one Cancel `POST /api/v1/deliveryexperience/cancel` All in one cancel endpoint which allows users to cancel a shipment, cancel a carrier selection, or cancel and void a label. All three cancellations can be done at once with a cascading cancel. ## Headers - `X-DELEGATED-PARTNER-ID` string ## Request body - CancelRequest — Information about the cancellation request. - `shipmentId` string — Unique ID of the shipment. Either the shipmentShipmentId or the partnerShipmentId can be provided. Of the shipmentId, carrierSelectionId, shipiumLabelId, and carrierTrackingId, only one ID may be provided. - `carrierSelectionId` string — Unique ID of the carrier selection to be cancelled. Of the shipmentId, carrierSelectionId, shipiumLabelId, and carrierTrackingId, only one ID may be provided. - `shipiumLabelId` string — Unique Shipium ID of the label to be cancelled and voided with the carrier. Of the shipmentId, carrierSelectionId, shipiumLabelId, and carrierTrackingId, only one ID may be provided. - `carrierTrackingId` string — Carrier tracking ID of the label to be voided with the carrier. Of the shipmentId, carrierSelectionId, shipiumLabelId, and carrierTrackingId, only one ID may be provided. - `cancellationDateTime` string, date-time — The timestamp for when the entity/entities are cancelled. This field will default to now - `cascadeCancel` boolean — An indicator to cascade the cancel down to any existing child entities. For example, if a shipmentId is passed, any associated carrier selection and label will also be cancelled/voided. If a carrierSelectionId is passed, any associated label will also be cancelled/voided. Defaults to false. ## Response `200` Cancellation successful. - ShipmentResponse - `shipiumShipmentId` string, required — The unique identifier for this shipment. - `partnerShipmentId` string — The optional unique identifier that may be used for this shipment. - `shipiumBulkProcessingIds` string[] — The Shipium-generated unique identifiers for the bulk (or LTL) shipments that this is part of. This list is ordered from the most recent bulk shipment to the least recent. - `orderIds` OrderIds[] — The orders associated with the shipment. - `shipiumOrderId` string, required — Identification use to represent the group of delivery estimates purchased. - `partnerOrderId` string — The unique identifier representing this order. - `orderedDateTime` string, date-time — The timestamp for when customer placed an order for this product. The timestamp must be a valid ISO 8601 timestamp. - `shippedDateTime` string, date-time — The timestamp for when you (or your fulfillment partner) shipped the product from your (or their) warehouse. The timestamp must be a valid ISO 8601 timestamp. - `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. - `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. - `returnsLabel` InlineReturnsLabel — A representation of the inline label generated along with the Mega Shipment process. - `shipiumShipmentId` string — The unique identifier for this shipment. - `carrierSelectionId` string — Unique id of the carrier selection for later lookup. - `shipiumLabelId` string — Unique id of the shipium label for later lookup. - `carrier` string — Unique ID of the carrier - `carrierServiceName` string — Name of the carrier which the label was generated for. - `serviceMethodName` string — Name of the service method the label was generated for. - `carrierServiceMethodId` string — Maps to the unique internal Shipium ID which represents a carrier service method definition. - `documents` CarrierLabelInfo[] — List of links to labels generated by format for the shipment. - `labelExpiration` string, date-time — Date time when the label expires and is no longer valid. - `labelFormat` string — Defines the format the shipment label was generated in by the carrier. - `labelProperties` ShiptimeLabelProperties — Metadata describing the label. - `height` number, float, required — Top to bottom measurement of the label in linearUnits - `width` number, float, required — Right to left measurement of the label in linearUnits - `linearUnits` string, required — The linear units representing the labelHeight and labelWidth - `dpi` integer, required — The dpi (Dots Per Inch) used by the label printer - `labelOrientation` string, required — The direction that the label will be printed - `nonZplLabelDimensions` ShiptimeLabelDimensions — The dimensions used to print non-ZPL labels, if they need to be different than ZPL dimensions - `height` number, float — Top to bottom measurement of the label in linearUnits, required if width is present - `width` number, float — Right to left measurement of the label in linearUnits, required if height is present - `linearUnits` string — The linear units representing the label height and width. If this is present, both the height and width are required in the LabelDimensions. If this is missing, the linearUnits from LabelProperties will be used. - `labelImage` CarrierLabelImage — Base64 encoded ZPL as generated by the carrier before label sanitation and augmentations are performed. - `imageEncoding` string — Format in which the "imageContents" field is encoded e.g. base64. - `imageContents` string — Raw contents of the shipment label image encoded in Base64. End users will need to decode this data using the format information supplied in the "labelInfo" field. - `imageFormat` string — Image format e.g. jpeg, png. Only populated for printerless labels. - `labelUrl` string — Url with is the link to the shipment label file on the Shipium CDN. - `carrierTrackingId` string — The tracking id associated with this label. - `carrierTrackingLink` string — The tracking link associated with this label. - `packageReferenceIdentifier` string — The package reference id that was passed in by the customer to be associated with this package.Most frequently used for multi parcel shipments. This can be used to cross reference internation documents and carrier labels. - `shipiumPackageReferenceId` string — The package reference Identifier created by shipium. - `packageScannableId` string — The package scannable id associated with this label. - `carrierShipmentId` string — The carrier shipment id associated with the label. - `printerlessInfo` PrinterlessInfo — Printerless label information. Only present when labelFormat is 'printerless'. - `type` string — Type of printerless label. Examples: qrcode, barcode, nfc, rfid. - `valueRepresented` string — The value embedded in the QR code or barcode. This is typically a public URL or tracking identifier. - `internationalDocuments` InternationalDocumentInfo[] — List of international customs documents generated by the carrier for the shipment. - `documentType` 'commercial_invoice' | 'electronic_export_information' | 'ps_2976' | 'air_waybill' | 'multiple' | 'unknown' — The type of international document. For 'multiple', there will be multiple types of forms - `documentExpiration` string, date-time — Date time when the document expires and is no longer valid. - `documentFormat` string — Defines the format the document was generated in by the carrier. - `documentImage` DocumentImage — The generated document image contents and encoding. - `documentEncoding` string — Format in which the "documentContents" field is encoded - `documentContents` string — Raw contents of the encoded document. End users will need to decode this data using the format information supplied in the "documentEncoding" field. - `electronicallySubmitted` boolean — Indication of whether or not this international document has been electronically submitted by the carrier - `packageReferenceIdentifier` string — The package reference id that was passed in by the customer to be associated with a package.Most frequently used for multi parcel shipments. This can be used to cross reference internation documents and labels. - `hazardousMaterialsDocuments` HazardousMaterialsDocumentInfo[] — List of hazmat documents generated by the carrier for the shipment. - `documentType` 'OP_900LG' | 'OP_900LL' — The type of international document. For 'multiple', there will be multiple types of forms - `documentExpiration` string, date-time — Date time when the document expires and is no longer valid. - `documentFormat` string — Defines the format the document was generated in by the carrier. - `documentImage` DocumentImage — The generated document image contents and encoding. - `documentEncoding` string — Format in which the "documentContents" field is encoded - `documentContents` string — Raw contents of the encoded document. End users will need to decode this data using the format information supplied in the "documentEncoding" field. - `electronicallySubmitted` boolean — Indication of whether or not this international document has been electronically submitted by the carrier - `packageReferenceIdentifier` string — The package reference id that was passed in by the customer to be associated with a package.Most frequently used for multi parcel shipments. This can be used to cross reference internation documents and labels. - `failureReason` string — If the inline returns label creation failed, the description of the reason of the failure. - `customerForwardLabels` CustomerForwardLabel[] - `partnerShipmentId` string — A unique identifier for this forward shipment. - `baseShipiumShipmentId` string — A unique identifier for the shipment parent. - `shipiumShipmentId` string — The unique identifier for this shipment. - `carrierSelectionId` string — Unique id of the carrier selection for later lookup. - `shipiumLabelId` string — Unique id of the shipium label for later lookup. - `documents` CarrierLabelInfo[] — List of links to labels generated by format for the shipment. - `labelExpiration` string, date-time — Date time when the label expires and is no longer valid. - `labelFormat` string — Defines the format the shipment label was generated in by the carrier. - `labelProperties` ShiptimeLabelProperties — Metadata describing the label. - `height` number, float, required — Top to bottom measurement of the label in linearUnits - `width` number, float, required — Right to left measurement of the label in linearUnits - `linearUnits` string, required — The linear units representing the labelHeight and labelWidth - `dpi` integer, required — The dpi (Dots Per Inch) used by the label printer - `labelOrientation` string, required — The direction that the label will be printed - `nonZplLabelDimensions` ShiptimeLabelDimensions — The dimensions used to print non-ZPL labels, if they need to be different than ZPL dimensions - `height` number, float — Top to bottom measurement of the label in linearUnits, required if width is present - `width` number, float — Right to left measurement of the label in linearUnits, required if height is present - `linearUnits` string — The linear units representing the label height and width. If this is present, both the height and width are required in the LabelDimensions. If this is missing, the linearUnits from LabelProperties will be used. - `labelImage` CarrierLabelImage — Base64 encoded ZPL as generated by the carrier before label sanitation and augmentations are performed. - `imageEncoding` string — Format in which the "imageContents" field is encoded e.g. base64. - `imageContents` string — Raw contents of the shipment label image encoded in Base64. End users will need to decode this data using the format information supplied in the "labelInfo" field. - `imageFormat` string — Image format e.g. jpeg, png. Only populated for printerless labels. - `labelUrl` string — Url with is the link to the shipment label file on the Shipium CDN. - `carrierTrackingId` string — The tracking id associated with this label. - `carrierTrackingLink` string — The tracking link associated with this label. - `packageReferenceIdentifier` string — The package reference id that was passed in by the customer to be associated with this package.Most frequently used for multi parcel shipments. This can be used to cross reference internation documents and carrier labels. - `shipiumPackageReferenceId` string — The package reference Identifier created by shipium. - `packageScannableId` string — The package scannable id associated with this label. - `carrierShipmentId` string — The carrier shipment id associated with the label. - `printerlessInfo` PrinterlessInfo — Printerless label information. Only present when labelFormat is 'printerless'. - `type` string — Type of printerless label. Examples: qrcode, barcode, nfc, rfid. - `valueRepresented` string — The value embedded in the QR code or barcode. This is typically a public URL or tracking identifier. - `internationalDocuments` InternationalDocumentInfo[] — List of international customs documents generated by the carrier for the shipment. - `documentType` 'commercial_invoice' | 'electronic_export_information' | 'ps_2976' | 'air_waybill' | 'multiple' | 'unknown' — The type of international document. For 'multiple', there will be multiple types of forms - `documentExpiration` string, date-time — Date time when the document expires and is no longer valid. - `documentFormat` string — Defines the format the document was generated in by the carrier. - `documentImage` DocumentImage — The generated document image contents and encoding. - `documentEncoding` string — Format in which the "documentContents" field is encoded - `documentContents` string — Raw contents of the encoded document. End users will need to decode this data using the format information supplied in the "documentEncoding" field. - `electronicallySubmitted` boolean — Indication of whether or not this international document has been electronically submitted by the carrier - `packageReferenceIdentifier` string — The package reference id that was passed in by the customer to be associated with a package.Most frequently used for multi parcel shipments. This can be used to cross reference internation documents and labels. - `hazardousMaterialsDocuments` HazardousMaterialsDocumentInfo[] — List of hazmat documents generated by the carrier for the shipment. - `documentType` 'OP_900LG' | 'OP_900LL' — The type of international document. For 'multiple', there will be multiple types of forms - `documentExpiration` string, date-time — Date time when the document expires and is no longer valid. - `documentFormat` string — Defines the format the document was generated in by the carrier. - `documentImage` DocumentImage — The generated document image contents and encoding. - `documentEncoding` string — Format in which the "documentContents" field is encoded - `documentContents` string — Raw contents of the encoded document. End users will need to decode this data using the format information supplied in the "documentEncoding" field. - `electronicallySubmitted` boolean — Indication of whether or not this international document has been electronically submitted by the carrier - `packageReferenceIdentifier` string — The package reference id that was passed in by the customer to be associated with a package.Most frequently used for multi parcel shipments. This can be used to cross reference internation documents and labels. - `failureReason` string — If the label creation failed, the description of the reason of the failure. - `shipment_type` 'OUTBOUND' | 'FORWARD' | 'RETURN' — The business process type of the shipment. - `desiredDeliveryDateOptions` DesiredDeliveryDateOptions — Options for how the system will use the desiredDeliveryDate - `exactDateDelivery` boolean — This will restrict carrier selection to only use service methods that we have a high chance of making it there on time. - `businessDaysOfTransit` integer — Indicates the number of business days from the ship time by when the shipment needs to be delivered. - `originTimezoneId` string - `destinationTimezoneId` string - `ignoreUpgradeSpendLimits` boolean — Indicates that this shipment can ignore all the partner-configured upgrade limits for the potential upgrade required to deliver the shipment by the desired delivery date. - `deliveredDateTime` string, date-time — The timestamp for when the package was delivered to the customer. The timestamp must be a valid ISO 8601 timestamp. - `cancellationDateTime` string, date-time — The timestamp for when a shipment is cancelled. This field will default to null when the shipment is not cancelled. A shipment cannot be cancelled if it is associated with an label - `fulfillmentType` 'customer' | 'at_large' | 'returns' | 'hundredweight' | 'reship' | 'unknown' — Fulfillment methodology of the shipment. - `carrierName` string — The carrier that was used for delivering the package to your customer. - `carrierTrackingId` string — Carrier's tracking identification for the package. - `packages` MultiParcelShipmentPackage[] — For multi parcel shipments. A list of packages comprising the shipment. - `shipiumPackageReferenceId` string, required — Shipium Generated id label documents from the carrier. - `packageReferenceIdentifier` string, required — Used to correlate parcels to label documents from the carrier. - `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` PackagingType — 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. - `shipiumPackagingTypeId` string — The Shipium packagingTypeId for this package. - `partnerPackagingTypeId` string — The partner-provided packagingTypeId for this package. - `requestPackagingTypeId` string — The packagingTypeId that was requested for this package. This may be either the Shipium or partner-provided ID. - `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. - `orderItemQuantities` OrderItem[], required — For single parcel shipments. A list of orderItems comprising the package. - `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. - `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. - `shipOption` string — A high-level shipping option shown to or selected by a customer. - `shipFromAddress` CSAddress, required — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `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. - `injectionAddress` 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. - `fulfillmentCenterId` string — The Shipium identifier for the fulfillment center where the shipment will depart. - `fulfillmentContextId` string — The Shipium identifier for the fulfillment context where the shipment will depart. - `partnerFulfillmentContextId` string — The partner alias for the fulfillment context where the shipment will depart. - `requestFulfillmentContextIds` string[] — A collection of fulfillmentContextIds or fulfillmentContext aliases used in the FulfillmentContextDetail search. - `packagingType` PackagingType — 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. - `shipiumPackagingTypeId` string — The Shipium packagingTypeId for this package. - `partnerPackagingTypeId` string — The partner-provided packagingTypeId for this package. - `requestPackagingTypeId` string — The packagingTypeId that was requested for this package. This may be either the Shipium or partner-provided ID. - `linearDimensions` LinearDimensions — Dimensions describing the size of the packaging. - `linearUnit` 'in' | 'cm' — The unit that linear dimensions are provided in, either in for inches or cm for centimeters. - `length` number, float — The longest linear dimension (e.g. the longest side of a box or envelope). - `width` number, float — The second longest linear dimension (e.g. the second-longest side of a box of envelope. - `height` number, float — The least long linear dimension (e.g. the shortest side of a box or envelope. Note on envelopes: This height should represent the highest product you would reasonably put in this envelope before losing more than 10% of the length of the envelope in other dimensions. - `packagingWeight` Weight — The weight of this type of packaging empty. - `weightUnit` 'g' | 'kg' | 'oz' | 'lb' — The unit that weight values are provided in. g for grams kg for kilograms oz for ounces lb for pounds - `weight` number, float — The value of the weight. - `totalWeight` Weight — The weight of this type of packaging empty. - `weightUnit` 'g' | 'kg' | 'oz' | 'lb' — The unit that weight values are provided in. g for grams kg for kilograms oz for ounces lb for pounds - `weight` number, float — The value of the weight. - `shipmentTags` string[] — A collection of free-form tags that may be added to this shipment. - `carrierSelection` CarrierSelectionSummary — If shipment has had the carrier selection process run, this is the summary info and link to the more detailed summary. - `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 - `modifierType` 'flat' | 'percentage' — The type of the injection rate modifier. - `modifierValue` number, float — The value of the modification. - `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. - `carrierLabel` CarrierLabel — This is populated if a label generated for the carrier and service determined by carrier selection this field contains the information on the labels and the formats they were generated in. - `shipiumShipmentId` string — The unique identifier for this shipment. - `partnerShipmentId` string — The optional unique identifier that may be used for this shipment. - `carrierSelectionId` string — Unique id of the carrier selection for later lookup. - `shipiumTenantId` string — The shipium generated tenant ID. When present, this is used to indicate the tenant associated with the shipment. - `partnerTenantId` string — The partner provided tenant ID. When present, this is used to indicate the tenant associated with the shipment. - `shipiumLabelId` string — Unique id of the shipium label for later lookup. - `eligibleForManifest` boolean — Whether this shipment can be manifested (true, null), or is being held (false) so that it should not be manifested. - `partnerManifestId` string — The partner provided identifier for the manifest that includes this shipment. This will be present for labels that have been updated via the `/api/v1/deliveryexperience/shipment/carrierSelection/labels/endOfDayManifest` endpoint, regardless of whether the carrier's API supports manifesting. - `status` 'success' | 'failure' | 'voided' | 'failover' | 'generated' | 'imported' | 'label_created' | 'manifesting' | 'manifested' | 'manifest_failure' | 'not_set' | 'carrier_selection_failure' — Defines the result of the carrier label call. Values returned will be success, partial, and failed - `statusDetails` string — Details explaining the result status. Pertinent when the status is "partial" or "failed". - `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. - `estimatedDeliveryDate` string, date-time — The date and time by when the package is estimated to be delivered to the customer. - `estimatedInjectionDateTime` string, date-time — Shipium's calculation for the date time that a shipment will arrive at the injection site. If present, this date time will be used for the carrier label. - `labelCreationDateTime` string, date-time — The timestamp that the label object was created. This is used primarily for explaining future dated shipments. - `cancellationDateTime` string, date-time — The timestamp for when a label was cancelled. This field will default to null when the label is not cancelled. - `manifestDateTime` string, date-time — The timestamp that the label was manifested by the partner. This should be present for labels that have eligibleForManifest=true. If this was true at label creation time, it will use the shipDateTime from the request for this value. Otherwise, this can be updated via the patchLabelV1 endpoint. - `serviceMethodIdentifier` string — The urn used to identify the service method for this partner - `serviceMethodUrn` string — Specific version of the service level of the shipping carrier selected - `carrier` string — Unique ID of the carrier - `carrierServiceName` string — Name of the carrier which the label was generated for. - `serviceMethodName` string — Name of the service method the label was generated for. - `carrierServiceMethodId` string — Maps to the unique internal Shipium ID which represents a carrier service method definition. - `carrierShipmentId` string — Carrier's identification for the shipment. - `carrierTrackingId` string — Carrier's tracking identification for the package. - `carrierTrackingLink` string — Carrier's direct tracking Link (URL) for the package - `customLabelEntries` object — A free-form map of string key-value pairs applied to the label. These entries are used during label augmentation to substitute placeholders in label templates. - `shipiumTrackingId` string — Shipium's tracking identification for the package. - `carrierGroupId` string — Carrier's identification for grouping multiple packages together. For example, Canada Post groups shipments for manifesting. - `packageScannableId` string — Identifier provided that matches the scannable barcode on the label - `partnerThirdPartyBillingAccountId` string — The partner-provided ID the third party billing account that was used if the label was billed to a third party. - `shipiumThirdPartyBillingAccountId` string — The shipium generated ID of the third party billing account that was used if the label was billed to a third party. - `thirdPartyBillingForShippingCosts` boolean — Whether or not the third party paid the shipping costs. - `thirdPartyBillingForDutiesAndTaxes` boolean — Whether or not the third party paid the taxes and duties. - `carrierLabelCurrencyCode` string — Currency code which the price of the label is in. - `carrierLabelPrice` number, float — Cost charged by the carrier for shipping the package at the chosen service level. - `estimatedLabelCost` number, float — Shipium's estimated shipping cost for the service method the label was actually created on. When label failover occurs this reflects the failover carrier the label was generated with, not the originally-selected carrier described by the carrierSelection block. Unlike carrierLabelPrice (which the carrier reports and may omit), this is derived from Shipium's own rating; it is omitted only when Shipium cannot determine the created method's cost. It is an estimate and may differ from the carrier's invoiced amount. - `billableWeight` 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. - `billableCubicVolume` 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. - `documents` CarrierLabelInfo[] — List of links to labels generated by format for the shipment. - `labelExpiration` string, date-time — Date time when the label expires and is no longer valid. - `labelFormat` string — Defines the format the shipment label was generated in by the carrier. - `labelProperties` ShiptimeLabelProperties — Metadata describing the label. - `height` number, float, required — Top to bottom measurement of the label in linearUnits - `width` number, float, required — Right to left measurement of the label in linearUnits - `linearUnits` string, required — The linear units representing the labelHeight and labelWidth - `dpi` integer, required — The dpi (Dots Per Inch) used by the label printer - `labelOrientation` string, required — The direction that the label will be printed - `nonZplLabelDimensions` ShiptimeLabelDimensions — The dimensions used to print non-ZPL labels, if they need to be different than ZPL dimensions - `height` number, float — Top to bottom measurement of the label in linearUnits, required if width is present - `width` number, float — Right to left measurement of the label in linearUnits, required if height is present - `linearUnits` string — The linear units representing the label height and width. If this is present, both the height and width are required in the LabelDimensions. If this is missing, the linearUnits from LabelProperties will be used. - `labelImage` CarrierLabelImage — Base64 encoded ZPL as generated by the carrier before label sanitation and augmentations are performed. - `imageEncoding` string — Format in which the "imageContents" field is encoded e.g. base64. - `imageContents` string — Raw contents of the shipment label image encoded in Base64. End users will need to decode this data using the format information supplied in the "labelInfo" field. - `imageFormat` string — Image format e.g. jpeg, png. Only populated for printerless labels. - `labelUrl` string — Url with is the link to the shipment label file on the Shipium CDN. - `carrierTrackingId` string — The tracking id associated with this label. - `carrierTrackingLink` string — The tracking link associated with this label. - `packageReferenceIdentifier` string — The package reference id that was passed in by the customer to be associated with this package.Most frequently used for multi parcel shipments. This can be used to cross reference internation documents and carrier labels. - `shipiumPackageReferenceId` string — The package reference Identifier created by shipium. - `packageScannableId` string — The package scannable id associated with this label. - `carrierShipmentId` string — The carrier shipment id associated with the label. - `printerlessInfo` PrinterlessInfo — Printerless label information. Only present when labelFormat is 'printerless'. - `type` string — Type of printerless label. Examples: qrcode, barcode, nfc, rfid. - `valueRepresented` string — The value embedded in the QR code or barcode. This is typically a public URL or tracking identifier. - `internationalDocuments` InternationalDocumentInfo[] — List of international customs documents generated by the carrier for the shipment. - `documentType` 'commercial_invoice' | 'electronic_export_information' | 'ps_2976' | 'air_waybill' | 'multiple' | 'unknown' — The type of international document. For 'multiple', there will be multiple types of forms - `documentExpiration` string, date-time — Date time when the document expires and is no longer valid. - `documentFormat` string — Defines the format the document was generated in by the carrier. - `documentImage` DocumentImage — The generated document image contents and encoding. - `documentEncoding` string — Format in which the "documentContents" field is encoded - `documentContents` string — Raw contents of the encoded document. End users will need to decode this data using the format information supplied in the "documentEncoding" field. - `electronicallySubmitted` boolean — Indication of whether or not this international document has been electronically submitted by the carrier - `packageReferenceIdentifier` string — The package reference id that was passed in by the customer to be associated with a package.Most frequently used for multi parcel shipments. This can be used to cross reference internation documents and labels. - `hazardousMaterialsDocuments` HazardousMaterialsDocumentInfo[] — List of hazardous materials documents generated by the carrier for the shipment. - `documentType` 'OP_900LG' | 'OP_900LL' — The type of international document. For 'multiple', there will be multiple types of forms - `documentExpiration` string, date-time — Date time when the document expires and is no longer valid. - `documentFormat` string — Defines the format the document was generated in by the carrier. - `documentImage` DocumentImage — The generated document image contents and encoding. - `documentEncoding` string — Format in which the "documentContents" field is encoded - `documentContents` string — Raw contents of the encoded document. End users will need to decode this data using the format information supplied in the "documentEncoding" field. - `electronicallySubmitted` boolean — Indication of whether or not this international document has been electronically submitted by the carrier - `packageReferenceIdentifier` string — The package reference id that was passed in by the customer to be associated with a package.Most frequently used for multi parcel shipments. This can be used to cross reference internation documents and labels. - `fulfilledByCarrier` string — The carrier that will fulfill the shipment, if different from the primary carrier (e.g., for proxy carriers like Amazon SFP). - `fulfilledByServiceMethod` string — The service method of the fulfilling carrier (e.g., 'fedex-ground-service-method' when Amazon SFP selects FedEx Ground). - `fulfilledByCarrierTrackingId` string — The tracking ID of the fulfilling carrier for proxy carriers like Amazon SFP (e.g., the UPS or FedEx tracking number). - `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. - `labelFailoverOccurred` boolean — When "true" signifies that label creation failover logic was exercised. - `trackingInfo` TrackingInfo — Details of the tracking history and status of the package. - `carrier` string — Defines the carrier that provide the tracking information. - `trackingId` string — ID unique to the carrier used to identify the shipment the tracking information provides status for. - `shippedDateTime` string, date-time — Date which the possession of the shipment was taken by the carrier, null if shipment is still at the customer's shipping origin location. - `deliveredDateTime` string, date-time — Date which the carrier delivered the shipment to it expected destination, null if shipment is not delivered yet. - `currentStatus` TrackingEvent — Status history of the shipment as reported by the carrier as of the time of the call. - `deliveryStep` 'InfoReceived' | 'InTransit' | 'OutForDelivery' | 'Delivered' | 'Exception' | 'Unknown' — High level status of this shipment event as reported by the carrier. - `shipmentStatus` 'InfoReceived' | 'PickedUp' | 'ArrivedCarrierFacility' | 'DepartedCarrierFacility' | 'InTransit' | 'Hold' | 'OutForDelivery' | 'Delivered' | 'Exception' | 'Unknown' — Detailed status of this shipment event as reported by the carrier. A shipment can have many statuses within a deliveryStep, and the granularity is carrier dependent. - `statusMessage` string — Human readable shipment status message as reported by the carrier. - `eventDateTime` string, date-time — Date time which the carrier recorded this event for the shipment. - `eventCity` string — City where the carrier recorded the event. - `eventRegion` string — Region (State/Province/Territory where the carrier recorded the event. - `eventPostalCode` string — Postal code of location the carrier recorded the event. - `eventCountry` string — Country where the carrier recorded the event. - `events` TrackingEvent[] — Status history of the shipment as reported by the carrier as of the time of the call. - `deliveryStep` 'InfoReceived' | 'InTransit' | 'OutForDelivery' | 'Delivered' | 'Exception' | 'Unknown' — High level status of this shipment event as reported by the carrier. - `shipmentStatus` 'InfoReceived' | 'PickedUp' | 'ArrivedCarrierFacility' | 'DepartedCarrierFacility' | 'InTransit' | 'Hold' | 'OutForDelivery' | 'Delivered' | 'Exception' | 'Unknown' — Detailed status of this shipment event as reported by the carrier. A shipment can have many statuses within a deliveryStep, and the granularity is carrier dependent. - `statusMessage` string — Human readable shipment status message as reported by the carrier. - `eventDateTime` string, date-time — Date time which the carrier recorded this event for the shipment. - `eventCity` string — City where the carrier recorded the event. - `eventRegion` string — Region (State/Province/Territory where the carrier recorded the event. - `eventPostalCode` string — Postal code of location the carrier recorded the event. - `eventCountry` string — Country where the carrier recorded the event. - `testMode` boolean — A flag denoting whether the label is a test label - `failureType` string — A code denoting the cause of the failure - `multiParcel` boolean - `customsInfo` RequestCustomsInfo — Customs information about the package for international shipping. - `totalCustomsValue` number, float — The customs value of the shipment in totalCustomsValueCurrency - `totalCustomsValueCurrency` string — The ISO-4217 currency code representing the totalCustomsValue - `customsDescription` string — The detailed description of the items being shipped - `reasonForExport` 'sale' | 'gift' | 'sample' | 'returns' | 'personal_effects' | 'unknown' — The reason to export an international shipment - `businessIndicator` 'B2C' | 'B2B' | 'unknown' — Shipment-level indicator of whether the shipment is a business-to-consumer (B2C) or business-to-business (B2B) transaction. Required for EU27-inbound customs clearance after the 2026-07-01 de minimis removal. Partner-supplied; not derived from the address type. - `invoiceDate` string, date — Date when the invoice was created. Ideally this is the same as the ship date - `invoiceNumber` string — The Commercial Invoice number, if the Commercial Invoice was generated by the partner - `invoicePrePaidAmount` InvoicePrePaidAmount — Prepaid shipping/handling charges to include on the commercial invoice. - `value` number, float — The prepaid amount value. - `currencyCode` string — The currency code for the prepaid amount. - `europeanUnionInfo` EuropeanUnionInfo — Important information to supply when shipping to the european union. - `vendorIossNumber` string — An Import One-Stop-Shop (IOSS) number is a 12-digit identification number that is used to pay VAT and declare imports to the European Union (EU). The IOSS number is a type of VAT identification, but it is not the same as a resident VAT registration. - `vendorIossAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `ultimateConsigneeAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `ultimateConsigneeType` 'direct_consumer' | 'government_entity' | 'reseller' | 'unknown' — The type of the ultimate consignee - `aesInternalTransactionNumber` string — The number received if the Electronic Export Information (EEI) was filed and has been accepted in the Automated Export System (AES) - `electronicExportInformation` ElectronicExportInformation — Information for the Electronic Export Information (EEI) customs form, only used when the EEI will be filed directly by the carrier (i.e. not filed by the partner using AES Direct or otherwise) - `exportDate` string, date — The date the goods will be exiting the country - `pointOfOrigin` string — The 2-character state abbreviation from which the goods were shipped to the port of export. - `b13AFilingOption` 'NOT_REQUIRED' | 'MANUALLY_ATTACHED' | 'FILED_ELECTRONICALLY' | 'SUMMARY_REPORTING' | 'CARRIER_TO_STAMP' | 'UNKNOWN' — Specify the filing option being exercised. Required for non-document shipments originating in Canada destinated for any country other than Canada, the United States, Puerto Rico, or the U.S. Virgin Islands. - `exportComplianceStatement` string — For US export shipments requiring an EEI, enter the ITN number received from AES when you filed your shipment or the FTR (Foreign Trade Regulations) exemption number. The proper format for an ITN number is AES XYYYYMMDDNNNNNN where YYYYMMDD is date and NNNNNN are numbers generated by the AES. Example: AESX20220714987654 Note: The ITN or FTR exemption number you submit in the ship request prints on the international shipping label. For CA export shipments, it can be Proof of report number(15-32 alphanumeric), Summary proof of report number(7-32 alphanumeric) or Exemption number(2 digit) based on the selected b13AFilingOption. Example: 98765432107654321(POR number), 7654321(Summary POR number) and 02(Exemption number). For FTR exemption number you need provide a predefined value as NO_EEI_30_37_A. - `permitNumber` string — This is a Permit Number. This field is applicable only to Canada export non-document shipments of any value to any destination. No special characters are allowed. - `customsItems` CustomsItemData[] — Contains customs information for each item in the shipment. - `customsValue` number, float — The value of each individual item to report to customs in customsValueCurrency - `customsValueCurrency` string — The ISO-4217 currency code representing the customsValue - `commodityDescription` string — A description of this product to be provided to customs - `countryOfManufacture` string — The ISO-3166 2 digit country code that manufactured the this product - `customsWeight` Weight — The weight of this type of packaging empty. - `weightUnit` 'g' | 'kg' | 'oz' | 'lb' — The unit that weight values are provided in. g for grams kg for kilograms oz for ounces lb for pounds - `weight` number, float — The value of the weight. - `quantity` integer — The number of units of this customs item - `productId` string — The merchant's product identifier (SKU) for this customs item. - `standardizedProductIds` StandardizedProductId[] — Standardized product identifiers (GTIN/EAN/UPC/ISBN) for this customs item. - `type` 'GTIN' | 'EAN' | 'UPC' | 'ISBN' | 'unknown' — The standard that a standardized product identifier conforms to (e.g. a barcode standard). - `value` string — The standardized product identifier value. - `manufacturerProductId` string — The manufacturer's non-standardised product identifier (EU C128) for this customs item — a free-form code assigned by the manufacturer or brand (e.g. internal SKU / part number). Distinct from the merchant productId and the standardized barcodes. - `quantityUnitOfMeasurement` 'bag' | 'barrel' | 'box' | 'case_of_goods' | 'container' | 'crate' | 'cylinder' | 'envelope' | 'pallet' | 'piece' | 'roll' | 'tube' | 'unknown' — The unit of measurement of the item - `harmonizedTariffNumber` string — The 6-15 digit Harmonized System Tariff classification code - `commodityPartNumber` string — The part number or reference number for the product - `marksAndNumbers` string — Any special marks, codes, and numbers that may identify the package - `electronicExportCommodityInformation` ElectronicExportCommodityInformation — Customs item information that is particular to the Electronic Export Information (EEI) - `exportType` 'domestic' | 'foreign' | 'unknown', required — The type of the export. - `exportInformationCode` string, required — The 2-digit export information code for the commodity. - `scheduleBInformation` ScheduleBInformation, required — The Schedule B information for the commodity. - `scheduleBNumber` string, required — The 10-digit Schedule B classification code for the item being exported - `scheduleBQuantity` integer, required — The count of how many Schedule B units are in the shipment - `scheduleBUnitOfMeasurement` 'barrels' | 'carat' | 'content_kilogram' | 'square_centimeter' | 'content_ton' | 'curie' | 'clean_yield_kilogram' | 'dozen' | 'dozen_pieces' | 'dozen_pairs' | 'fiber_meter' | 'gross_container' | 'gram' | 'gross' | 'hundred' | 'kilogram' | 'cubic_kilometer' | 'kilogram_total_sugars' | 'liter' | 'meter' | 'square_meter' | 'cubic_meter' | 'millicurie' | 'number' | 'pieces' | 'proof_liter' | 'pack' | 'pairs' | 'running_bales' | 'square' | 'ton' | 'thousand' | 'no_quantity_required' | 'unknown', required — The unit of measure for the Schedule B quantity - `eccnNumber` string, required — The 5-digit product ECCN number as issued by the Bureau of Industry and Security. The format is #A###. - `exportLicenseInformation` ExportLicenseInformation, required — The license information for the export. - `licenseType` string, required — The standard license type code as published by the US government. - `licenseExemptionCode` string — The license exemption code, if the license type does not require a license number. - `exportLicense` ExportLicense — The export license, if the license type requires a valid license. - `licenseNumber` string, required — The license number. - `licenseLineValue` integer, required — The export monetary amount allowed per license. - `licenseExpiration` string, date, required — The license expiration date. - `b13AFilingOption` 'NOT_REQUIRED' | 'MANUALLY_ATTACHED' | 'FILED_ELECTRONICALLY' | 'SUMMARY_REPORTING' | 'CARRIER_TO_STAMP' | 'UNKNOWN' — Specify the filing option being exercised. Required for non-document shipments originating in Canada destinated for any country other than Canada, the United States, Puerto Rico, or the U.S. Virgin Islands. - `exportComplianceStatement` string — For US export shipments requiring an EEI, enter the ITN number received from AES when you filed your shipment or the FTR (Foreign Trade Regulations) exemption number. The proper format for an ITN number is AES XYYYYMMDDNNNNNN where YYYYMMDD is date and NNNNNN are numbers generated by the AES. Example: AESX20220714987654 Note: The ITN or FTR exemption number you submit in the ship request prints on the international shipping label. For CA export shipments, it can be Proof of report number(15-32 alphanumeric), Summary proof of report number(7-32 alphanumeric) or Exemption number(2 digit) based on the selected b13AFilingOption. Example: 98765432107654321(POR number), 7654321(Summary POR number) and 02(Exemption number). For FTR exemption number you need provide a predefined value as NO_EEI_30_37_A. - `cpscCertificateOfCompliance` CpscCertificateOfCompliance — CPSC Certificate of Compliance data for US import of CPSC-regulated consumer products. Supports two filing modes: FULL (all certificate data inline) or REFERENCE (pointer to CPSC Product Registry). - `filingMode` 'FULL' | 'REFERENCE', required — CPSC Certificate of Compliance filing mode - `cpscProductId` string — CPSC product certification identifier — distinct from the SKU-level productId on CustomsItem or OrderItemQuantity (required for FULL mode) - `applicableCpscRules` string[] — CPSC rules or standards the product was tested against (required for FULL mode, e.g. "16 CFR 1219", "ASTM F2194") - `dateOfManufacture` string, date — Date the product was manufactured (required for FULL mode) - `manufacturerName` string — Name of the manufacturer (required for FULL mode) - `manufacturerAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `lastComplianceTestingDate` string, date — Date of most recent compliance testing (required for FULL mode) - `testingLabName` string — Name of the accredited testing laboratory (required for FULL mode) - `testingLabAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `testingLabContactInfo` string — Testing laboratory phone or email contact (required for FULL mode) - `importerRecordKeeperContact` string — Importer or record-keeper contact information (required for FULL mode) - `registryProductId` string — Product ID in the CPSC Product Registry (required for REFERENCE mode) - `registryVersionId` string — Version ID in the CPSC Product Registry (required for REFERENCE mode) - `registryCertifierId` string — Certifier ID in the CPSC Product Registry (required for REFERENCE mode) - `incoterm` 'DDP' | 'DDU' | 'DAP' | 'DPU' | 'FCA' | 'CPT' | 'FOB' | 'EXW' — Enum used to represent desired incoterm. - `declarationStatement` string — A customs declaration statement for the shipment that, if provided, will appear on generated commercial invoices. - `taxIdentificationNumber` string — The EIN tax identification number of the shipper - `importerOfRecord` ImporterOfRecord — Address details of the importer for customs purposes for the vast majority of Express import shipments - `importerAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `accountNumber` string — Account Number of importer - `taxIdentificationNumbers` RequestTaxIdentificationNumber[] — Tax Identification numbers of importer - `number` string — Tax Identification Number - `tinType` 'PERSONAL_NATIONAL' | 'PERSONAL_STATE' | 'FEDERAL' | 'BUSINESS_NATIONAL' | 'BUSINESS_STATE' | 'BUSINESS_UNION' — Type of Tax Identification Number - `brokers` Broker[] — Address details of the broker for customs purposes - `brokerAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `accountNumber` string — Account Number of the broker - `taxIdentificationNumbers` RequestTaxIdentificationNumber[] — Tax Identification numbers of broker - `number` string — Tax Identification Number - `tinType` 'PERSONAL_NATIONAL' | 'PERSONAL_STATE' | 'FEDERAL' | 'BUSINESS_NATIONAL' | 'BUSINESS_STATE' | 'BUSINESS_UNION' — Type of Tax Identification Number - `deliveryInstructions` string — Delivery Instructions of broker - `type` 'IMPORT' | 'EXPORT' — Type of the broker - `soldTo` SoldTo — Address details of the sold to party for customs purposes - `address` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `accountNumber` string — Account Number of the sold to party - `taxIdentificationNumbers` RequestTaxIdentificationNumber[] — Tax Identification numbers of the sold to party - `number` string — Tax Identification Number - `tinType` 'PERSONAL_NATIONAL' | 'PERSONAL_STATE' | 'FEDERAL' | 'BUSINESS_NATIONAL' | 'BUSINESS_STATE' | 'BUSINESS_UNION' — Type of Tax Identification Number - `totalDeclaredValue` DeclaredValue — The total monetary amount of the declared value for the package. This is what will be reimbursed if the package is damaged. If the declared value exceeds the carrier's free threshold, there may a surcharge for passing a declared value. - `declaredValue` number, float — The value to be passed through as the total declared value. - `currencyCode` string — The currency code for the declared value. - `saturdayDelivery` boolean — Indicates that this shipment is marked for Saturday delivery. Does not guarantee delivery on Saturday - `deliverySignatureOption` 'None' | 'Signature' | 'ResidentSignature' | 'AdultSignature' | 'AdultResidentSignature' | 'Unknown' — Defaults to None - `lastMileDeliveryOptions` LastMileDeliveryOptions — A collection of fields used for instructing carriers on how to handle last mile delivery. - `deliveryInstruction` 'LEAVE_AT_DOOR' | 'MEET_AT_DOOR' — Instructions passed to the carrier on how to handle on delivery. - `undeliverableInstruction` 'LEAVE_AT_DOOR' | 'RETURN' | 'DESTROY' — Instructions passed to the carrier on how to handle packages that go undelivered - `tip` Tip — Field passed to carriers like Uber to specify the tip - `type` 'FIXED' | 'PERCENTAGE' — Define the type of tip - `value` number, float — Fix amount or percentage value for the tip - `currency` string - `tipForLabelCreate` Tip — Field passed to carriers like Uber to specify the tip - `type` 'FIXED' | 'PERCENTAGE' — Define the type of tip - `value` number, float — Fix amount or percentage value for the tip - `currency` string - `deliverableActionForLabelCreate` 'RETURN' | 'LEAVE_AT_DOOR' | 'DISCARD' | 'MEET_AT_DOOR' - `undeliverableActionForLabelCreate` 'RETURN' | 'LEAVE_AT_DOOR' | 'DISCARD' | 'MEET_AT_DOOR' - `deliveryWindow` TimeWindow — A string passed to carriers for a delivery window. - `startWindow` string, required — A time without any date or timezone - `endWindow` string, required — A time without any date or timezone - `timeZone` string - `pickupWindow` TimeWindow — A string passed to carriers for a delivery window. - `startWindow` string, required — A time without any date or timezone - `endWindow` string, required — A time without any date or timezone - `timeZone` string - `deliveryNote` string — String passed to carriers for a delivery note. - `requestThirdPartyBillingSetId` string — Either the shipium third party billing set ID or the partner provided third party billing set ID. When present, this is the third party billing set ID sent on the request. - `shipiumThirdPartyBillingSetId` string — The shipium generated third party billing set ID. When present, this is used to indicate the third party billing set ID associated with the shipment. - `partnerThirdPartyBillingSetId` string — The partner provided third party billing set ID. When present, this is used to indicate the third party billing set ID associated with the shipment. - `forceThirdPartyBilling` boolean — Indicates that third party billing is forced for this shipment - `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. - `packageReferenceIdentifier` string — Used to correlate parcels to label documents from the carrier. - `purchaseOrderIdentifier` string — String passed to carriers as a purchase order identifier. - `partnerReferenceIdentifier` string — Partner supplied string as a reference (not passed to carriers). - `partnerReferenceIdentifier2` string — Partner supplied string as a reference2 (not passed to carriers). - `carrierProcessingId` string — Carrier-provided identifier, supplied when it is needed to process the shipment. - `fulfillmentContext` string — When present, this is used to limit carrier selection to carrier accounts that contain a matching fulfillmentContext - `requestTenantId` string — Either the shipium tenant ID or the partner provided tenant ID. When present, this is the tenant Id sent on the request. - `shipiumTenantId` string — The shipium generated tenant ID. When present, this is used to indicate the tenant associated with the shipment. - `partnerTenantId` string — The partner provided tenant ID. When present, this is used to indicate the tenant associated with the shipment. - `createdWithVersion` 'v1' | 'v2' — The version used when creating the shipment. - `shipmentProperties` string[] — A list of high-level properties about the shipment - `testMode` boolean — Indicates a testMode shipment. Carrier selection will consider carriers and service methods in test mode and label generation will generate a test label. - `orderSourceName` string — Field that is used to determine source of order. This field may be utilized to inform carrier of the source of the order for handling. - `emergencyResponseInfo` EmergencyResponseInfo — Emergency Response Info Provider (ERIP) contact details for 24/7 emergency response. Used for hazmat shipments. If not provided, falls back to shipFrom contact info. - `phoneNumber` string — 24 Hour Emergency Phone Number. For US: 1 + area code + 7-digit number. For international: country code + area code + number. - `contactName` string — Emergency contact name or ERIP provider name. - `contractNumber` string — ERIP contract/account number. - `shipmentRequestedDocuments` ShipmentRequestedDocument[] — A list of documents generated via the Document Generation Service. Each entry contains the document blueprint reference, format, and base64-encoded image. - `documentBlueprintId` string — The Shipium-generated document blueprint ID. - `partnerProvidedDocumentBlueprintId` string — The partner-provided document blueprint alias. - `documentFormat` string — The format of the generated document (e.g., PNG, ZPL, PDF). - `documentImage` DocumentImage — The generated document image contents and encoding. - `documentEncoding` string — Format in which the "documentContents" field is encoded - `documentContents` string — Raw contents of the encoded document. End users will need to decode this data using the format information supplied in the "documentEncoding" field. - `errorMessage` string — Error message if document generation failed for this blueprint. - `thirdPartyBillingAccounts` ThirdPartyBillingAccounts[] — Details of the third-party billing account associated with the shipment. Includes information about the carrier tied to the account and its applicability for label creation. If a carrier-specific account is unavailable in the response and no configuration exists in the fulfillment context, third-party billing will not be applied. Additionally, if both a fulfillment context configuration and this value exist, this value takes precedence. - `carrierId` string, required — Internal carrier account id as represented in Shipium. - `thirdPartyBillingCredentials` ThirdPartyBillingCredentials, required — Partner Credentials for this account used to connect to carrier APIs. - `accountNumber` string - `countryCode` string - `postalCode` string - `billThirdPartyForShippingCost` boolean — Describes whether the third party should be billed for the cost of shipping the package - `billThirdPartyDutiesAndTaxes` boolean — Describes whether the third party should be billed for duties and taxes - `payorAccounts` PayorAccounts[] — List representing payor account details for third-party billing - `accountType` 'consignee' | 'collect' | 'third_party' | 'recipient' | 'sender', required — Type of account used for billing. Possible values: 'recipient', 'third_party', 'sender'. - `carrierId` string — Internal carrier account ID as represented in Shipium. Required only for 'collect' and 'third_party' payer types. - `payorAccountCredentials` PayorAccountCredentials, required — Partner credentials for this account used to authenticate and connect to carrier APIs. - `accountNumber` string - `accountCountryCode` string - `accountPostalCode` string - `payorAccountAddress` CSAddress — Address details of the sold to party for customs purposes - `name` string — The name associated with the address. - `phoneNumber` string — Phone number of the contact. - `phoneNumberCountryCode` string — Phone Number Country Code of the contact. - `emailAddress` string — Email address of the contact. - `company` string — The company name for the address. - `street1` string — The first address line. - `street2` string — The second address line. - `city` string — The name of the city for the address. - `state` string — The name of the state for the address. - `countryCode` string, required — The ISO 3166-1 country code for the address. - `postalCode` string, required — A countryCode-appropriate postal code for the address. - `addressType` 'commercial' | 'residential' — The type of location for this address. - `addressLineComponents` AddressLineComponents — The components extracted from street1 and street2 - `streetName` string — The name of the street. - `primaryAddressNumber` string — The primary, or external, address number. - `secondaryAddressNumber` string — The secondary, or internal, address number. - `district` string — The district, or municipality, for the address. - `neighborhood` string — The neighborhood for the address. - `registrationInformation` RegistrationInformation — Billing registration information associated with the payor account. - `typeCode` 'VAT' | 'EIN' | 'GST' | 'SSN' | 'EOR' | 'DUN' | 'FED' | 'STA' | 'CNP' | 'IE' | 'INN' | 'KPP' | 'OGR' | 'OKP' | 'MRN' | 'SDT' | 'FTZ' | 'DAN' | 'TAN' | 'DTF' | 'RGP' | 'DLI' | 'NID' | 'PAS' | 'MID' | 'IMS' | 'EIC' - `registrationNumber` string - `issuerCountryCode` string - `additionalCarrierSpecificInformation` AdditionalCarrierSpecificInformation — Credentials associated with the payor account. - `usps` UspsInformation — USPS-specific additional carrier information. - `customerRegistrationId` string — Customer Registration ID (CRID) assigned by USPS. - `mailerId` string — Mailer ID (MID) associated with your USPS account. - `manifest` string — Mailer ID used specifically for manifesting shipments. - `permitNumber` string — USPS postage permit number. - `permitPostalCode` string — PostalCode for international consistency. - `billForShippingCost` boolean — Indicates whether the payor should be billed for the cost of shipping the package. - `billDutiesAndTaxes` boolean — Indicates whether the third party should be billed for duties and taxes. - `configurationOverrides` ConfigurationOverrides - `maximumAdditionalDaysToHold` integer — Configuration used to define maximum additional days to hold a package - `labelToDockDoorHours` number, float — The estimated time between a label being printed and the shipment reaching the dock door. To be used in the effectiveShipDate calculation. - `endorsementType` 'AddressServiceRequested' | 'ForwardingServiceRequested' | 'ChangeServiceRequested' | 'ReturnServiceRequested' | 'CarrierLeaveIfNoResponse' — AddressServiceRequested, ForwardingServiceRequested, ChangeServiceRequested, ReturnServiceRequested, CarrierLeaveIfNoResponse - `useShipFromAddressInRequest` boolean — Describes whether or not to use the shipFromAddress in the request (instead of the address which is configured on the origin. - `multiParcel` boolean - `desiredDeliveryDateLocal` string — A ISO-8601 date-time without a time-zone - `estimatedDeliveryDateLocal` string — A ISO-8601 date-time without a time-zone - `missingRequiredLabelFields` string[] - `desiredDeliveryDate` string, date-time — The timestamp for the adjusted desired delivery date. This date includes all adjustments that Shipium has made to the requested desired delivery date. Shipium will use this dateTime for carrier selection. The timestamp must be a valid ISO 8601 timestamp. - `estimatedDeliveryDate` string, date-time — The date and time by when the package is estimated to be delivered to the customer. - `effectiveShipDateTime` string, date-time — Shipium's calculation for the effective ship date time that a shipment will ship out. ## Other responses - `400` — Invalid inputs were provided. - `403` — Not authenticated / authorized via OAuth. - `404` — Unable to find the entity to cancel. --- [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/versions/7ef5dbd6a025/schema)