currencyCode

Type: String
Example: usd
Description: Currency in which all the rates for shipping carrier selection costs will be calculated

generateLabel

Type: Boolean
Values: true or false
Description: When true, a request to the selected carrier will be sent to generate a label for the shipment based on the information provided in the labelParameters field of this object. When false, this step is skipped and the system will record what carrier service method would have generated a label for.

includeEvaluatedServiceMethodsInResponse

Type: Boolean
Values: true or false
Description: When true, a request will expand information on the response to include unselected service methods that made it through filtering.

includeLineItemsInEvaluatedServiceMethods

Type: Boolean
Values: true or false
Description: When true, a response will include line item information for the returned evaluated service methods, provided that includeEvaluatedServiceMethodsInResponse is also set to true.

inlineReturnsLabel

Type: Object
Description: Details of the shipment to be returned and its corresponding destination addresses, contact, and fulfillment context details. See Return Labels for guidance on generating a return shipment label when calling this API.

ignoreRuleSets

Type: Boolean
Values: true or false
Description: When true, any configured rule sets will be ignored during carrier selection.

labelParameters.contentDescription

Type: String
Condition: Required for return shipments only
Description: A short description (under 35 characters) of the package contents being returned that is passed on to the carrier

labelParameters.currencyCode

Type: String
Description: Currency in which all the rates for shipping carrier selection costs will be calculated

labelParameters.customLabelEntries

Type: String
Description: List of formats in which to generate the package label

labelParameters.customLabelEntries .additionalProp1

Type: String
Description: Additional properties to be associated with the label, beginning with the number 1

labelParameters .includeLabelImagesInResponse

Type: Boolean
Values: true or false
Description: If true, the response will include the raw image data of the labels that were requested to be generated by the carrier.

labelParameters.labelFormats

Type: String (enumeration)
Values: pdf, png, zpl
Description: List of formats in which to generate the package label

labelParameters.eligibleForManifest

Type: Boolean
Values: true or false
Description: When true, or null, this label will be included in end-of-day and scheduled manifests. false indicates that the label should not be included in any manifests.

shipmentParameters.orderedDateTime

Type: String (date-time)
Description: The timestamp for when the customer placed the order for this product; the timestamp must be a valid ISO 8601 timestamp.

shipmentParameters.destinationAddress .countryCode

Type: String
Description: The ISO 3166-1 country code for the destination address

shipmentParameters.destinationAddress .postalCode

Type: String
Description: A country-code-appropriate postal code for the destination address

shipmentParameters.destinationAddress .addressType

Type: String (enumeration)
Values: commercial, residential Description: The type of location for the destination address

shipmentParameters.destinationAddress .name

Type: String
Description: The name of the contact for the destination address

shipmentParameters.destinationAddress .city

Type: String
Description: The name of the city for the destination address

shipmentParameters.destinationAddress .state

Type: String
Description: The 2-letter postal abbreviation of the state for the destination address

shipmentParameters.destinationAddress .street1

Type: String
Description: The first destination address line

shipmentParameters.destinationAddress .phoneNumber

Type: String
Condition: May be required for certain carriers and methods
Description: The phone number of the contact for the destination address

shipmentParameters.destinationAddress .phoneNumberCountryCode

Type: String
Condition: May be required for certain carriers and methods
Description: The phone number country code of the contact for the destination address

shipmentParameters.shipFromAddress .countryCode

Type: String
Condition: Required unless the optional originId field is included. If originId is included, shipFromAddress should not be included in your call.
Description: The ISO 3166-1 country code for the origin address

shipmentParameters.shipFromAddress .postalCode

Type: String
Condition: Required unless the optional originId field is included. If originId is included, shipFromAddress should not be included in your call.
Description: A country-code-appropriate postal code for the origin address

shipmentParameters.originId

Type: String
Condition: If you opt to include an originId in your call, the shipFromAddress should not be included.
Description: Either the Shipium-generated origin ID or your organization's own origin ID, used to identify the origin where the shipment will be processed

shipmentParameters.returnToAddress .countryCode

Type: String
Condition: Required if including a returnToAddress. This return-to address will override a return-to address configured for an origin or carrier account.
Description: The ISO 3166-1 country code for the address of the location where the package is being returned.

shipmentParameters.returnToAddress .postalCode

Type: String
Condition: Required if including a returnToAddress. This return-to address will override a return-to address configured for an origin or carrier account.
Description: A country code appropriate postal code for the address of the location where the package is being returned

shipmentParameters.orderItemQuantities .productDetails

Type: Array of strings
Values: limited_quantity (preferred for LQ/ORM-D; alias: lq), bound_printed_matter (alias: bpm), perishable, ormd (legacy; alias: orm-d)
Condition: Required for international shipments and shipments containing hazardous materials
Description: A list of product properties that affect carrier selection and handling; see productDetails Reference for details.

shipmentParameters.orderItemQuantities .productId

Type: String
Example: RN03947--Z43121
Condition: Required for international shipments and shipments containing hazardous materials
Description: A product ID for the product being checked (ISBN, UPC, etc.)

shipmentParameters.orderItemQuantities .quantity

Type: Integer (int32)
Example: 3
Condition: Required for international shipments and shipments containing hazardous materials
Description: The number of units of the product

shipmentParameters.packagingType .packagingMaterial

Type: String (enumeration)
Values: box, envelope, flat_pack, mailing_tube, parcel_pallet
Condition: Required when packagingTypeId is not provided. Optional when packagingTypeId is provided; in this case, the value from the request will be used if the packagingMaterial is not defined in the pre-configured packaging associated with the packagingTypeId.
Description: The material type of the packaging

shipmentParameters.packagingType .packagingTypeId

Type: String
Example: ebd94f8b-d390-4c9c-987f-b88343f5bf45
Condition: When provided, the system uses the pre-configured packaging properties (dimensions, material, weight) associated with this ID. When this value is present, linearDimensions and packagingMaterial become optional. When this value is absent, linearDimensions and packagingMaterial are required.
Description: The unique identifier for a pre-configured packaging type defined in the Shipium Console

shipmentParameters.packagingType .linearDimensions.length

Type: Number (float)
Example: 13
Condition: Required when packagingTypeId is not provided. Optional when packagingTypeId is provided; in this case, the value from the request will be used if dimensions are not defined in the pre-configured packaging.
Description: The longest linear dimension (i.e., the longest side of a box or envelope)

shipmentParameters.packagingType .linearDimensions.width

Type: Number (float)
Example: 12
Condition: Required when packagingTypeId is not provided. Optional when packagingTypeId is provided; in this case, the value from the request will be used if dimensions are not defined in the pre-configured packaging.
Description: The second longest linear dimension (i.e., the second longest side of a box or envelope)

shipmentParameters.packagingType .linearDimensions.height

Type: Number (float)
Example: 10
Condition: Required when packagingTypeId is not provided. Optional when packagingTypeId is provided; in this case, the value from the request will be used if dimensions are not defined in the pre-configured packaging.
Description: The least long linear dimension (i.e., 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.

shipmentParameters.packagingType .linearDimensions.linearUnit

Type: String (enumeration)
Values: cm (centimeter), in (inch)
Condition: Required when packagingTypeId is not provided. Optional when packagingTypeId is provided; in this case, the value from the request will be used if dimensions are not defined in the pre-configured packaging.
Description: The unit in which linear dimensions are provided

shipmentParameters.deliveryWindow .endWindow.hour

Type: String (byte)
Condition: Required when including deliveryWindow
Description: The end time hour for the delivery timeframe

shipmentParameters.deliveryWindow .endWindow.minute

Type: String (byte)
Condition: Required when including deliveryWindow
Description: The end time minute for the delivery timeframe

shipmentParameters.deliveryWindow .endWindow.nano

Type: Integer (int32)
Condiiton: Required when including deliveryWindow
Description: The end time nano for the delivery timeframe

shipmentParameters.deliveryWindow .endWindow.second

Type: String (byte)
Condition: Required when including deliveryWindow
Description: The end time second for the delivery timeframe

shipmentParameters.deliveryWindow .startWindow.hour

Type: String (byte)
Condition: Required when including deliveryWindow
Description: The start time hour for the delivery timeframe

shipmentParameters.deliveryWindow .startWindow.minute

Type: String (byte)
Condition: Required when including deliveryWindow
Description: The start time minute for the delivery timeframe

shipmentParameters.deliveryWindow .startWindow.nano

Type: Integer (int32)
Condition: Required when including deliveryWindow
Description: The start time nano for the delivery timeframe

shipmentParameters.deliveryWindow .startWindow.second

Type: String (byte)
Condition: Required when including deliveryWindow
Description: The start time second for the delivery timeframe

shipmentParameters.includePackagesArray

Type: Boolean
Values: true or false
Description: If true, the packages array of details about any package(s) in the shipment is returned in the response.

shipmentParameters.shippedDateTime

Type: String (date-time)
Description: The timestamp for when a partner will ship the product from their warehouse; the timestamp must be a valid ISO 8601 timestamp. If not provided, this value defaults to orderedDateTime.

shipmentParameters.deliveredDateTime

Type: String (date-time)
Description: The timestamp for when the package was delivered; the timestamp must be a valid ISO 8601 timestamp.

shipmentParameters.testMode

Type: Boolean
Values: true or false
Description: If true, a test mode shipment will be created. Carrier selection will consider carriers and service methods in test mode, and label generation will generate a test label.

shipmentParameters.destinationAddress .company

Type: String
Description: The company name for the destination address

shipmentParameters.destinationAddress .emailAddress

Type: String
Description: The email address of the contact for the destination address

shipmentParameters.destinationAddress .street2

Type: String
Description: The second destination address line

shipmentParameters.destinationAddress .addressLineComponents

Type: Object
Example: streetName: "Fovisste Fuentes Brotantes", primaryAddressNumber: "12", secondaryAddressNumber: "302", district: "Iztacalco", neighborhood: "Agrícola Pantitlán"
Description: The address line components for the address, used for some international shipments. This is an optional object that can be included in shipmentParameters. The street1 and street2 fields should not be included if using addressLineComponents, or an error will be returned. Preferred for Mexican addresses. You can find out more about Mexican addresses in Non-U.S. Address Formats.

shipmentParameters.shipFromAddress .addressType

Type: String (enumeration)
Values: commercial, residential
Description: The type of location for the origin address

shipmentParameters.shipFromAddress .company

Type: String
Description: The company name for the origin address

shipmentParameters.shipFromAddress .name

Type: String
Description: The name of the contact for the origin address

shipmentParameters.shipFromAddress .emailAddress

Type: String
Description: The email address of the contact for the origin address

shipmentParameters.shipFromAddress .phoneNumber

Type: String
Description: The phone number of the contact for the origin address

shipmentParameters.shipFromAddress .phoneNumberCountryCode

Type: String
Description: The phone number country code of the contact for the origin address

shipmentParameters.shipFromAddress.city

Type: String
Description: The name of the city for the origin address

shipmentParameters.shipFromAddress.state

Type: String
Description: The 2-letter postal abbreviation of the state for the origin address

shipmentParameters.shipFromAddress .street1

Type: String
Description: The first address line

shipmentParameters.shipFromAddress .street2

Type: String
Description: The second address line

shipmentParameters .useShipFromAddressInRequest

Type: Boolean
Values: true or false
Description: When true, this optional field overrides the shipper's contact name and address configured for the shipping origin in the Shipium Console, opting to use the shipFromAddress information passed in the API call.
Note: If shipping with carrier LaserShip, use caution with this flag as the carrier's strict address matching could result in an error.

shipmentParameters.emergencyResponseInfo

Type: Object
Description: Emergency response contact details for hazmat shipments. Contains optional fields for phoneNumber (String, max 25 characters), contactName (String, max 35 characters), and contractNumber (String, max 35 characters). When not provided, the system falls back to shipFromAddress contact information. Supported by UPS and FedEx. See Hazardous Materials for field details and carrier-specific guidance.

shipmentParameters.returnToAddress.name

Type: String
Description: The name associated with the address of the location where the package is being returned. This return-to address will override a return-to address configured for an origin or carrier account. The returnToAddress object is included in the sample call for carrier selection without label generation.

shipmentParameters.returnToAddress .phoneNumber

Type: String
Description: The phone number of the contact associated with the address of the location where the package is being returned. This return-to address will override a return-to address configured for an origin or carrier account.

shipmentParameters.returnToAddress .phoneNumberCountryCode

Type: String
Description: The phone number country code of the contact associated with the address of the location where the package is being returned. This return-to address will override a return-to address configured for an origin or carrier account.

shipmentParameters.returnToAddress .emailAddress

Type: String
Description: The email address of the contact associated with the address of the location where the package is being returned. This return-to address will override a return-to address configured for an origin or carrier account.

shipmentParameters.returnToAddress.company

Type: String
Description: The company of the contact associated with the address of the location where the package is being returned. This return-to address will override a return-to address configured for an origin or carrier account.

shipmentParameters.returnToAddress.street1

Type: String
Description: The first address line of the location where the package is being returned. This return-to address will override a return-to address configured for an origin or carrier account.

shipmentParameters.returnToAddress.street2

Type: String
Description: The second address line of the location where the package is being returned. This return-to address will override a return-to address configured for an origin or carrier account.

shipmentParameters.returnToAddress.city

Type: String
Description: The city of the location where the package is being returned. This return-to address will override a return-to address configured for an origin or carrier account.

shipmentParameters.returnToAddress.state

Type: String
Description: The 2-letter abbreviation of the location's state where the package is being returned. This return-to address will override a return-to address configured for an origin or carrier account.

shipmentParameters.returnToAddress .addressType

Type: String (enumeration)
Values: commercial, residential
Description: The type of location for the return-to address. This return-to address will override a return-to address configured for an origin or carrier account.

shipmentParameters.orderItemQuantities .partnerOrderId

Type: String
Example: myCustomPartnerOrderId123
Description: The unique identifier representing the order

shipmentParameters.orderItemQuantities .deliveryEstimateId

Type: String
Description: The delivery estimate ID associated with the product

shipmentParameters.orderItemQuantities .shipiumOrderId

Type: String
Description: Identification used to represent the group of delivery estimates purchased

shipmentParameters.orderItemQuantities .hazmat

Type: Boolean
Values: true or false
Description: If true, this indicates that the item is hazardous material (hazmat). The default value is false. For hazmat requirements, you can refer to Hazardous Materials.

shipmentParameters.orderItemQuantities .orderItemReferenceIdentifier

Type: String
Example: someIdentifier
Description: An external identifier that can reference the order item that exists in an external order management system (OMS). This field will be passed to supported carriers.

shipmentParameters.orderItemQuantities .productTaxCode

Type: String
Description: The tax code that applies to the given product

shipmentParameters.orderItemQuantities .itemWeight.weightUnit

Type: String (enumeration)
Values: g (gram), kg (kilogram), lb (pound), oz (ounce)
Description: The unit in which weight values are provided

shipmentParameters.orderItemQuantities .itemWeight.weight

Type: Number (float)
Example: 50
Description: The value of the weight

shipmentParameters.packagingType .packagingSizeName

Type: String
Example: 13x12x10 box
Description: A custom name for the packaging

shipmentParameters.packagingType .packagingWeight.weight

Type: Number (float)
Example: 50
Description: The value of the weight

shipmentParameters.packagingType .packagingWeight.weightUnit

Type: String (enumeration)
Values: g (gram), kg (kilogram), lb (pound), oz (ounce)
Description: The unit in which weight values are provided

shipmentParameters.totalWeight.weight

Type: Number (float)
Example: 50
Description: The value of the weight

shipmentParameters.totalWeight.weightUnit

Type: String (enumeration)
Values: g (gram), kg (kilogram), lb (pound), oz (ounce)
Description: The unit in which weight values are provided

shipmentParameters.fulfillmentContext

Type: String
Description: This is used to limit carrier selection to carrier accounts that contain a matching fulfillment context.

shipmentParameters.fulfillmentContextIds

Type: String
Description: A collection of fulfillment context IDs or fulfillment context aliases to use in the fulfillment context detail search

shipmentParameters.fulfillmentType

Type: String (enumeration)
Values: at_large, customer, hundredweight, reship, returns, unknown
Description: The fulfillment methodology of the shipment

shipmentParameters.partnerShipmentId

Type: String
Description: An optional unique identifier that may be used for the shipment

shipmentParameters.purchaseOrderIdentifier

Type: String
Description: String passed to carriers as a purchase order identifier

shipmentParameters.referenceIdentifier

Type: String
Description: String passed to carriers as a reference. This field can be expanded to include multiple reference identifiers by adding sequential numbers to the field name: referenceIdentifier2 (up to 5 reference identifiers).

shipmentParameters .partnerReferenceIdentifier

Type: String
Description: An optional identifier your organization provides, used for reporting and cross-product correlation across Shipium APIs. Pass the same value you used in your Delivery Promise and Fulfillment Engine calls to correlate this order across the full API chain. This value is not passed to carriers. See Link API Calls Across Shipium Products for the full cross-product linking guide.

shipmentParameters .partnerReferenceIdentifier2

Type: String
Description: An optional secondary identifier your organization provides for additional reporting or correlation context. This value is not passed to carriers.

shipmentParameters.carrierProcessingId

Type: String
Description: Carrier-provided identifier; supplied when it is needed to process the shipment

shipmentParameters.shipOption

Type: String
Example: standard
Description: A high-level shipping option shown to or selected by a customer

shipmentParameters.shipmentTags

Type: String
Description: A collection of free-form tags that may be added to the shipment

shipmentParameters.tenantId

Type: String
Description: Either the Shipium Tenant ID or the Tenant ID provided by your organization (Partner Provided ID). When present, this is used to indicate the tenant associated with the shipment.

shipmentParameters.businessDaysOfTransit

Type: Integer (int32)
Example: 3
Description: Indicates the number of business days from the ship time by when the shipment needs to be delivered

shipmentParameters.carrierName

Type: String
Example: ups
Description: The carrier that was used for delivering the package

shipmentParameters.carrierTrackingId

Type: String
Description: The carrier-assigned tracking identifier. While typically generated by the carrier and returned in the response, this field can be passed in the request for specific carriers that require a pre-allocated tracking ID or barcode to be provided by the shipper at the time of label creation.

shipmentParameters.deliveryNote

Type: String
Description: String passed to carriers for a delivery note

shipmentParameters.deliverySignatureOption

Type: String (enumeration )
Values: AdultResidentSignature, AdultSignature, None, ResidentSignature, Signature, Unknown
Description: A delivery signature option passed in the API request. The default value is None.

shipmentParameters.deliveryWindow.timeZone

Type: String
Description: The time zone for this delivery window. If no time zone is passed, the time zone will be taken from the destination address.

shipmentParameters.desiredDeliveryDate

Type: String (date-time) Example: 2019-10-31T20:00:00Z
Description: The string representation of either an ISO-8601 date or a local date for desired delivery: yyyy-mm-dd. The date or date-time the package is intended to arrive to the customer. This is used to determine the most appropriate service method when generating a label.

shipmentParameters.desiredDeliveryDateOptions .guaranteedDateDelivery

Type: Boolean
Values: true or false
Description: If true, this indicates that your organization is willing to accept any applicable carrier date certain surcharge to the estimated label cost. Not all carriers support guaranteed date delivery. This restricts carrier selection to service methods that can support guaranteed date delivery.

shipmentParameters.desiredDeliveryDateOptions .exactDateDelivery

Type: Boolean
Values: true or false
Description: If true, this instructs the carrier to deliver the package on the date provided in the desiredDeliveryDate field. Desired, Exact, & Guaranteed Delivery Dates provides details on exact date delivery.

shipmentParameters.desiredDeliveryDateOptions .upgradeCostDeltaMax

Type: String
Description: If set, this is the maximum amount of additional spend that your organization is willing to pay to upgrade a shipment to the desired delivery date (DDD) if the lowest cost carrier service method is unable to safely meet the DDD.

shipmentParameters.desiredDeliveryDateOptions .currencyCode

Type: String
Description: The ISO 4217 currency code of the upgradeCostDeltaMax

shipmentParameters.desiredDeliveryDateOptions .timeInTransitSetting

Type: String (enumeration)
Values: very_conservative, conservative, standard, aggressive
Description: Including this field in your API call will override any time-in-transit setting configuration, on a per shipment basis.

shipmentParameters .preferredCarrierDeliveryDateTime

Type: String (date-time)
Description: The string representation of either an ISO 8601 date; the date-time the package is intended to arrive to the customer. This will be passed through to the carrier.

shipmentParameters.saturdayDelivery

Type: String
Description: If you pass saturdayDelivery, you can specify whether or not you want Saturday delivery to be an option for this package.
Note: This does not guarantee a Saturday delivery.

shipmentParameters.forceThirdPartyBilling

Type: Boolean
Values: true or false
Description: If true, this indicates that third party billing is a requirement for this shipment. No service method should be selected that does not support third party billing.

shipmentParameters.thirdPartyBillingSetId

Type: String
Description: Either the Shipium third party billing set ID or the third party billing set ID provided by your organization. When present, this is used to indicate the third party billing set that should be used for the billing of the shipment.

shipmentParameters.thirdPartyBillingAccounts

Type: Array of thirdPartyBillingAccounts objects
Description: Include third party billing account information in calls to Shipium's APIs without configuring your third party billing account in the Shipium Console. You can find out how to do so in Bill a Third Party.

shipmentParameters.ignoreUpgradeSpendLimits

Type: Boolean
Values: true or false
Description: If true, this indicates that the shipment can ignore all of your organization's configured upgrade limits for the potential upgrade required to deliver the shipment by the desired delivery date.

shipmentParameters.configurationOverrides .maximumAdditionalDaysToHold

Type: Integer
Description: To optimize shipping costs, you can leverage the Maximum Additional Days to Hold feature. This optional setting allows your organization to instruct the system to consider holding a shipment at your fulfillment center for a specified number of extra days, beyond the originally requested ship date, if doing so enables the selection of a more economical carrier service. You can find more information about this feature in Additional Days to Hold a Shipment.

shipmentParameters.customsInfo .taxIdentificationNumber

Type: String
Example: 12345
Description: This optional value can be passed to override any tax ID number (also known as an employer identification number, or EIN) that is configured in your network settings (e.g., at the tenant level for a fulfillment context), on a per-shipment basis. This value also can be passed in multiParcelShipmentParameters.customsInfo for a multi-parcel shipment. You can find more information in Tax Identification Number.

shipmentParameters.documentGenerationRequests

Type: Array
Description: List of Document Blueprints to generate alongside the shipment label. Omit or pass an empty array to suppress document generation.

shipmentParameters.documentGenerationRequests[] .documentBlueprintId

Type: String
Required when documentGenerationRequests is included
Description: The ID of the Document Blueprint to generate. Accepts either the Shipium-generated UUID or the alias configured for your account.

shipiumShipmentId

The unique identifier for the shipment

partnerShipmentId

The optional unique identifier that may be used for the shipment

orderedDateTime

The timestamp for when the customer placed an order for the product

shippedDateTime

The timestamp for when you (or your fulfillment partner) shipped the product from your (or their) warehouse

rawDesiredDeliveryDate

The timestamp passed in by you (or your fulfillment partner) for the intended date the package will arrive to the customer

desiredDeliveryDate

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 date-time for carrier selection. For desiredDeliveryDateOptions details, see Desired, Exact, & Guaranteed Delivery Dates.

desiredDeliveryDateLocal

The timestamp for the adjusted desired delivery date, expressed in local time at the destination address; this date includes all adjustments that Shipium has made to the requested desired delivery date. Shipium will use this date-time for carrier selection. For desiredDeliveryDateOptions details, see Desired, Exact, & Guaranteed Delivery Dates.

preferredCarrierDeliveryDateTime

The string representation of an ISO-8601 date; the date-time the package is intended to arrive to the customer; this will be passed through to the carrier.

returnsLabel

A representation of the return label generated along with the original shipment label; see Return Labels for details.

returnsLabel.carrier

Unique ID of the carrier used for the return label

returnsLabel.carrierServiceName

Name of the carrier service for which the return label was generated

returnsLabel.serviceMethodName

Name of the service method for which the return label was generated

returnsLabel.carrierServiceMethodId

Maps to the unique internal Shipium ID that represents a carrier service method definition; see Supported Carriers for a list of carrier service method IDs.

businessDaysOfTransit

Indicates the number of business days from the ship time by when the shipment needs to be delivered

estimatedDeliveryDate

The date and time by when the package is estimated to be delivered to the customer; included in the response when either a desired delivery date or business days of transit value is included in the call request.

estimatedDeliveryDateLocal

The date and time by when the package is estimated to be delivered to the customer, expressed in local time at the destination address; included in the response when either a desired delivery date or business days of transit value is included in the call request.

destinationTimezoneId

An identifier for the destination address timezone

originTimezoneId

An identifier for the origin address timezone

ignoreUpgradeSpendLimits

Indicates that the shipment can ignore all of your pre-configured upgrade limits for the potential upgrade required to deliver the shipment by the desired delivery date

deliveredDateTime

The timestamp for when the package was delivered to the customer

cancellationDateTime

The timestamp for when a shipment is canceled; this field will default to null when the shipment is not canceled. A shipment cannot be canceled after a label has been created.

fulfillmentType

Fulfillment methodology of the shipment

carrierName

The carrier that was used for delivering the package to your customer

carrierTrackingId

The carrier's tracking identification for the package

packages

A list of packages comprising the shipment; this is for multi-parcel shipments only.

orderItemQuantities

A list of order items comprising the package; see the request fields in the previous table for the complete list of fields and descriptions.

destinationAddress

See the request fields in the previous table for the complete list of fields and descriptions.

shipOption

A high-level shipping option shown to or selected by a customer

shipFromAddress

See the request fields in the previous table for the complete list of fields and descriptions.

returnToAddress

See the request fields in the previous table for the complete list of fields and descriptions.

injectionAddress

The address of the location where the package is being returned; this is for inclusion of injection sites only. See the request fields in the previous table for either the destinationAddress or shipFromAddress object for the complete list of fields and descriptions.

fulfillmentCenterId

The Shipium identifier for the fulfillment center where the shipment will depart

fulfillmentContextId

The Shipium identifier for the fulfillment context where the shipment will depart

partnerFulfillmentContextId

Your organization's alias for the fulfillment context where the shipment will depart

requestFulfillmentContextIds

A collection of fulfillment context IDs or fulfillment context aliases used in the fulfillment context detail search

packagingType

Fields describing the physical properties of the package; see the request fields in the previous table for the complete list of fields and descriptions.

totalWeight

The weight of this type of packaging empty; see the request fields in the previous table for the complete list of fields and descriptions.

shipmentTags

A collection of free-form tags that may be added to this shipment

carrierSelection.status

Defines the result of the carrier selection call; values returned will be success, no_decision, or [uncosted](https://docs.shipium.com/v2.0/docs/labels-without-costing) .

carrierSelection.statusDetails

Details explaining the result status; pertinent when the status is no_decision

carrierSelection.carrierSelectionId

Unique ID of the carrier selection for later reference

carrierSelection.shipiumShipmentId

The unique identifier for the shipment

carrierSelection.partnerShipmentId

The optional unique identifier that may be used for the shipment

carrierSelection.partnerId

Your organization's unique ID

carrierSelection.carrierAccountId

Unique ID of the carrier account selected for shipping

carrierSelection.serviceMethodUrn

Specific version of the service level of the shipping carrier selected

carrierSelection.serviceMethodIdentifier

Identifier of the specific version of the service method of the shipping carrier selected

carrierSelection.carrier

The carrier that was used for delivering the package to your customer

carrierSelection.carrierServiceMethodId

Maps to the unique internal Shipium ID that represents a carrier service method definition; see Supported Carriers for a list of carrier service method IDs.

carrierSelection.serviceMethodName

Name of the carrier service method selected during the carrier selection process

carrierSelection.totalCost

Cost used for carrier selection

carrierSelection.carrierCompareCost

Expected cost from the carrier label create

carrierSelection.carrierInvoiceCost

Expected cost that carrier will charge at billing time

carrierSelection.operationalCost

Carrier invoice cost plus operational costs such as injection line haul

carrierSelection.thirdPartyBilling

Indicates if the selected service method will be billed to a third party

carrierSelection.carrierSelectionDateTime

ISO-8601 formatted date when the carrier selection decision was made

carrierSelection.injectionDetails

Injection profile and injection site details; see Injection for information about injection sites.

carrierSelection.carrierZoneId

The carrier zone that is being considered

carrierSelection.evaluatedServiceMethods

An optional expansion of what carrier service methods were eligible but went unselected

carrierSelection.evaluatedServiceMethods .carrier

The carrier that was used for delivering the package to your customer

carrierSelection.evaluatedServiceMethods .carrierServiceMethodId

The carrier service method ID for the service method

carrierSelection.evaluatedServiceMethods .serviceMethodName

Name of the carrier service method selected during the carrier selection process

carrierSelection.evaluatedServiceMethods .carrierAccountId

Unique ID of the carrier account selected for shipping

carrierSelection.evaluatedServiceMethods .totalCost

Cost used for carrier selection

carrierSelection.evaluatedServiceMethods .estimatedDeliveryDate

The estimated date that the shipment will arrive at its destination

carrierSelection.evaluatedServiceMethods .estimatedDeliveryDateLocal

The estimated date that the shipment will arrive at its destination, expressed in local time at the destination address. This field is present when the destination timezone can be determined.

carrierSelection.evaluatedServiceMethods .injectionDetails

Injection profile and injection site details; see Injection for information about injection sites.

carrierSelection.evaluatedServiceMethods .rateCurrency

The currency of the rate for the selected carrier and service method, which also applies to lineItems

carrierSelection.evaluatedServiceMethods .lineItems.name

The name of the rate modification

carrierSelection.evaluatedServiceMethods .lineItems.carrierSurchargeId

The identifier for the carrier surcharge

carrierSelection.evaluatedServiceMethods .lineItems.surchargeType

The type of surcharge for this item; a null value will result for non-surcharges.

carrierSelection.evaluatedServiceMethods .lineItems.lineItemType

The type of rate line item for this rate modification

carrierLabel

This is populated if a label is generated for the carrier and service determined by carrier selection.

carrierLabel.shipiumShipmentId

The unique identifier for the shipment

carrierLabel.partnerShipmentId

The optional unique identifier that may be used for the shipment

carrierLabel.carrierSelectionId

Unique ID of the carrier selection for later reference

carrierLabel.shipiumTenantId

The Shipium-generated tenant ID. When present, this is used to indicate the tenant associated with the shipment.

carrierLabel.partnerTenantId

The tenant ID provided by your organization. When present, this is used to indicate the tenant associated with the shipment.

carrierLabel.status

Defines the result of the carrier label call; values returned will be success, failure, voided, failover, generated, label_created, manifested, and manifest_failure.

carrierLabel.statusDetails

Details explaining the result status; pertinent when the status is partial or failed

carrierLabel.effectiveShipDateTime

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.

estimatedInjectionDateTime

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.

carrierLabel.labelCreationDateTime

The timestamp that the label object was created; this is used primarily for explaining future dated shipments.

carrierLabel.serviceMethodIdentifier

The URN used to identify the service method for your organization

carrierLabel.carrier

Unique ID of the carrier

carrierLabel.carrierServiceName

Name of the carrier for which the label was generated

carrierLabel.serviceMethodName

Name of the service method for which the label was generated

carrierLabel.carrierServiceMethodId

Maps to the unique internal Shipium ID that represents a carrier service method definition; see Supported Carriers for a list of carrier service method IDs.

carrierLabel.carrierShipmentId

Carrier's identification for the shipment

carrierLabel.carrierTrackingId

Carrier's tracking identification for the package

carrierLabel.shipiumTrackingId

Shipium's tracking identification for the package

carrierLabel.carrierTrackingLink

Carrier's direct tracking link (URL) for the package

carrierLabel.carrierGroupId

Carrier's identification for grouping multiple packages together (for example, Canada Post groups shipments for manifesting)

carrierLabel.packageScannableId

Identifier provided that matches the scannable barcode on the label

partnerThirdPartyBillingAccountId

The ID that your organization provided for the third party billing account that was used if the label was billed to a third party

shipiumThirdPartyBillingAccountId

The Shipium-generated ID of the third party billing account that was used if the label was billed to a third party

thirdPartyBillingForDutiesAndTaxes

Whether or not the third party paid the taxes and duties

carrierLabel.carrierLabelCurrencyCode

Currency code of the price of the label

carrierLabel.carrierLabelPrice

Cost charged by the carrier for shipping the package at the chosen service level

carrierLabel.billableWeight.weightUnit

The unit in which weight values are provided

carrierLabel.billableWeight.weight

The value of the weight

carrierLabel.documents.labelExpiration

Date-time when the label expires and is no longer valid

carrierLabel.documents.labelFormat

Defines the format the shipment label was generated in by the carrier

carrierLabel.documents.labelProperties

Metadata describing the label

carrierLabel.documents.labelProperties .height

Top to bottom measurement of the label

carrierLabel.documents.labelProperties .width

Right to left measurement of the label

carrierLabel.documents.labelProperties .linearUnits

The linear units representing the label height and label width

carrierLabel.documents.labelProperties.dpi

The dpi (dots per inch) used by the label printer

carrierLabel.documents.labelProperties .labelOrientation

The direction that the label will be printed

carrierLabel.documents.labelProperties .nonZplLabelDimensions

The dimensions used to print non-ZPL labels, if they need to be different than ZPL dimensions

carrierLabel.documents.labelImage .imageEncoding

Format in which the imageContents field is encoded (e.g., Base64)

carrierLabel.documents.labelImage .imageContents

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.

carrierLabel.documents.labelUrl

The link to the shipment label file

carrierLabel.documents.carrierTrackingId

The tracking ID associated with the label

carrierLabel.documents.carrierTrackingLink

The tracking link associated with the label

carrierLabel.documents .packageReferenceIdentifier

The package reference ID that was passed in by the customer to be associated with the package; this is most frequently used for multi-parcel shipments. This can be used to cross reference international documents and carrier labels.

carrierLabel.documents.packageScannableId

The package scannable ID associated with the label

carrierLabel.documents.carrierShipmentId

The carrier shipment ID associated with the label

carrierLabel.internationalDocuments

List of international customs documents generated by the carrier for the shipment; see Customs Info for Shipments for details.

carrierLabel.labelFailoverOccurred

When true, signifies that label creation failover logic was exercised

carrierLabel.labelFailoverDetails

Provides legacy and detailed debugging information on the label creation attempts when failover logic is used

carrierLabel.trackingInfo

Details of the tracking history and status of the package

carrierLabel.testMode

A flag denoting whether the label is a test label

carrierLabel.multiParcel

A flag denoting whether the label is for multi-parcel shipments

shipmentRequestedDocuments

Generated documents corresponding to each blueprint included in documentGenerationRequests. Present in the response only when document generation was requested.

shipmentRequestedDocuments[].documentBlueprintId

The Shipium-generated UUID of the blueprint used

shipmentRequestedDocuments[] .partnerProvidedDocumentBlueprintId

The alias your organization provided for the blueprint, if one was configured

shipmentRequestedDocuments[].documentFormat

Output format of the generated document. Configured on the blueprint in the Shipium Console. Supported formats: ZPL, PNG, PDF

shipmentRequestedDocuments[] .documentImage.documentEncoding

Encoding format of the document contents (BASE64)

shipmentRequestedDocuments[].documentImage .documentContents

The base64-encoded document content

customsInfo

Customs information about the package for international shipping; see Customs Info for Shipments for details.

saturdayDelivery

Indicates that this shipment is marked for Saturday delivery; does not guarantee delivery on Saturday

deliverySignatureOption

Indicates the delivery signature option selected for the shipment

deliveryWindow

A preferred delivery window passed to the carrier as a delivery note

deliveryNote

String passed to carriers for a delivery note

forceThirdPartyBilling

Indicates that third party billing is forced for this shipment

requestThirdPartyBillingSetId

Either the Shipium third party billing set ID or the third party billing set ID provided by your organization; when present, this is the third party billing set ID sent on the request.

referenceIdentifier

String passed to carriers as a reference

partnerReferenceIdentifier

String provided by your organization that was passed to carriers as a reference

partnerReferenceIdentifier2

String provided by your organization that was passed to carriers as a reference2

purchaseOrderIdentifier

String passed to carriers as a purchase order identifier

carrierProcessingId

Carrier-provided identifier; supplied when it is needed to process the shipment

fulfillmentContext

When present, this is used to limit carrier selection to carrier accounts that contain a matching fulfillment context.

requestTenantId

Either the Shipium tenant ID or the tenant ID provided by your organization; when present, this is the tenant ID sent on the request.

createdWithVersion

The version used when creating the shipment: v1 or v2.

shipmentProperties

A list of high-level properties about the shipment

multiParcel

Indicates if the shipment is multi-parcel

testMode

A flag denoting whether the shipment is a test shipment