Get started

Creating shipping labels in batches is possible through the Batch Label Creation API, which enables your organization to retrieve labels for up to 150 shipments in one API call to Shipium's Carrier and Method Selection service.

This document provides guidance for using the Batch Label Creation API. The Carrier and Method Selection & Shipment Labels document provides more information about setting up your organization's account to use the Carrier and Method Selection service and print labels.

Retrieve batch shipping labels from the Batch Label Creation API

The Shipium Batch Label Creation API assumes you're using one of the authentication mechanisms detailed in our authentication documentation. The endpoint for Batch Label Creation API calls is included in the table below.

API type	API endpoint
POST	https://api.shipium.com/api/v1/shipment/bulkprocessing/labels

📘
Authentication for API Calls
In the cURL example on this page, the environment variable AUTHSTRING is used to handle authorization. The recipe below shows how to set it correctly for both API Key and OAuth users.

🔐

Authenticating for Curl

Open Recipe

The following table provides the required and optional fields for calling the Batch Label Creation API.

Request field	Required/Optional	Field properties	Description
`options.currencyCode`	Optional	String	The default currency in which all the rates for shipping carrier selection costs will be calculated; if this is specified on an individual shipment request, that value will be used instead for that shipment.
`options .fulfillmentContext`	Optional	String	The default fulfillment context to be specified across all requests; if this is specified on the individual request's shipmen parameters payload, that value will be used instead for that shipment.
`options.megaProcess VersionOverride`	Optional	String	Override for all-in-one carrier selection and label call process version; this will apply to all shipments in the request.
`options.tenantId`	Optional	String	The default tenant ID to be specified across all requests; if this is specified on the individual request's shipment parameters payload, that value will be used instead for that shipment.
`options.includeFull ShipmentResponses`	Optional	String	Indicates whether to return the full shipment response; if not specified, the full payload will be returned by default.
`shipmentRequests .asOfDate`	Optional, for Simulation only	String	Date used to re-create a carrier selection as of a certain point in time; this field not being set is assumed to mean "now".
`shipmentRequests .currencyCode`	Required	String Ex.: usd	Currency in which all the rates for shipping carrier selection costs will be calculated
`shipmentRequests .generateLabel`	Optional	Boolean `True` or `False`	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.
`shipmentRequests .includeInjection Profiles`	Optional	Boolean `True` or `False`	When `true`, service methods from the configured injection profiles will be considered during carrier selection.
`shipmentRequests .injectionParameters .injectionProfileId`	Optional, but required if providing an `injectionSiteId`	String	The Shipium ID or the ID that your organization provided for an injection profile that should be considered during carrier selection
`shipmentRequests .injectionParameters .injectionSiteId`	Optional	String	The Shipium ID or the ID that your organization provided for an injection site that should be considered during carrier selection; if an `injectionSiteId` is specified, it must be accompanied by an `injectionProfileId`.
`shipmentRequests .labelParameters .currencyCode`	Optional	String	Currency in which all the rates for shipping carrier selection costs will be calculated
`shipmentRequests .labelParameters .customLabelEntries .additionalProp1`	Optional	String	List of formats in which to generate the package label
`shipmentRequests .labelParameters .includeLabelImages InResponse`	Optional	Boolean `True` or `False`	When `true`, the response will include the raw image data of the labels that were requested to be generated by the carrier.
`shipmentRequests .labelParameters .labelFormats`	Optional	String enumeration Values are: - pdf - png - zpl	List of formats in which to generate the package label
`shipmentRequests .labelParameters .manifest`	Optional	Boolean `True` or `False`	When `true`, a manifest for the label is generated.
`shipmentRequests .labelParameters .testMode`	Optional	Boolean `True` or `False`	When `true`, calls to generate the labels will be made to the carrier sandbox servers. No actual labels are created, only a representation of the label. No money is charged to the underlying account.
`shipmentRequests .shipmentParameters .businessDays OfTransit`	Optional	Integer ($int32)	Indicates the number of business days from the ship time by when the shipment needs to be delivered
`shipmentRequests .shipmentParameters .carrierName`	Optional	String Ex.: UPS	The carrier that was used for delivering the package to your customer
`shipmentRequests .shipmentParameters .carrierTrackingId`	Optional	String Ex.: 1Z999AA10123456784	Carrier's tracking identification for the package
`shipmentRequests .shipmentParameters .customsInfo`	Optional, but some information is required for international shipments	Object	Customs information about the package for international shipping; please refer to Customs Info for Shipments for details.
`shipmentRequests .shipmentParameters .deliveredDateTime`	Optional	String Ex.: 2019-10-31T20:00:00Z	Either an ISO-8601 date or a local date: yyyy-mm-dd; the date or date-time the package is intended to arrive to the customer; this will be used to determine the most appropriate service method when generating a label.
`shipmentRequests .shipmentParameters .deliveryNote`	Optional	String	String passed to carriers for a delivery note.
`shipmentRequests .shipmentParameters .deliverySignature Option`	Optional	String enumeration Values are: - None - Signature - Resident_Signature - Adult_Signature - Adult_Resident_Signature - Unknown	A delivery signature option passed in the API request; defaults to `none`.
`shipmentRequests .shipmentParameters .deliveryWindow .endWindow.hour`	Required	String ($byte)	The end time hour for the delivery timeframe
`shipmentRequests .shipmentParameters .deliveryWindow .endWindow.minute`	Required	String ($byte)	The end time minute for the delivery timeframe
`shipmentRequests .shipmentParameters .deliveryWindow .endWindow.nano`	Required	Integer ($int32)	The end time nano for the delivery timeframe
`shipmentRequests .shipmentParameters .deliveryWindow .endWindow.second`	Required	String ($byte)	The end time second for the delivery timeframe
`shipmentRequests .shipmentParameters .deliveryWindow .startWindow.hour`	Required	String ($byte)	The start time hour for the delivery timeframe
`shipmentRequests .shipmentParameters .deliveryWindow .startWindow.minute`	Required	String ($byte)	The start time minute for the delivery timeframe
`shipmentRequests .shipmentParameters .deliveryWindow .startWindow.nano`	Required	Integer ($int32)	The start time nano for the delivery timeframe
`shipmentRequests .shipmentParameters .deliveryWindow .startWindow.second`	Required	String ($byte)	The start time second for the delivery timeframe
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.id`	Optional	String	The time zone identifier for this delivery window; if no time zone is passed, time zone will be taken from the destination address.
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .fixedOffset`	Optional	Boolean `True` or `False`	If `true`, this indicates there is a fixed offset.
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .dayOfMonth Indicator`	Optional	Integer ($int32)	The day of the month for the transition rule(s)
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .dayOfWeek`	Optional	String enumeration Values are: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday	The day of the week for the transition rule(s)
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .localTime.hour`	Optional	Integer ($int32)	The local time hour for the transition rule(s)
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .localTime.minute`	Optional	Integer ($int32)	The local time minute for the transition rule(s)
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .localTime.nano`	Optional	Integer ($int32)	The local time nano for the transition rule(s)
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .localTime.second`	Optional	Integer ($int32)	The local time second for the transition rule(s)
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .midnightEndOfDay`	Optional	Boolean `True` or `False`	If `true`, midnight is considered end of day.
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .month`	Optional	String enumeration Values are: - January - February - March - April - May - June - July - August - September - October - November - December	The month for the transition rule(s)
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .offsetAfter.id`	Optional	String	The identifier for the offset after
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .offsetAfter.rules`	Optional	String	The rules for the offset after
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .offsetAfter .totalSeconds`	Optional	Integer ($int32)	The total seconds for the offset after
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .offsetBefore.id`	Optional	String	The identifier for the offset before
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .offsetBefore.rules`	Optional	String	The rules for the offset before
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .offsetBefore .totalSeconds`	Optional	Integer ($int32)	The total seconds for the offset before
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .standardOffset.id`	Optional	String	The identifier for the standard offset
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .standardOffset .rules`	Optional	String	The rules for the standard offset
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .standardOffset .totalSeconds`	Optional	Integer ($int32)	The total seconds for the standard offset
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitionRules .timeDefinition`	Optional	String enumeration Values are: - UTC - Wall - Standard	The type of time for the transition rule(s)
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .dateTimeAfter`	Optional	String	The date-time after the transition rule(s)
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .dateTimeBefore`	Optional	String	The date-time before the transition rule(s)
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .duration.nano`	Optional	Integer ($int32)	The nano value for the duration of the transition
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .duration.negative`	Optional	Boolean `True` or `False`	If `true`, the duration is a negative value.
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .duration.seconds`	Optional	Integer ($int32)	The seconds value for the duration of the transition
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .duration.units .dateBased`	Optional	Boolean `True` or `False`	If `true`, the duration units are based on date.
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .duration.units .duration`	Optional	String	The duration of the transition
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .duration.units .durationEstimated`	Optional	Boolean `True` or `False`	If `true`, the duration is estimated.
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .duration.units .timeBased`	Optional	Boolean `True` or `False`	If `true`, the duration units are based on time.
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .duration.zero`	Optional	Boolean `True` or `False`	If `true`, the duration value is zero.
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions.gap`	Optional	Boolean `True` or `False`	If `true`, there is a gap in the duration.
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .instant`	Optional	String	The instant of the transition
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .offsetAfter.id`	Optional	String	The identifier for the offset after
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .offsetAfter.rules`	Optional	String	The rules for the offset after
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .offsetAfter .totalSeconds`	Optional	Integer ($32)	The total seconds for the offset after
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .offsetBefore.id`	Optional	String	The identifier for the offset before
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .offsetBefore.rules`	Optional	String	The rules for the offset before
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .offsetBefore .totalSeconds`	Optional	Integer ($int32)	The total seconds for the offset before
`shipmentRequests .shipmentParameters .deliveryWindow .timeZone.rules .transitions .overlap`	Optional	Boolean `True` or `False`	If `true`, there is overlap for the transition.
`shipmentRequests .shipmentParameters .desiredDelivery Date`	Optional	String Ex.: 2019-10-31T20:00:00Z	Either an ISO-8601 date or a local date: yyyy-mm-dd; the date or date-time the package is intended to arrive to the customer; this will be used to determine the most appropriate service method when generating a label.
`shipmentRequests .shipmentParameters .destinationAddress .addressType`	Optional	String enumeration Values are: - Commercial - Residential	The type of location for the destination address
`shipmentRequests .shipmentParameters .destinationAddress .city`	Optional	String	The name of the city for the destination address
`shipmentRequests .shipmentParameters .destinationAddress .company`	Optional	String	The company name for the destination address
`shipmentRequests .shipmentParameters .destinationAddress .countryCode`	Required	String Ex.: US	The ISO 3166-1 country code for the destination address
`shipmentRequests .shipmentParameters .destinationAddress .emailAddress`	Optional	String	The email address of the contact for the destination address
`shipmentRequests .shipmentParameters .destinationAddress .name`	Optional	String	The name associated with the destination address
`shipmentRequests .shipmentParameters .destinationAddress .phoneNumber`	Optional	String	The phone number of the contact for the destination address
`shipmentRequests .shipmentParameters .destinationAddress .phoneNumber CountryCode`	Optional	String	The phone number country code of the contact for the destination address
`shipmentRequests .shipmentParameters .destinationAddress .postalCode`	Required	String	A country code appropriate postal code for the destination address
`shipmentRequests .shipmentParameters .destinationAddress .state`	Optional	String	The name of the state for the destination address
`shipmentRequests .shipmentParameters .destinationAddress .street1`	Optional	String	The first address line
`shipmentRequests .shipmentParameters .destinationAddress .street2`	Optional	String	The second address line
`shipmentRequests .shipmentParameters .forceThirdParty Billing`	Optional	Boolean `True` or `False`	If `true`, this indicates that third party billing is a requirement for this shipment and that no service method should be selected that does not support third party billing.
`shipmentRequests .shipmentParameters .fulfillmentContext`	Optional	String	When present, this is used to limit carrier selection to carrier accounts that contain a matching fulfillment context.
`shipmentRequests .shipmentParameters .fulfillmentType`	Optional	String enumeration Values are: - Customer - At_Large - Returns - Hundredweight - Reship - Unknown	Fulfillment methodology of the shipment
`shipmentRequests .shipmentParameters .ignoreUpgradeSpend Limits`	Optional	Boolean `True` or `False`	If `true`, this indicates that this 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.
`shipmentRequests .shipmentParameters .orderItemQuantities .deliveryEstimateId`	Optional	String Ex.: 0b3d140a-525b-43a7-896c-cdc381580d61	Delivery estimate ID associated with this product
`shipmentRequests .shipmentParameters .orderItemQuantities .hazmat`	Optional	Boolean `True` or `False`	If `true`, this indicates that the item is hazmat. The default value is `false`.
`shipmentRequests .shipmentParameters .orderItemQuantities .hazmatInfo .category`	Optional, but required if including `hazmatInfo`	String enumeration Values are: - Defined - Contains_Lithium_Ion - Packaged_Lithium_Ion - Lithium_Ion_Battery_Only - Contains_Lithium_Metal - Packaged_Lithium_Metal - Lithium_Metal_Battery_Only - Dry_Ice	Hazmat category for this order item; use `defined` to specify detailed information.
`shipmentRequests .shipmentParameters .orderItemQuantities .hazmatInfo .containerType`	Optional, but required if `category` is defined	String enumeration Values are: - 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	The material in which the hazardous material is packaged
`shipmentRequests .shipmentParameters .orderItemQuantities .hazmatInfo .hazardClass`	Optional, but required if `category` is defined	String enumeration Values are: 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	The hazard class of the hazmat
`shipmentRequests .shipmentParameters .orderItemQuantities .hazmatInfo .hazmatId`	Optional, but required if `category` is defined	String Ex.: UN1755	The International Air Transport Association (IATA) or U.S. Department of Transportation (DOT) regulatory identifier for the commodity as appropriate
`shipmentRequests .shipmentParameters .orderItemQuantities .hazmatInfo .packingGroup`	Optional	String enumeration Values are: - i - ii - iii	The packing group code for the hazardous material
`shipmentRequests .shipmentParameters .orderItemQuantities .hazmatInfo .packingInstruction Code`	Optional	String Ex.: 967	The packing instruction code used for air transport
`shipmentRequests .shipmentParameters .orderItemQuantities .hazmatInfo .properShippingName`	Optional, but required if `category` is defined	String enumeration Values are: - i - ii - iii	Proper shipping name that is associated with the specified hazmat ID
`shipmentRequests .shipmentParameters .orderItemQuantities .hazmatInfo .quantity`	Optional, but required if `category` is defined	Number ($float) Ex.: 2.1	The amount of quantity type material in quantity units
`shipmentRequests .shipmentParameters .orderItemQuantities .hazmatInfo .quantityType`	Optional, but required if `category` is defined	String enumeration Values are: - Gross - Net	Determines whether the quantity includes the raw material (net) or also includes the material housing (gross)
`shipmentRequests .shipmentParameters .orderItemQuantities .hazmatInfo .quantityUnits`	Optional, but required if `category` is defined	String enumeration Values are: - g (gram) - kg (kilogram) - lb (pound) - oz (ounce) - ml (milliliter) - l (liter)	The units of measure for the quantity of hazardous materials specified
`shipmentRequests .shipmentParameters .orderItemQuantities .hazmatInfo .subsidiaryClasses`	Optional	String Ex.: 8.1	The appropriate IATA/DOT subsidiary classes associated with the material and the hazard class
`shipmentRequests .shipmentParameters .orderItemQuantities .hazmatInfo .transportMode`	Optional, but required if `category` is defined	String enumeration Values are: - ground - passenger_and_cargo_aircraft - cargo_aircraft_only	Declares that a package was prepared according to ground, passenger aircraft, or cargo aircraft only
`shipmentRequests .shipmentParameters .orderItemQuantities .partnerOrderId`	Optional	String Ex.: myCustomPartnerOrderId123	The unique identifier representing this order
`shipmentRequests .shipmentParameters .orderItemQuantities .productDetails`	Required	String Ex.: perishable, limited_quantity	A list of properties that may affect the shipping of the product
`shipmentRequests .shipmentParameters .orderItemQuantities .productId`	Required	String Ex.: RN03947-Z43121	A product ID for the product being checked, such as ISBN and UPC
`shipmentRequests .shipmentParameters .orderItemQuantities .quantity`	Required	Integer($int32) Ex.: 3	The number of units of this product
`shipmentRequests .shipmentParameters .orderItemQuantities .shipiumOrderId`	Optional	String Ex.: 4dc43fff-c3af-4d7b-8a18-e01f2b4cb312	Identification use to represent the group of delivery estimates purchased
`shipmentRequests .shipmentParameters .orderedDateTime`	Optional	String	The timestamp for when a customer placed an order for this product; the timestamp must be a valid ISO 8601 timestamp
`shipmentRequests .shipmentParameters .packagingType .linearDimensions .height`	Optional, but required if the `packagingTypeId` is not included	Number ($float) Example: 10	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.
`shipmentRequests .shipmentParameters .packagingType .linearDimensions .length`	Optional, but required if the `packagingTypeId` is not included	Number ($float) Example: 13	The longest linear dimension (i.e., the longest side of a box or envelope)
`shipmentRequests .shipmentParameters .packagingType .linearDimensions .linearUnit`	Optional, but required if the `packagingTypeId` is not included	String enumeration Values are: - cm (centimeter) - in (inch)	The unit in which linear dimensions are provided
`shipmentRequests .shipmentParameters .packagingType .linearDimensions .width`	Optional, but required if the `packagingTypeId` is not included	Number ($float) Example: 12	The second longest linear dimension (i.e., the second longest side of a box or envelope)
`shipmentRequests .shipmentParameters .packagingType .packagingMaterial`	Optional	String enumeration Values are: - box - envelope - flat_pack - fedex_one_rate_envelope - fedex_one_rate_pak - 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	The type of packaging used to create the package for the shipment
`shipmentRequests .shipmentParameters .packagingType .packagingSizeName`	Optional	String Ex.: 13x12x10 Box	A custom name for the packaging
`shipmentRequests .shipmentParameters .packagingType .packagingTypeId`	Optional, but required if `linearDimensions` is not provided	String Ex.: ebd94f8b-d390-4c9c-987f-b88343f5bf45	The `packagingTypeId` that was used for this package; when this value is present, the dimensions pre-configured by your organization are used. When this value is absent, `linearDimensions` is required.
`shipmentRequests .shipmentParameters .packagingType .packagingWeight .weight`	Optional	Number ($float) Example: 50	The value of the weight
`shipmentRequests .shipmentParameters .packagingType .packagingWeight .weightUnit`	Optional	String enumeration Values are: - g (gram) - kg (kilogram) - lb (pound) - oz (ounce)	The unit in which weight values are provided
`shipmentRequests .shipmentParameters .partnerShipmentId`	Optional	String	An optional unique identifier that may be used for the shipment
`shipmentRequests .shipmentParameters .purchaseOrder Identifier`	Optional	String	String passed to carriers as a purchase order identifier
`shipmentRequests .shipmentParameters .reference Identifier`	Optional	String	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)
`shipmentRequests .shipmentParameters .saturdayDelivery`	Optional	Boolean `True` or `False`	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.
`shipmentRequests .shipmentParameters .shipFromAddress .addressType`	Optional	String Values are: - Commercial - Residential	The type of location for the origin address
`shipmentRequests .shipmentParameters .shipFromAddress .city`	Optional	String	The name of the city for the origin address
`shipmentRequests .shipmentParameters .shipFromAddress .company`	Optional	String	The company name for the origin address
`shipmentRequests .shipmentParameters .shipFromAddress .countryCode`	Required	String	The ISO 3166-1 country code for the origin address
`shipmentRequests .shipmentParameters .shipFromAddress .emailAddress`	Optional	String	The email address of the contact for the origin address
`shipmentRequests .shipmentParameters .shipFromAddress .name`	Optional	String	The name of the contact for the origin address
`shipmentRequests .shipmentParameters .shipFromAddress .phoneNumber`	Optional	String	The phone number of the contact for the origin address
`shipmentRequests .shipmentParameters .shipFromAddress .phoneNumber CountryCode`	Optional	String	The phone number country code of the contact for the origin address
`shipmentRequests .shipmentParameters .shipFromAddress .postalCode`	Required	String	A country-code-appropriate postal code for the origin address
`shipmentRequests .shipmentParameters .shipFromAddress .state`	Optional	String	The 2-letter postal abbreviation of the state for the origin address
`shipmentRequests .shipmentParameters .shipFromAddress .street1`	Optional	String	The first address line
`shipmentRequests .shipmentParameters .shipFromAddress .street2`	Optional	String	The second address line
`shipmentRequests .shipmentParameters .shipOption`	Optional	String Ex.: Standard	A high-level shipping option shown to or selected by a customer
`shipmentRequests .shipmentParameters .shipmentTags`	Optional	String	A collection of free-form tags that may be added to the shipment
`shipmentRequests .shipmentParameters .shippedDateTime`	Optional	String ($date-time)	The timestamp for when you shipped the product from your warehouse; the timestamp must be a valid ISO 8601 timestamp.
`shipmentRequests .shipmentParameters .tenantId`	Optional	String	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.
`shipmentRequests .shipmentParameters .thirdPartyBilling SetId`	Optional	String	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.
`shipmentRequests .shipmentParameters .totalWeight.weight`	Optional	Number ($float)	The value of the weight
`shipmentRequests .shipmentParameters .totalWeight .weightUnit`	Optional	String enumeration Values are: - g (gram) - kg (kilogram) - lb (pound) - oz (ounce)	The unit in which weight values are provided
`shipmentRequests .simulation`	Optional	Boolean `True` or `False`	If `true`, this will run a carrier selection rate calculation only and not store the results. Setting this to `true` also allows setting of the field `asOfDate` to a value in the past.

Test the API call

The ping endpoint for testing your API call is included in the following table.

API type	API endpoint
PING	https://api.shipium.com/api/v1/shipment/bulkprocessing/ping

Successfully calling the API endpoint will result in the following 200 response.

{
    "info": "pong",
    "status": 1
}

An error calling the API endpoint will result in the following 400 response.

{
    "statusCode": 401,
    "code": "ERR_BAD_REQUEST",
    "error": "Unauthorized",
    "message": "Request failed with status code 401"
}

👉
Test mode
Want to run some examples and not charge any real money against your account?
You can add testMode: "true" to the data passed to any label call to retrieve labels without charging money in a carrier-specific manner. Most carriers will mark their labels in a way to make clear that they are void, such as inserting "VOID" throughout the label or using a predefined ID.
The example below contains the testMode flag to err on the side of caution – remove it to make production calls.

Example cURL call

curl --request POST   
  --url https://api.shipium.com/api/v1/shipment/bulkprocessing/labels
  --header 'accept: application/json' 
  --header $AUTHSTRING  
  --header 'content-type: application/json'  
  --data 'INSERT REQUEST BODY FROM BELOW'

Example request body

You have the option to request full shipment details with the API response when calling the Batch Label Creation API, but the default setting is to exclude those details from the response. To include full shipment details, the value for includeFullShipmentResponses should be set to true.

{
  "options": {
    "currencyCode": "string",
    "fulfillmentContext": "string",
    "megaProcessVersionOverride": "string",
    "tenantId": "string",
    "includeFullShipmentResponses": false //Default by false or if not included, will include full shipment responses on each result if toggled on
  },
  "shipmentRequests": [
    { //This payload represents parity with the MegaShipmentCreate payload
      "asOfDate": "2023-07-31T22:26:03.648Z",
      "currencyCode": "string",
      "generateLabel": true,
      "includeInjectionProfiles": true,
      "injectionParameters": [
        {
          "injectionProfileId": "string",
          "injectionSiteId": "string"
        }
      ],
      "labelParameters": {
        "currencyCode": "string",
        "customLabelEntries": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "includeLabelImagesInResponse": true,
        "labelFormats": [
          "string"
        ],
        "manifest": true,
        "testMode": true
      },
      "shipmentParameters": {
        "businessDaysOfTransit": 3,
        "carrierName": "UPS",
        "carrierTrackingId": "1Z999AA10123456784",
        "customsInfo": {
          "aesInternalTransactionNumber": "string",
          "customsDescription": "9 mm steel screws",
          "customsItems": [
            {
              "commodityDescription": "baby socks",
              "commodityPartNumber": "string",
              "countryOfManufacture": "CN",
              "customsValue": 12.34,
              "customsValueCurrency": "usd",
              "customsWeight": {
                "weight": 50,
                "weightUnit": "lb"
              },
              "electronicExportCommodityInformation": {
                "eccnNumber": "EAR99",
                "exportInformationCode": "LC",
                "exportLicenseInformation": {
                  "exportLicense": {
                    "licenseExpirationDate": "2023-07-31",
                    "licenseLineValue": 0,
                    "licenseNumber": "string"
                  },
                  "licenseExemptionCode": "NLR",
                  "licenseType": "C33"
                },
                "exportType": "domestic",
                "scheduleBInformation": {
                  "scheduleBNumber": "6404195500",
                  "scheduleBQuantity": 0,
                  "scheduleBUnitOfMeasurement": "barrels"
                }
              },
              "harmonizedTariffNumber": "string",
              "marksAndNumbers": "string",
              "productId": "RN03947--Z43121",
              "quantity": 3,
              "quantityUnitOfMeasurement": "bag"
            }
          ],
          "electronicExportInformation": {
            "exportDate": "2023-07-31",
            "pointOfOrigin": "string"
          },
          "invoiceDate": "1970-01-01",
          "invoiceNumber": "abcde-f12345-67890-abcdef",
          "reasonForExport": "sale",
          "totalCustomsValue": 12.34,
          "totalCustomsValueCurrency": "usd",
          "ultimateConsigneeAddress": {
            "addressType": "commercial",
            "city": "Albuquerque",
            "company": "ACME",
            "countryCode": "US",
            "emailAddress": "string",
            "name": "Wile E. Coyote",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "+2",
            "postalCode": "87121",
            "state": "NM",
            "street1": "123 Main St.",
            "street2": "Suite 42"
          },
          "ultimateConsigneeType": "DIRECT_CONSUMER"
        },
        "deliveredDateTime": "2019-10-31T10:50:11.123456Z",
        "deliveryNote": "string",
        "deliverySignatureOption": "resident_signature",
        "deliveryWindow": {
          "endWindow": {
            "hour": 0,
            "minute": 0,
            "nano": 0,
            "second": 0
          },
          "startWindow": {
            "hour": 0,
            "minute": 0,
            "nano": 0,
            "second": 0
          },
          "timeZone": {
            "id": "string",
            "rules": {
              "fixedOffset": true,
              "transitionRules": [
                {
                  "dayOfMonthIndicator": 0,
                  "dayOfWeek": "FRIDAY",
                  "localTime": {
                    "hour": 0,
                    "minute": 0,
                    "nano": 0,
                    "second": 0
                  },
                  "midnightEndOfDay": true,
                  "month": "APRIL",
                  "offsetAfter": {
                    "id": "string",
                    "rules": "string",
                    "totalSeconds": 0
                  },
                  "offsetBefore": {
                    "id": "string",
                    "rules": "string",
                    "totalSeconds": 0
                  },
                  "standardOffset": {
                    "id": "string",
                    "rules": "string",
                    "totalSeconds": 0
                  },
                  "timeDefinition": "STANDARD"
                }
              ],
              "transitions": [
                {
                  "dateTimeAfter": "2023-07-31T22:26:03.648Z",
                  "dateTimeBefore": "2023-07-31T22:26:03.648Z",
                  "duration": {
                    "nano": 0,
                    "negative": true,
                    "seconds": 0,
                    "units": [
                      {
                        "dateBased": true,
                        "duration": "string",
                        "durationEstimated": true,
                        "timeBased": true
                      }
                    ],
                    "zero": true
                  },
                  "gap": true,
                  "instant": "2023-07-31T22:26:03.648Z",
                  "offsetAfter": {
                    "id": "string",
                    "rules": "string",
                    "totalSeconds": 0
                  },
                  "offsetBefore": {
                    "id": "string",
                    "rules": "string",
                    "totalSeconds": 0
                  },
                  "overlap": true
                }
              ]
            }
          }
        },
        "desiredDeliveryDate": "2019-10-31T20:00:00Z",
        "destinationAddress": {
          "addressType": "commercial",
          "city": "Albuquerque",
          "company": "ACME",
          "countryCode": "US",
          "emailAddress": "string",
          "name": "Wile E. Coyote",
          "phoneNumber": "string",
          "phoneNumberCountryCode": "+2",
          "postalCode": "87121",
          "state": "NM",
          "street1": "123 Main St.",
          "street2": "Suite 42"
        },
        "forceThirdPartyBilling": true,
        "fulfillmentContext": "string",
        "fulfillmentType": "at_large",
        "ignoreUpgradeSpendLimits": true,
        "orderItemQuantities": [
          {
            "deliveryEstimateId": "0b3d140a-525b-43a7-896c-cdc381580d61",
            "hazmat": true,
            "hazmatInfo": {
              "category": "defined",
              "containerType": "aluminum_jerrican",
              "hazardClass": "class_8_corrosive_material",
              "hazmatId": "UN1755",
              "packingGroup": "ii",
              "packingInstructionCode": "967",
              "properShippingName": "Chromic Acid Solution",
              "quantity": 2.1,
              "quantityType": "gross",
              "quantityUnits": "l",
              "subsidiaryClasses": [
                "8.1"
              ],
              "transportMode": "passenger_and_cargo_aircraft"
            },
            "partnerOrderId": "myCustomPartnerOrderId123",
            "productDetails": [
              "string"
            ],
            "productId": "RN03947--Z43121",
            "quantity": 3,
            "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312"
          }
        ],
        "orderedDateTime": "2019-10-29T09:12:33.123456Z",
        "packagingType": {
          "linearDimensions": {
            "height": 10,
            "length": 13,
            "linearUnit": "in",
            "width": 12
          },
          "packagingMaterial": "box",
          "packagingSizeName": "13x12x10 Box",
          "packagingTypeId": "ebd94f8b-d390-4c9c-987f-b88343f5bf45",
          "packagingWeight": {
            "weight": 50,
            "weightUnit": "lb"
          }
        },
        "partnerShipmentId": "myCustomPartnerShipmentId123",
        "purchaseOrderIdentifier": "string",
        "referenceIdentifier": "string",
        "referenceIdentifier2": "string",
        "referenceIdentifier3": "string",
        "referenceIdentifier4": "string",
        "referenceIdentifier5": "string",
        "saturdayDelivery": true,
        "shipFromAddress": {
          "addressType": "commercial",
          "city": "Albuquerque",
          "company": "ACME",
          "countryCode": "US",
          "emailAddress": "string",
          "name": "Wile E. Coyote",
          "phoneNumber": "string",
          "phoneNumberCountryCode": "+2",
          "postalCode": "87121",
          "state": "NM",
          "street1": "123 Main St.",
          "street2": "Suite 42"
        },
        "shipOption": "Standard",
        "shipmentTags": [
          "string"
        ],
        "shippedDateTime": "2019-10-29T09:12:33.123456Z",
        "tenantId": "string",
        "thirdPartyBillingSetId": "string",
        "totalWeight": {
          "weight": 50,
          "weightUnit": "lb"
        }
      },
      "simulation": true
    }
  ]
}

Example standard response without full shipment details

{
  "orchestratedAssetMetadata": {
    "orchestrationId": "string", //This orchestrationId can be used to pass to us for support to help trace back what happened for a specific request
    "orchestrationTimeStamp": "2023-07-31T22:26:03.685Z"
  },
  "results": [
    {
      "sequenceNumber": 0,
      "shipiumShipmentId": "string",
      "partnerShipmentId": "string",
      "href": "string",
      "response": { //This is triggered by the option at the request level
        <see below as an addendum>
      }
    },
    ...
  ]
  "failures": [
    {
      "sequenceNumber": 1, //This represents where in the sequence of shipments that was passed to us the request that failed was sequenced
      "partnerShipmentId": "string",
      "destinationAddress": {
      "addressType": "commercial",
        "city": "Albuquerque",
        "company": "ACME",
        "countryCode": "US",
        "emailAddress": "string",
        "name": "Wile E. Coyote",
        "phoneNumber": "string",
        "phoneNumberCountryCode": "+2",
        "postalCode": "87121",
        "state": "NM",
        "street1": "123 Main St.",
        "street2": "Suite 42"
      },
      "exceptionClass": "ConcurrencyException.class",
      "reason": "Request was rejected by the runner"
    },
    ...
  ],
}

Example response with full shipment details

{
  "businessDaysOfTransit": 0,
  "cancellationDateTime": "2019-10-31T10:50:11.123456Z",
  "carrierLabel": {
    "billableWeight": {
      "weight": 50,
      "weightUnit": "lb"
    },
    "carrier": "string",
    "carrierGroupId": "string",
    "carrierLabelCurrencyCode": "string",
    "carrierLabelPrice": 0,
    "carrierSelectionId": "string",
    "carrierServiceMethodId": "string",
    "carrierServiceName": "string",
    "carrierShipmentId": "string",
    "carrierTrackingId": "string",
    "carrierTrackingLink": "string",
    "customerReturn": true,
    "customerReturnParams": {
      "contentDescription": "string",
      "partnerReturnRequestId": "string",
      "returnRequestDateTime": "2023-08-18T22:54:48.726Z"
    },
    "details": {
      "carrierIntegrationServiceRequestParams": {
        "carrierAccountId": "string",
        "carrierServiceMethodId": "string",
        "costCenter": "string",
        "credentials": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "currencyCode": "string",
        "customerReturn": true,
        "customerReturnParams": {
          "contentDescription": "string",
          "partnerReturnRequestId": "string",
          "returnRequestDateTime": "2023-08-18T22:54:48.726Z"
        },
        "customsInfo": {
          "aesInternalTransactionNumber": "string",
          "customsDescription": "string",
          "customsItems": [
            {
              "commodityDescription": "string",
              "commodityPartNumber": "string",
              "countryOfManufacture": "US",
              "customsValue": 0,
              "customsValueCurrency": "string",
              "electronicExportCommodityInformation": {
                "eccnNumber": "EAR99",
                "exportInformationCode": "LC",
                "exportLicenseInformation": {
                  "exportLicense": {
                    "licenseExpirationDate": "2023-08-18",
                    "licenseLineValue": 0,
                    "licenseNumber": "string"
                  },
                  "licenseExemptionCode": "NLR",
                  "licenseType": "C33"
                },
                "exportType": "domestic",
                "scheduleBInformation": {
                  "scheduleBNumber": "6404195500",
                  "scheduleBQuantity": 0,
                  "scheduleBUnitOfMeasurement": "barrels"
                }
              },
              "harmonizedTariffNumber": "6402918005",
              "marksAndNumbers": "string",
              "productId": "RN03947--Z43121",
              "quantity": 0,
              "quantityUnitOfMeasurement": "bag",
              "weight": {
                "weight": 0,
                "weightUnit": "string"
              }
            }
          ],
          "electronicExportInformation": {
            "exportDate": "2023-08-18",
            "pointOfOrigin": "PA"
          },
          "invoiceDate": "2023-08-18",
          "invoiceNumber": "string",
          "reasonForExport": "gift",
          "taxIdentificationNumber": "string",
          "totalCustomsValue": 0,
          "totalCustomsValueCurrency": "string",
          "ultimateConsignee": {
            "address1": "string",
            "address2": "string",
            "city": "string",
            "company": "string",
            "countryCode": "string",
            "emailAddress": "string",
            "name": "string",
            "phoneNumber": "string",
            "postalCode": "string",
            "region": "string",
            "residential": true
          },
          "ultimateConsigneeType": "direct_consumer",
          "unitedStatesPrincipalPartyInInterest": {
            "address1": "string",
            "address2": "string",
            "city": "string",
            "company": "string",
            "countryCode": "string",
            "emailAddress": "string",
            "name": "string",
            "phoneNumber": "string",
            "postalCode": "string",
            "region": "string",
            "residential": true
          }
        },
        "deliveryNote": "string",
        "deliverySignature": "adult_resident_signature",
        "deliveryWindow": {
          "endWindow": {
            "hour": 0,
            "minute": 0,
            "nano": 0,
            "second": 0
          },
          "startWindow": {
            "hour": 0,
            "minute": 0,
            "nano": 0,
            "second": 0
          },
          "timeZone": {
            "id": "string",
            "rules": {
              "fixedOffset": true,
              "transitionRules": [
                {
                  "dayOfMonthIndicator": 0,
                  "dayOfWeek": "FRIDAY",
                  "localTime": {
                    "hour": 0,
                    "minute": 0,
                    "nano": 0,
                    "second": 0
                  },
                  "midnightEndOfDay": true,
                  "month": "APRIL",
                  "offsetAfter": {
                    "id": "string",
                    "rules": "string",
                    "totalSeconds": 0
                  },
                  "offsetBefore": {
                    "id": "string",
                    "rules": "string",
                    "totalSeconds": 0
                  },
                  "standardOffset": {
                    "id": "string",
                    "rules": "string",
                    "totalSeconds": 0
                  },
                  "timeDefinition": "STANDARD"
                }
              ],
              "transitions": [
                {
                  "dateTimeAfter": "2023-08-18T22:54:48.726Z",
                  "dateTimeBefore": "2023-08-18T22:54:48.726Z",
                  "duration": {
                    "nano": 0,
                    "negative": true,
                    "seconds": 0,
                    "units": [
                      {
                        "dateBased": true,
                        "duration": "string",
                        "durationEstimated": true,
                        "timeBased": true
                      }
                    ],
                    "zero": true
                  },
                  "gap": true,
                  "instant": "2023-08-18T22:54:48.726Z",
                  "offsetAfter": {
                    "id": "string",
                    "rules": "string",
                    "totalSeconds": 0
                  },
                  "offsetBefore": {
                    "id": "string",
                    "rules": "string",
                    "totalSeconds": 0
                  },
                  "overlap": true
                }
              ]
            }
          }
        },
        "hazmatItems": [
          {
            "containerType": "aluminum_jerrican",
            "hazardClass": "class_8_corrosive_material",
            "hazmatCategory": "lithium_ion_battery_only",
            "hazmatId": "UN1755",
            "limitedQuantity": true,
            "numberOfItems": 2,
            "packingGroup": "ii",
            "packingInstruction": "967",
            "properShippingName": "Chromic Acid Solution",
            "quantity": 2.1,
            "quantityType": "gross",
            "quantityUnits": "l",
            "subsidiaryClasses": [
              8.1
            ],
            "transportMode": "cargo_aircraft_only"
          }
        ],
        "labelParams": {
          "format": "gif",
          "orientation": "rotate_0",
          "resolution": "dpi_203",
          "size": "size_4x6_in"
        },
        "multiPiecePackages": [
          {
            "dimensions": {
              "height": 0,
              "length": 0,
              "linearUnit": "string",
              "width": 0
            },
            "packagingType": "box",
            "weight": {
              "weight": 0,
              "weightUnit": "string"
            }
          }
        ],
        "packageParams": {
          "dimensions": {
            "height": 0,
            "length": 0,
            "linearUnit": "string",
            "width": 0
          },
          "packagingType": "box",
          "weight": {
            "weight": 0,
            "weightUnit": "string"
          }
        },
        "partnerId": "string",
        "perishable": true,
        "purchaseOrderIdentifier": "string",
        "referenceIdentifier": "string",
        "referenceIdentifier2": "string",
        "referenceIdentifier3": "string",
        "referenceIdentifier4": "string",
        "referenceIdentifier5": "string",
        "reportingContext": {},
        "returnTo": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "company": "string",
          "countryCode": "string",
          "emailAddress": "string",
          "name": "string",
          "phoneNumber": "string",
          "postalCode": "string",
          "region": "string",
          "residential": true
        },
        "saturdayDelivery": true,
        "shipDateTime": "2023-08-18T22:54:48.727Z",
        "shipFrom": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "company": "string",
          "countryCode": "string",
          "emailAddress": "string",
          "name": "string",
          "phoneNumber": "string",
          "postalCode": "string",
          "region": "string",
          "residential": true
        },
        "shipTo": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "company": "string",
          "countryCode": "string",
          "emailAddress": "string",
          "name": "string",
          "phoneNumber": "string",
          "postalCode": "string",
          "region": "string",
          "residential": true
        },
        "shipiumLabelId": "string",
        "shipiumTenantId": "string",
        "shipper": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "company": "string",
          "countryCode": "string",
          "emailAddress": "string",
          "name": "string",
          "phoneNumber": "string",
          "postalCode": "string",
          "region": "string",
          "residential": true
        },
        "sortFacility": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "company": "string",
          "countryCode": "string",
          "emailAddress": "string",
          "name": "string",
          "phoneNumber": "string",
          "postalCode": "string",
          "region": "string",
          "residential": true
        },
        "testMode": true,
        "thirdPartyBilling": true,
        "thirdPartyCredentials": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        }
      },
      "carrierLabelAugmentations": [
        {
          "augmentationZpl": "string",
          "labelAugmentPosition": "bottom",
          "name": "string",
          "shipmentTagToMatch": "string"
        }
      ],
      "createDetails": {
        "errorMessage": "string",
        "errorStatusCode": 0,
        "exceptionDetails": "string",
        "interactionType": "label_create",
        "requestToCarrier": "string",
        "responseFromCarrier": "string",
        "sequenceNumber": 0,
        "success": true
      },
      "customerReturnCreateParams": {
        "customerReturnParams": {
          "contentDescription": "string",
          "partnerReturnRequestId": "string",
          "returnRequestDateTime": "2023-08-18T22:54:48.727Z"
        },
        "destinationAddress": {
          "addressType": "commercial",
          "city": "Albuquerque",
          "company": "ACME",
          "countryCode": "US",
          "emailAddress": "string",
          "name": "Wile E. Coyote",
          "phoneNumber": "string",
          "phoneNumberCountryCode": "+2",
          "postalCode": "87121",
          "state": "NM",
          "street1": "123 Main St.",
          "street2": "Suite 42"
        },
        "labelParameters": {
          "currencyCode": "string",
          "customLabelEntries": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
          "includeLabelImagesInResponse": true,
          "labelFormats": [
            "string"
          ],
          "manifest": true,
          "testMode": true
        },
        "orderItemQuantities": [
          {
            "deliveryEstimateId": "0b3d140a-525b-43a7-896c-cdc381580d61",
            "hazmat": true,
            "hazmatInfo": {
              "category": "defined",
              "containerType": "aluminum_jerrican",
              "hazardClass": "class_8_corrosive_material",
              "hazmatId": "UN1755",
              "packingGroup": "ii",
              "packingInstructionCode": "967",
              "properShippingName": "Chromic Acid Solution",
              "quantity": 2.1,
              "quantityType": "gross",
              "quantityUnits": "l",
              "subsidiaryClasses": [
                "8.1"
              ],
              "transportMode": "passenger_and_cargo_aircraft"
            },
            "partnerOrderId": "myCustomPartnerOrderId123",
            "productDetails": [
              "string"
            ],
            "productId": "RN03947--Z43121",
            "quantity": 3,
            "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312"
          }
        ],
        "originAddress": {
          "addressType": "commercial",
          "city": "Albuquerque",
          "company": "ACME",
          "countryCode": "US",
          "emailAddress": "string",
          "name": "Wile E. Coyote",
          "phoneNumber": "string",
          "phoneNumberCountryCode": "+2",
          "postalCode": "87121",
          "state": "NM",
          "street1": "123 Main St.",
          "street2": "Suite 42"
        },
        "tenantId": "string",
        "totalWeight": {
          "weight": 50,
          "weightUnit": "lb"
        }
      },
      "labelCostLineItems": [
        {
          "cost": 0,
          "currencyCode": "string",
          "name": "string"
        }
      ],
      "labelCreateParams": {
        "currencyCode": "string",
        "customLabelEntries": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "includeLabelImagesInResponse": true,
        "labelFormats": [
          "string"
        ],
        "manifest": true,
        "testMode": true
      },
      "labelVoidDetails": {
        "errorMessage": "string",
        "errorStatusCode": 0,
        "exceptionDetails": "string",
        "interactionType": "label_create",
        "requestToCarrier": "string",
        "responseFromCarrier": "string",
        "sequenceNumber": 0,
        "success": true
      },
      "limitIncrementCountSuccess": true,
      "manifestDetails": {
        "errorMessage": "string",
        "errorStatusCode": 0,
        "exceptionDetails": "string",
        "interactionType": "label_create",
        "requestToCarrier": "string",
        "responseFromCarrier": "string",
        "sequenceNumber": 0,
        "success": true
      },
      "manifestRequestParams": {
        "carrierServiceMethodId": "string",
        "credentials": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "manifestId": "string",
        "partnerId": "string",
        "shipFrom": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "company": "string",
          "countryCode": "string",
          "emailAddress": "string",
          "name": "string",
          "phoneNumber": "string",
          "postalCode": "string",
          "region": "string",
          "residential": true
        },
        "testMode": true,
        "trackingIds": [
          "string"
        ]
      },
      "originalLabelImageFromTheCarrier": {
        "imageContents": "string",
        "imageEncoding": "string"
      },
      "shipiumTrackingId": "string"
    },
    "documents": [
      {
        "labelExpiration": "2023-08-18T22:54:48.727Z",
        "labelFormat": "string",
        "labelImage": {
          "imageContents": "string",
          "imageEncoding": "string"
        },
        "labelProperties": {
          "dpi": 0,
          "height": 0,
          "labelOrientation": "string",
          "linearUnits": "string",
          "width": 0
        },
        "labelUrl": "string"
      }
    ],
    "effectiveShipDateTime": "2023-08-18T22:54:48.727Z",
    "internationalDocuments": [
      {
        "documentExpiration": "2023-08-18T22:54:48.727Z",
        "documentFormat": "string",
        "documentImage": {
          "documentContents": "string",
          "documentEncoding": "base64"
        },
        "documentType": "commercial_invoice",
        "electronicallySubmitted": true
      }
    ],
    "labelFailoverDetails": {
      "details": {
        "carrierLabelCreationFailoverAttempts": [
          {
            "carrierIntegrationServiceRequestParams": {
              "carrierAccountId": "string",
              "carrierServiceMethodId": "string",
              "costCenter": "string",
              "credentials": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
              },
              "currencyCode": "string",
              "customerReturn": true,
              "customerReturnParams": {
                "contentDescription": "string",
                "partnerReturnRequestId": "string",
                "returnRequestDateTime": "2023-08-18T22:54:48.727Z"
              },
              "customsInfo": {
                "aesInternalTransactionNumber": "string",
                "customsDescription": "string",
                "customsItems": [
                  {
                    "commodityDescription": "string",
                    "commodityPartNumber": "string",
                    "countryOfManufacture": "US",
                    "customsValue": 0,
                    "customsValueCurrency": "string",
                    "electronicExportCommodityInformation": {
                      "eccnNumber": "EAR99",
                      "exportInformationCode": "LC",
                      "exportLicenseInformation": {
                        "exportLicense": {
                          "licenseExpirationDate": "2023-08-18",
                          "licenseLineValue": 0,
                          "licenseNumber": "string"
                        },
                        "licenseExemptionCode": "NLR",
                        "licenseType": "C33"
                      },
                      "exportType": "domestic",
                      "scheduleBInformation": {
                        "scheduleBNumber": "6404195500",
                        "scheduleBQuantity": 0,
                        "scheduleBUnitOfMeasurement": "barrels"
                      }
                    },
                    "harmonizedTariffNumber": "6402918005",
                    "marksAndNumbers": "string",
                    "productId": "RN03947--Z43121",
                    "quantity": 0,
                    "quantityUnitOfMeasurement": "bag",
                    "weight": {
                      "weight": 0,
                      "weightUnit": "string"
                    }
                  }
                ],
                "electronicExportInformation": {
                  "exportDate": "2023-08-18",
                  "pointOfOrigin": "PA"
                },
                "invoiceDate": "2023-08-18",
                "invoiceNumber": "string",
                "reasonForExport": "gift",
                "taxIdentificationNumber": "string",
                "totalCustomsValue": 0,
                "totalCustomsValueCurrency": "string",
                "ultimateConsignee": {
                  "address1": "string",
                  "address2": "string",
                  "city": "string",
                  "company": "string",
                  "countryCode": "string",
                  "emailAddress": "string",
                  "name": "string",
                  "phoneNumber": "string",
                  "postalCode": "string",
                  "region": "string",
                  "residential": true
                },
                "ultimateConsigneeType": "direct_consumer",
                "unitedStatesPrincipalPartyInInterest": {
                  "address1": "string",
                  "address2": "string",
                  "city": "string",
                  "company": "string",
                  "countryCode": "string",
                  "emailAddress": "string",
                  "name": "string",
                  "phoneNumber": "string",
                  "postalCode": "string",
                  "region": "string",
                  "residential": true
                }
              },
              "deliveryNote": "string",
              "deliverySignature": "adult_resident_signature",
              "deliveryWindow": {
                "endWindow": {
                  "hour": 0,
                  "minute": 0,
                  "nano": 0,
                  "second": 0
                },
                "startWindow": {
                  "hour": 0,
                  "minute": 0,
                  "nano": 0,
                  "second": 0
                },
                "timeZone": {
                  "id": "string",
                  "rules": {
                    "fixedOffset": true,
                    "transitionRules": [
                      {
                        "dayOfMonthIndicator": 0,
                        "dayOfWeek": "FRIDAY",
                        "localTime": {
                          "hour": 0,
                          "minute": 0,
                          "nano": 0,
                          "second": 0
                        },
                        "midnightEndOfDay": true,
                        "month": "APRIL",
                        "offsetAfter": {
                          "id": "string",
                          "rules": "string",
                          "totalSeconds": 0
                        },
                        "offsetBefore": {
                          "id": "string",
                          "rules": "string",
                          "totalSeconds": 0
                        },
                        "standardOffset": {
                          "id": "string",
                          "rules": "string",
                          "totalSeconds": 0
                        },
                        "timeDefinition": "STANDARD"
                      }
                    ],
                    "transitions": [
                      {
                        "dateTimeAfter": "2023-08-18T22:54:48.727Z",
                        "dateTimeBefore": "2023-08-18T22:54:48.727Z",
                        "duration": {
                          "nano": 0,
                          "negative": true,
                          "seconds": 0,
                          "units": [
                            {
                              "dateBased": true,
                              "duration": "string",
                              "durationEstimated": true,
                              "timeBased": true
                            }
                          ],
                          "zero": true
                        },
                        "gap": true,
                        "instant": "2023-08-18T22:54:48.727Z",
                        "offsetAfter": {
                          "id": "string",
                          "rules": "string",
                          "totalSeconds": 0
                        },
                        "offsetBefore": {
                          "id": "string",
                          "rules": "string",
                          "totalSeconds": 0
                        },
                        "overlap": true
                      }
                    ]
                  }
                }
              },
              "hazmatItems": [
                {
                  "containerType": "aluminum_jerrican",
                  "hazardClass": "class_8_corrosive_material",
                  "hazmatCategory": "lithium_ion_battery_only",
                  "hazmatId": "UN1755",
                  "limitedQuantity": true,
                  "numberOfItems": 2,
                  "packingGroup": "ii",
                  "packingInstruction": "967",
                  "properShippingName": "Chromic Acid Solution",
                  "quantity": 2.1,
                  "quantityType": "gross",
                  "quantityUnits": "l",
                  "subsidiaryClasses": [
                    8.1
                  ],
                  "transportMode": "cargo_aircraft_only"
                }
              ],
              "labelParams": {
                "format": "gif",
                "orientation": "rotate_0",
                "resolution": "dpi_203",
                "size": "size_4x6_in"
              },
              "multiPiecePackages": [
                {
                  "dimensions": {
                    "height": 0,
                    "length": 0,
                    "linearUnit": "string",
                    "width": 0
                  },
                  "packagingType": "box",
                  "weight": {
                    "weight": 0,
                    "weightUnit": "string"
                  }
                }
              ],
              "packageParams": {
                "dimensions": {
                  "height": 0,
                  "length": 0,
                  "linearUnit": "string",
                  "width": 0
                },
                "packagingType": "box",
                "weight": {
                  "weight": 0,
                  "weightUnit": "string"
                }
              },
              "partnerId": "string",
              "perishable": true,
              "purchaseOrderIdentifier": "string",
              "referenceIdentifier": "string",
              "referenceIdentifier2": "string",
              "referenceIdentifier3": "string",
              "referenceIdentifier4": "string",
              "referenceIdentifier5": "string",
              "reportingContext": {},
              "returnTo": {
                "address1": "string",
                "address2": "string",
                "city": "string",
                "company": "string",
                "countryCode": "string",
                "emailAddress": "string",
                "name": "string",
                "phoneNumber": "string",
                "postalCode": "string",
                "region": "string",
                "residential": true
              },
              "saturdayDelivery": true,
              "shipDateTime": "2023-08-18T22:54:48.727Z",
              "shipFrom": {
                "address1": "string",
                "address2": "string",
                "city": "string",
                "company": "string",
                "countryCode": "string",
                "emailAddress": "string",
                "name": "string",
                "phoneNumber": "string",
                "postalCode": "string",
                "region": "string",
                "residential": true
              },
              "shipTo": {
                "address1": "string",
                "address2": "string",
                "city": "string",
                "company": "string",
                "countryCode": "string",
                "emailAddress": "string",
                "name": "string",
                "phoneNumber": "string",
                "postalCode": "string",
                "region": "string",
                "residential": true
              },
              "shipiumLabelId": "string",
              "shipiumTenantId": "string",
              "shipper": {
                "address1": "string",
                "address2": "string",
                "city": "string",
                "company": "string",
                "countryCode": "string",
                "emailAddress": "string",
                "name": "string",
                "phoneNumber": "string",
                "postalCode": "string",
                "region": "string",
                "residential": true
              },
              "sortFacility": {
                "address1": "string",
                "address2": "string",
                "city": "string",
                "company": "string",
                "countryCode": "string",
                "emailAddress": "string",
                "name": "string",
                "phoneNumber": "string",
                "postalCode": "string",
                "region": "string",
                "residential": true
              },
              "testMode": true,
              "thirdPartyBilling": true,
              "thirdPartyCredentials": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
              }
            },
            "carrierLabelAugmentations": [
              {
                "augmentationZpl": "string",
                "labelAugmentPosition": "bottom",
                "name": "string",
                "shipmentTagToMatch": "string"
              }
            ],
            "createDetails": {
              "errorMessage": "string",
              "errorStatusCode": 0,
              "exceptionDetails": "string",
              "interactionType": "label_create",
              "requestToCarrier": "string",
              "responseFromCarrier": "string",
              "sequenceNumber": 0,
              "success": true
            },
            "customerReturnCreateParams": {
              "customerReturnParams": {
                "contentDescription": "string",
                "partnerReturnRequestId": "string",
                "returnRequestDateTime": "2023-08-18T22:54:48.727Z"
              },
              "destinationAddress": {
                "addressType": "commercial",
                "city": "Albuquerque",
                "company": "ACME",
                "countryCode": "US",
                "emailAddress": "string",
                "name": "Wile E. Coyote",
                "phoneNumber": "string",
                "phoneNumberCountryCode": "+2",
                "postalCode": "87121",
                "state": "NM",
                "street1": "123 Main St.",
                "street2": "Suite 42"
              },
              "labelParameters": {
                "currencyCode": "string",
                "customLabelEntries": {
                  "additionalProp1": "string",
                  "additionalProp2": "string",
                  "additionalProp3": "string"
                },
                "includeLabelImagesInResponse": true,
                "labelFormats": [
                  "string"
                ],
                "manifest": true,
                "testMode": true
              },
              "orderItemQuantities": [
                {
                  "deliveryEstimateId": "0b3d140a-525b-43a7-896c-cdc381580d61",
                  "hazmat": true,
                  "hazmatInfo": {
                    "category": "defined",
                    "containerType": "aluminum_jerrican",
                    "hazardClass": "class_8_corrosive_material",
                    "hazmatId": "UN1755",
                    "packingGroup": "ii",
                    "packingInstructionCode": "967",
                    "properShippingName": "Chromic Acid Solution",
                    "quantity": 2.1,
                    "quantityType": "gross",
                    "quantityUnits": "l",
                    "subsidiaryClasses": [
                      "8.1"
                    ],
                    "transportMode": "passenger_and_cargo_aircraft"
                  },
                  "partnerOrderId": "myCustomPartnerOrderId123",
                  "productDetails": [
                    "string"
                  ],
                  "productId": "RN03947--Z43121",
                  "quantity": 3,
                  "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312"
                }
              ],
              "originAddress": {
                "addressType": "commercial",
                "city": "Albuquerque",
                "company": "ACME",
                "countryCode": "US",
                "emailAddress": "string",
                "name": "Wile E. Coyote",
                "phoneNumber": "string",
                "phoneNumberCountryCode": "+2",
                "postalCode": "87121",
                "state": "NM",
                "street1": "123 Main St.",
                "street2": "Suite 42"
              },
              "tenantId": "string",
              "totalWeight": {
                "weight": 50,
                "weightUnit": "lb"
              }
            },
            "labelCostLineItems": [
              {
                "cost": 0,
                "currencyCode": "string",
                "name": "string"
              }
            ],
            "labelCreateParams": {
              "currencyCode": "string",
              "customLabelEntries": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
              },
              "includeLabelImagesInResponse": true,
              "labelFormats": [
                "string"
              ],
              "manifest": true,
              "testMode": true
            },
            "labelVoidDetails": {
              "errorMessage": "string",
              "errorStatusCode": 0,
              "exceptionDetails": "string",
              "interactionType": "label_create",
              "requestToCarrier": "string",
              "responseFromCarrier": "string",
              "sequenceNumber": 0,
              "success": true
            },
            "limitIncrementCountSuccess": true,
            "manifestDetails": {
              "errorMessage": "string",
              "errorStatusCode": 0,
              "exceptionDetails": "string",
              "interactionType": "label_create",
              "requestToCarrier": "string",
              "responseFromCarrier": "string",
              "sequenceNumber": 0,
              "success": true
            },
            "manifestRequestParams": {
              "carrierServiceMethodId": "string",
              "credentials": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
              },
              "manifestId": "string",
              "partnerId": "string",
              "shipFrom": {
                "address1": "string",
                "address2": "string",
                "city": "string",
                "company": "string",
                "countryCode": "string",
                "emailAddress": "string",
                "name": "string",
                "phoneNumber": "string",
                "postalCode": "string",
                "region": "string",
                "residential": true
              },
              "testMode": true,
              "trackingIds": [
                "string"
              ]
            },
            "originalLabelImageFromTheCarrier": {
              "imageContents": "string",
              "imageEncoding": "string"
            },
            "shipiumTrackingId": "string"
          }
        ],
        "preferredLabelCreationAttempt": {
          "carrierIntegrationServiceRequestParams": {
            "carrierAccountId": "string",
            "carrierServiceMethodId": "string",
            "costCenter": "string",
            "credentials": {
              "additionalProp1": "string",
              "additionalProp2": "string",
              "additionalProp3": "string"
            },
            "currencyCode": "string",
            "customerReturn": true,
            "customerReturnParams": {
              "contentDescription": "string",
              "partnerReturnRequestId": "string",
              "returnRequestDateTime": "2023-08-18T22:54:48.727Z"
            },
            "customsInfo": {
              "aesInternalTransactionNumber": "string",
              "customsDescription": "string",
              "customsItems": [
                {
                  "commodityDescription": "string",
                  "commodityPartNumber": "string",
                  "countryOfManufacture": "US",
                  "customsValue": 0,
                  "customsValueCurrency": "string",
                  "electronicExportCommodityInformation": {
                    "eccnNumber": "EAR99",
                    "exportInformationCode": "LC",
                    "exportLicenseInformation": {
                      "exportLicense": {
                        "licenseExpirationDate": "2023-08-18",
                        "licenseLineValue": 0,
                        "licenseNumber": "string"
                      },
                      "licenseExemptionCode": "NLR",
                      "licenseType": "C33"
                    },
                    "exportType": "domestic",
                    "scheduleBInformation": {
                      "scheduleBNumber": "6404195500",
                      "scheduleBQuantity": 0,
                      "scheduleBUnitOfMeasurement": "barrels"
                    }
                  },
                  "harmonizedTariffNumber": "6402918005",
                  "marksAndNumbers": "string",
                  "productId": "RN03947--Z43121",
                  "quantity": 0,
                  "quantityUnitOfMeasurement": "bag",
                  "weight": {
                    "weight": 0,
                    "weightUnit": "string"
                  }
                }
              ],
              "electronicExportInformation": {
                "exportDate": "2023-08-18",
                "pointOfOrigin": "PA"
              },
              "invoiceDate": "2023-08-18",
              "invoiceNumber": "string",
              "reasonForExport": "gift",
              "taxIdentificationNumber": "string",
              "totalCustomsValue": 0,
              "totalCustomsValueCurrency": "string",
              "ultimateConsignee": {
                "address1": "string",
                "address2": "string",
                "city": "string",
                "company": "string",
                "countryCode": "string",
                "emailAddress": "string",
                "name": "string",
                "phoneNumber": "string",
                "postalCode": "string",
                "region": "string",
                "residential": true
              },
              "ultimateConsigneeType": "direct_consumer",
              "unitedStatesPrincipalPartyInInterest": {
                "address1": "string",
                "address2": "string",
                "city": "string",
                "company": "string",
                "countryCode": "string",
                "emailAddress": "string",
                "name": "string",
                "phoneNumber": "string",
                "postalCode": "string",
                "region": "string",
                "residential": true
              }
            },
            "deliveryNote": "string",
            "deliverySignature": "adult_resident_signature",
            "deliveryWindow": {
              "endWindow": {
                "hour": 0,
                "minute": 0,
                "nano": 0,
                "second": 0
              },
              "startWindow": {
                "hour": 0,
                "minute": 0,
                "nano": 0,
                "second": 0
              },
              "timeZone": {
                "id": "string",
                "rules": {
                  "fixedOffset": true,
                  "transitionRules": [
                    {
                      "dayOfMonthIndicator": 0,
                      "dayOfWeek": "FRIDAY",
                      "localTime": {
                        "hour": 0,
                        "minute": 0,
                        "nano": 0,
                        "second": 0
                      },
                      "midnightEndOfDay": true,
                      "month": "APRIL",
                      "offsetAfter": {
                        "id": "string",
                        "rules": "string",
                        "totalSeconds": 0
                      },
                      "offsetBefore": {
                        "id": "string",
                        "rules": "string",
                        "totalSeconds": 0
                      },
                      "standardOffset": {
                        "id": "string",
                        "rules": "string",
                        "totalSeconds": 0
                      },
                      "timeDefinition": "STANDARD"
                    }
                  ],
                  "transitions": [
                    {
                      "dateTimeAfter": "2023-08-18T22:54:48.727Z",
                      "dateTimeBefore": "2023-08-18T22:54:48.727Z",
                      "duration": {
                        "nano": 0,
                        "negative": true,
                        "seconds": 0,
                        "units": [
                          {
                            "dateBased": true,
                            "duration": "string",
                            "durationEstimated": true,
                            "timeBased": true
                          }
                        ],
                        "zero": true
                      },
                      "gap": true,
                      "instant": "2023-08-18T22:54:48.727Z",
                      "offsetAfter": {
                        "id": "string",
                        "rules": "string",
                        "totalSeconds": 0
                      },
                      "offsetBefore": {
                        "id": "string",
                        "rules": "string",
                        "totalSeconds": 0
                      },
                      "overlap": true
                    }
                  ]
                }
              }
            },
            "hazmatItems": [
              {
                "containerType": "aluminum_jerrican",
                "hazardClass": "class_8_corrosive_material",
                "hazmatCategory": "lithium_ion_battery_only",
                "hazmatId": "UN1755",
                "limitedQuantity": true,
                "numberOfItems": 2,
                "packingGroup": "ii",
                "packingInstruction": "967",
                "properShippingName": "Chromic Acid Solution",
                "quantity": 2.1,
                "quantityType": "gross",
                "quantityUnits": "l",
                "subsidiaryClasses": [
                  8.1
                ],
                "transportMode": "cargo_aircraft_only"
              }
            ],
            "labelParams": {
              "format": "gif",
              "orientation": "rotate_0",
              "resolution": "dpi_203",
              "size": "size_4x6_in"
            },
            "multiPiecePackages": [
              {
                "dimensions": {
                  "height": 0,
                  "length": 0,
                  "linearUnit": "string",
                  "width": 0
                },
                "packagingType": "box",
                "weight": {
                  "weight": 0,
                  "weightUnit": "string"
                }
              }
            ],
            "packageParams": {
              "dimensions": {
                "height": 0,
                "length": 0,
                "linearUnit": "string",
                "width": 0
              },
              "packagingType": "box",
              "weight": {
                "weight": 0,
                "weightUnit": "string"
              }
            },
            "partnerId": "string",
            "perishable": true,
            "purchaseOrderIdentifier": "string",
            "referenceIdentifier": "string",
            "referenceIdentifier2": "string",
            "referenceIdentifier3": "string",
            "referenceIdentifier4": "string",
            "referenceIdentifier5": "string",
            "reportingContext": {},
            "returnTo": {
              "address1": "string",
              "address2": "string",
              "city": "string",
              "company": "string",
              "countryCode": "string",
              "emailAddress": "string",
              "name": "string",
              "phoneNumber": "string",
              "postalCode": "string",
              "region": "string",
              "residential": true
            },
            "saturdayDelivery": true,
            "shipDateTime": "2023-08-18T22:54:48.727Z",
            "shipFrom": {
              "address1": "string",
              "address2": "string",
              "city": "string",
              "company": "string",
              "countryCode": "string",
              "emailAddress": "string",
              "name": "string",
              "phoneNumber": "string",
              "postalCode": "string",
              "region": "string",
              "residential": true
            },
            "shipTo": {
              "address1": "string",
              "address2": "string",
              "city": "string",
              "company": "string",
              "countryCode": "string",
              "emailAddress": "string",
              "name": "string",
              "phoneNumber": "string",
              "postalCode": "string",
              "region": "string",
              "residential": true
            },
            "shipiumLabelId": "string",
            "shipiumTenantId": "string",
            "shipper": {
              "address1": "string",
              "address2": "string",
              "city": "string",
              "company": "string",
              "countryCode": "string",
              "emailAddress": "string",
              "name": "string",
              "phoneNumber": "string",
              "postalCode": "string",
              "region": "string",
              "residential": true
            },
            "sortFacility": {
              "address1": "string",
              "address2": "string",
              "city": "string",
              "company": "string",
              "countryCode": "string",
              "emailAddress": "string",
              "name": "string",
              "phoneNumber": "string",
              "postalCode": "string",
              "region": "string",
              "residential": true
            },
            "testMode": true,
            "thirdPartyBilling": true,
            "thirdPartyCredentials": {
              "additionalProp1": "string",
              "additionalProp2": "string",
              "additionalProp3": "string"
            }
          },
          "carrierLabelAugmentations": [
            {
              "augmentationZpl": "string",
              "labelAugmentPosition": "bottom",
              "name": "string",
              "shipmentTagToMatch": "string"
            }
          ],
          "createDetails": {
            "errorMessage": "string",
            "errorStatusCode": 0,
            "exceptionDetails": "string",
            "interactionType": "label_create",
            "requestToCarrier": "string",
            "responseFromCarrier": "string",
            "sequenceNumber": 0,
            "success": true
          },
          "customerReturnCreateParams": {
            "customerReturnParams": {
              "contentDescription": "string",
              "partnerReturnRequestId": "string",
              "returnRequestDateTime": "2023-08-18T22:54:48.727Z"
            },
            "destinationAddress": {
              "addressType": "commercial",
              "city": "Albuquerque",
              "company": "ACME",
              "countryCode": "US",
              "emailAddress": "string",
              "name": "Wile E. Coyote",
              "phoneNumber": "string",
              "phoneNumberCountryCode": "+2",
              "postalCode": "87121",
              "state": "NM",
              "street1": "123 Main St.",
              "street2": "Suite 42"
            },
            "labelParameters": {
              "currencyCode": "string",
              "customLabelEntries": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
              },
              "includeLabelImagesInResponse": true,
              "labelFormats": [
                "string"
              ],
              "manifest": true,
              "testMode": true
            },
            "orderItemQuantities": [
              {
                "deliveryEstimateId": "0b3d140a-525b-43a7-896c-cdc381580d61",
                "hazmat": true,
                "hazmatInfo": {
                  "category": "defined",
                  "containerType": "aluminum_jerrican",
                  "hazardClass": "class_8_corrosive_material",
                  "hazmatId": "UN1755",
                  "packingGroup": "ii",
                  "packingInstructionCode": "967",
                  "properShippingName": "Chromic Acid Solution",
                  "quantity": 2.1,
                  "quantityType": "gross",
                  "quantityUnits": "l",
                  "subsidiaryClasses": [
                    "8.1"
                  ],
                  "transportMode": "passenger_and_cargo_aircraft"
                },
                "partnerOrderId": "myCustomPartnerOrderId123",
                "productDetails": [
                  "string"
                ],
                "productId": "RN03947--Z43121",
                "quantity": 3,
                "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312"
              }
            ],
            "originAddress": {
              "addressType": "commercial",
              "city": "Albuquerque",
              "company": "ACME",
              "countryCode": "US",
              "emailAddress": "string",
              "name": "Wile E. Coyote",
              "phoneNumber": "string",
              "phoneNumberCountryCode": "+2",
              "postalCode": "87121",
              "state": "NM",
              "street1": "123 Main St.",
              "street2": "Suite 42"
            },
            "tenantId": "string",
            "totalWeight": {
              "weight": 50,
              "weightUnit": "lb"
            }
          },
          "labelCostLineItems": [
            {
              "cost": 0,
              "currencyCode": "string",
              "name": "string"
            }
          ],
          "labelCreateParams": {
            "currencyCode": "string",
            "customLabelEntries": {
              "additionalProp1": "string",
              "additionalProp2": "string",
              "additionalProp3": "string"
            },
            "includeLabelImagesInResponse": true,
            "labelFormats": [
              "string"
            ],
            "manifest": true,
            "testMode": true
          },
          "labelVoidDetails": {
            "errorMessage": "string",
            "errorStatusCode": 0,
            "exceptionDetails": "string",
            "interactionType": "label_create",
            "requestToCarrier": "string",
            "responseFromCarrier": "string",
            "sequenceNumber": 0,
            "success": true
          },
          "limitIncrementCountSuccess": true,
          "manifestDetails": {
            "errorMessage": "string",
            "errorStatusCode": 0,
            "exceptionDetails": "string",
            "interactionType": "label_create",
            "requestToCarrier": "string",
            "responseFromCarrier": "string",
            "sequenceNumber": 0,
            "success": true
          },
          "manifestRequestParams": {
            "carrierServiceMethodId": "string",
            "credentials": {
              "additionalProp1": "string",
              "additionalProp2": "string",
              "additionalProp3": "string"
            },
            "manifestId": "string",
            "partnerId": "string",
            "shipFrom": {
              "address1": "string",
              "address2": "string",
              "city": "string",
              "company": "string",
              "countryCode": "string",
              "emailAddress": "string",
              "name": "string",
              "phoneNumber": "string",
              "postalCode": "string",
              "region": "string",
              "residential": true
            },
            "testMode": true,
            "trackingIds": [
              "string"
            ]
          },
          "originalLabelImageFromTheCarrier": {
            "imageContents": "string",
            "imageEncoding": "string"
          },
          "shipiumTrackingId": "string"
        }
      },
      "failoverAttempts": [
        {
          "carrier": "string",
          "carrierAccountId": "string",
          "carrierSelectionDateTime": "2023-08-18T22:54:48.727Z",
          "carrierSelectionId": "string",
          "carrierServiceMethodId": "string",
          "partnerId": "string",
          "serviceMethodIdentifier": "string",
          "serviceMethodName": "string",
          "serviceMethodUrn": "string",
          "status": "failover",
          "statusDetails": "string",
          "totalCost": 0
        }
      ],
      "preferred": {
        "carrier": "string",
        "carrierAccountId": "string",
        "carrierSelectionDateTime": "2023-08-18T22:54:48.727Z",
        "carrierSelectionId": "string",
        "carrierServiceMethodId": "string",
        "partnerId": "string",
        "serviceMethodIdentifier": "string",
        "serviceMethodName": "string",
        "serviceMethodUrn": "string",
        "status": "failover",
        "statusDetails": "string",
        "totalCost": 0
      }
    },
    "labelFailoverOccurred": true,
    "packageScannableId": "string",
    "partnerShipmentId": "string",
    "partnerTenantId": "string",
    "partnerThirdPartyBillingAccountId": "string",
    "serviceMethodIdentifier": "string",
    "serviceMethodName": "string",
    "serviceMethodUrn": "string",
    "shipiumLabelId": "string",
    "shipiumShipmentId": "string",
    "shipiumTenantId": "string",
    "shipiumThirdPartyBillingAccountId": "string",
    "status": "failover",
    "statusDetails": "string",
    "trackingInfo": {
      "carrier": "string",
      "currentStatus": {
        "deliveryStep": "Delivered",
        "eventCity": "string",
        "eventCountry": "string",
        "eventDateTime": "2019-10-28T14:34:55.123456Z",
        "eventPostalCode": "string",
        "eventRegion": "string",
        "shipmentStatus": "ArrivedCarrierFacility",
        "statusMessage": "string"
      },
      "deliveredDateTime": "2019-10-28T14:34:55.123456Z",
      "events": [
        {
          "deliveryStep": "Delivered",
          "eventCity": "string",
          "eventCountry": "string",
          "eventDateTime": "2019-10-28T14:34:55.123456Z",
          "eventPostalCode": "string",
          "eventRegion": "string",
          "shipmentStatus": "ArrivedCarrierFacility",
          "statusMessage": "string"
        }
      ],
      "shippedDateTime": "2019-10-28T14:34:55.123456Z",
      "trackingId": "string"
    }
  },
  "carrierName": "UPS",
  "carrierSelection": {
    "carrier": "string",
    "carrierAccountId": "string",
    "carrierCompareCost": 0,
    "carrierInvoiceCost": 0,
    "carrierSelectionDateTime": "2023-08-18T22:54:48.727Z",
    "carrierSelectionId": "string",
    "carrierServiceMethodId": "string",
    "injectionSummary": {
      "partnerInjectionProfileId": "string",
      "partnerInjectionSiteId": "string",
      "requestInjectionProfileId": "string",
      "requestInjectionSiteId": "string",
      "shipiumInjectionProfileId": "string",
      "shipiumInjectionSiteId": "string"
    },
    "operationalCost": 2.7,
    "partnerId": "string",
    "partnerShipmentId": "string",
    "serviceMethodIdentifier": "string",
    "serviceMethodName": "string",
    "serviceMethodUrn": "string",
    "shipiumShipmentId": "string",
    "status": "no_decision",
    "statusDetails": "string",
    "thirdPartyBilling": true,
    "totalCost": 0
  },
  "carrierTrackingId": "1Z999AA10123456784",
  "createdWithVersion": "v1",
  "customsInfo": {
    "aesInternalTransactionNumber": "string",
    "customsDescription": "9 mm steel screws",
    "customsItems": [
      {
        "commodityDescription": "baby socks",
        "commodityPartNumber": "string",
        "countryOfManufacture": "CN",
        "customsValue": 12.34,
        "customsValueCurrency": "usd",
        "customsWeight": {
          "weight": 50,
          "weightUnit": "lb"
        },
        "electronicExportCommodityInformation": {
          "eccnNumber": "EAR99",
          "exportInformationCode": "LC",
          "exportLicenseInformation": {
            "exportLicense": {
              "licenseExpirationDate": "2023-08-18",
              "licenseLineValue": 0,
              "licenseNumber": "string"
            },
            "licenseExemptionCode": "NLR",
            "licenseType": "C33"
          },
          "exportType": "domestic",
          "scheduleBInformation": {
            "scheduleBNumber": "6404195500",
            "scheduleBQuantity": 0,
            "scheduleBUnitOfMeasurement": "barrels"
          }
        },
        "harmonizedTariffNumber": "string",
        "marksAndNumbers": "string",
        "productId": "RN03947--Z43121",
        "quantity": 3,
        "quantityUnitOfMeasurement": "bag"
      }
    ],
    "electronicExportInformation": {
      "exportDate": "2023-08-18",
      "pointOfOrigin": "string"
    },
    "invoiceDate": "1970-01-01",
    "invoiceNumber": "abcde-f12345-67890-abcdef",
    "reasonForExport": "sale",
    "totalCustomsValue": 12.34,
    "totalCustomsValueCurrency": "usd",
    "ultimateConsigneeAddress": {
      "addressType": "commercial",
      "city": "Albuquerque",
      "company": "ACME",
      "countryCode": "US",
      "emailAddress": "string",
      "name": "Wile E. Coyote",
      "phoneNumber": "string",
      "phoneNumberCountryCode": "+2",
      "postalCode": "87121",
      "state": "NM",
      "street1": "123 Main St.",
      "street2": "Suite 42"
    },
    "ultimateConsigneeType": "DIRECT_CONSUMER"
  },
  "deliveredDateTime": "2019-10-31T10:50:11.123456Z",
  "deliveryNote": "string",
  "deliverySignatureOption": "resident_signature",
  "deliveryWindow": {
    "endWindow": {
      "hour": 0,
      "minute": 0,
      "nano": 0,
      "second": 0
    },
    "startWindow": {
      "hour": 0,
      "minute": 0,
      "nano": 0,
      "second": 0
    },
    "timeZone": {
      "id": "string",
      "rules": {
        "fixedOffset": true,
        "transitionRules": [
          {
            "dayOfMonthIndicator": 0,
            "dayOfWeek": "FRIDAY",
            "localTime": {
              "hour": 0,
              "minute": 0,
              "nano": 0,
              "second": 0
            },
            "midnightEndOfDay": true,
            "month": "APRIL",
            "offsetAfter": {
              "id": "string",
              "rules": "string",
              "totalSeconds": 0
            },
            "offsetBefore": {
              "id": "string",
              "rules": "string",
              "totalSeconds": 0
            },
            "standardOffset": {
              "id": "string",
              "rules": "string",
              "totalSeconds": 0
            },
            "timeDefinition": "STANDARD"
          }
        ],
        "transitions": [
          {
            "dateTimeAfter": "2023-08-18T22:54:48.727Z",
            "dateTimeBefore": "2023-08-18T22:54:48.727Z",
            "duration": {
              "nano": 0,
              "negative": true,
              "seconds": 0,
              "units": [
                {
                  "dateBased": true,
                  "duration": "string",
                  "durationEstimated": true,
                  "timeBased": true
                }
              ],
              "zero": true
            },
            "gap": true,
            "instant": "2023-08-18T22:54:48.727Z",
            "offsetAfter": {
              "id": "string",
              "rules": "string",
              "totalSeconds": 0
            },
            "offsetBefore": {
              "id": "string",
              "rules": "string",
              "totalSeconds": 0
            },
            "overlap": true
          }
        ]
      }
    }
  },
  "desiredDeliveryDate": "2023-08-18T22:54:48.727Z",
  "destinationAddress": {
    "addressType": "commercial",
    "city": "Albuquerque",
    "company": "ACME",
    "countryCode": "US",
    "emailAddress": "string",
    "name": "Wile E. Coyote",
    "phoneNumber": "string",
    "phoneNumberCountryCode": "+2",
    "postalCode": "87121",
    "state": "NM",
    "street1": "123 Main St.",
    "street2": "Suite 42"
  },
  "details": {
    "asOfDate": "2023-08-18T22:54:48.727Z",
    "carrierSelection": {
      "carrierDecision": {
        "carrier": "string",
        "carrierAccountId": "string",
        "carrierEstimatedPriceDetails": {
          "accessorials": 0,
          "adjustedLabelCost": 0,
          "carrierCompareCost": 0,
          "carrierInvoiceCost": 0,
          "currencyCode": "string",
          "duty": 0,
          "insuranceCost": 0,
          "operationalCost": 0,
          "shippingCost": 0,
          "taxes": 0,
          "totalCost": 0
        },
        "carrierServiceMethodId": "string",
        "carrierServiceName": "string",
        "details": {
          "asOfDate": "2023-08-18T22:54:48.727Z",
          "availableServiceMethods": [
            {
              "carrier": "string",
              "carrierAccountId": "string",
              "carrierRateId": "string",
              "carrierServiceMethodId": "ups-ground-service-method",
              "carrierServiceName": "UPS(MO)",
              "carrierSettingsId": "string",
              "fulfillmentContextId": "string",
              "originId": "string",
              "partnerId": "string",
              "serviceMethodIdentifier": "urn:carrierrate:86c6230a-4a2b-4f9b-8b71-a51627bbbcb2:1",
              "serviceMethodName": "UPS SurePost",
              "serviceMethodUrn": "string"
            }
          ],
          "calculatedRates": [
            {
              "actualWeight": 3,
              "asOfTime": "2019-10-28T14:34:55.123456Z",
              "billableWeight": 3,
              "carrierAccountId": "97fda784-beca-4b4f-a9c9-7a7a9e13c33c",
              "carrierCompareCost": 3.5,
              "carrierId": "usps",
              "carrierInvoiceCost": 2.7,
              "carrierRateRequestInfo": {
                "carrierRateId": "string",
                "carrierSettingsId": "string",
                "saturdayDelivery": true,
                "serviceMethodIdentifier": "string",
                "zoneId": "string"
              },
              "createdAt": "2020-09-17T11:36:18-07:00",
              "destinationAddressType": "residential",
              "destinationCountryCode": "US",
              "destinationPostalCode": "87121",
              "dimWeight": 2,
              "lineItems": [
                {
                  "carrierSurchargeId": "123451239874980",
                  "hiddenFromCarrierCompare": true,
                  "hiddenFromInvoice": true,
                  "hiddenFromOperational": true,
                  "lineItemType": "surcharge",
                  "name": "base",
                  "rate": 2.3,
                  "surchargeType": "extended_delivery"
                }
              ],
              "linearDimensions": {
                "height": 0,
                "length": 0,
                "linearUnit": "string",
                "width": 0
              },
              "operationalCost": 2.7,
              "packagingMaterial": "box",
              "partnerId": "76abb3d4-8990-4f80-aa13-4c2007cb852a",
              "physicalWeight": 2.3,
              "rate": 3.75,
              "rateCurrency": "usd",
              "rateResultDetails": "string",
              "rateResultType": "rate_match",
              "serviceMethodIdentifier": "urn:carrierrate:86c6230a-4a2b-4f9b-8b71-a51627bbbcb2:1",
              "serviceMethodUrn": "76abb3d4-8990-4f80-aa13-4c2007cb852a:carrier-account-id:1:usps-priority-mail-service-method:1",
              "weightUnit": "lb",
              "zoneId": [
                "usps-zone-2"
              ]
            }
          ],
          "estimatedDeliverySelectionDetails": {
            "cheapestCost": 0,
            "deliveryDateRequestedAt": "2023-08-18T22:54:48.727Z",
            "desiredDeliveryDate": "2023-08-18T22:54:48.727Z",
            "estimatedDeliveryDate": "2023-08-18T22:54:48.727Z",
            "estimatedDeliveryDateId": "string",
            "estimatedDeliveryMatchInfo": {
              "matchInfo": "string",
              "rawTimeInTransit": 0,
              "redisKey": "string",
              "timeInTransitDataType": "string",
              "timeInTransitDays": 0,
              "timeInTransitModel": "string"
            },
            "ignoreUpgradeSpendLimits": true,
            "saturdayDeliveryRequested": true,
            "selectedAdjustedCost": 0,
            "selectedBucket": "string",
            "selectedCarrierServiceMethodId": "string",
            "selectedCost": 0,
            "selectedCostOverCheapest": 0,
            "selectedDeliveryEstimateProvenance": "string",
            "selectedEffectiveShipDate": "2023-08-18T22:54:48.727Z",
            "selectedEstimatedInjectionDate": "2023-08-18T22:54:48.727Z",
            "selectedServiceMethodIdentifier": "string",
            "serviceMethodResults": [
              {
                "adjustedLabelCost": 0,
                "bucket": "string",
                "carrierAccountId": "string",
                "carrierServiceMethodId": "string",
                "costOverCheapest": 0,
                "effectiveShipDate": "2023-08-18T22:54:48.727Z",
                "estimatedDeliveryDate": "2023-08-18T22:54:48.727Z",
                "estimatedDeliveryDateId": "string",
                "estimatedDeliveryMatchInfo": {
                  "matchInfo": "string",
                  "rawTimeInTransit": 0,
                  "redisKey": "string",
                  "timeInTransitDataType": "string",
                  "timeInTransitDays": 0,
                  "timeInTransitModel": "string"
                },
                "estimatedInjectionDate": "2023-08-18T22:54:48.727Z",
                "ignoreUpgradeSpendLimits": true,
                "labelCost": 0,
                "provenanceId": "string",
                "requestedAt": "2023-08-18T22:54:48.727Z",
                "saturdayDeliveryEnabled": true,
                "serviceMethodIdentifier": "string",
                "timeInTransitSourcePreference": [
                  "carrier_default"
                ]
              }
            ],
            "timeInTransitSourcePreference": [
              "carrier_default"
            ],
            "upgradeCostingConfiguration": {
              "costCurrency": "string",
              "totalUpgradeCostTolerance": 0,
              "upgradeOverCheapestCostTolerance": 0
            },
            "upgradeSpendAtDecisionTime": 0,
            "upgradeSpendLimit": 0
          },
          "failoverList": [
            "string"
          ],
          "filteredServiceMethods": [
            {
              "filterReason": "string",
              "filterReasons": [
                "string"
              ],
              "serviceMethodIdentifier": "string",
              "serviceMethodUrn": "string"
            }
          ],
          "requestParams": {
            "asOfDate": "2023-08-18T22:54:48.727Z",
            "currencyCode": "string",
            "includeInjectionProfiles": true,
            "injectionParameters": [
              {
                "injectionProfileId": "string",
                "injectionSiteId": "string"
              }
            ],
            "packagingType": {
              "linearDimensions": {
                "height": 10,
                "length": 13,
                "linearUnit": "in",
                "width": 12
              },
              "packagingMaterial": "box",
              "packagingSizeName": "13x12x10 Box",
              "packagingTypeId": "ebd94f8b-d390-4c9c-987f-b88343f5bf45",
              "packagingWeight": {
                "weight": 50,
                "weightUnit": "lb"
              }
            },
            "shippedDateTime": "2023-08-18T22:54:48.727Z",
            "simulation": true,
            "testMode": true
          },
          "serviceMethodsAfterFiltering": [
            {
              "allowCarrierFailover": true,
              "bpmContentOnly": true,
              "carrier": "string",
              "carrierAccountId": "string",
              "carrierAccountInTestMode": true,
              "carrierRateId": "string",
              "carrierServiceMethodId": "ups-ground-service-method",
              "carrierServiceName": "UPS(MO)",
              "carrierSettingsId": "string",
              "credentials": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
              },
              "deliverySignatureTypes": [
                "AdultResidentSignature"
              ],
              "destinationCountries": [
                "string"
              ],
              "destinationType": "string",
              "failoverUndeliverable": true,
              "fulfillmentCenterIds": [
                "string"
              ],
              "fulfillmentContextId": "string",
              "fulfillmentContextPriority": 0,
              "fulfillmentContexts": [
                "string"
              ],
              "hazmat": {
                "dangerousGoods": {
                  "countryOverrides": [
                    {
                      "applicableCountries": [
                        "string"
                      ],
                      "categories": [
                        {
                          "applicableClasses": [
                            "string"
                          ],
                          "applicableDivisions": [
                            "string"
                          ],
                          "applicableIdentificationNumbers": [
                            "string"
                          ],
                          "applicableShippingNames": [
                            "string"
                          ],
                          "excludedClasses": [
                            "string"
                          ],
                          "excludedDivisions": [
                            "string"
                          ],
                          "excludedIdentificationNumbers": [
                            "string"
                          ],
                          "excludedShippingNames": [
                            "string"
                          ],
                          "maxVolume": 0,
                          "maxWeight": 0,
                          "volumeUnit": "ml",
                          "weightUnit": "lb"
                        }
                      ],
                      "excludedCountries": [
                        "string"
                      ],
                      "excludedPostalCodesByCountry": {
                        "additionalProp1": [
                          "string"
                        ],
                        "additionalProp2": [
                          "string"
                        ],
                        "additionalProp3": [
                          "string"
                        ]
                      },
                      "excludedRegionByCountry": {
                        "additionalProp1": [
                          "string"
                        ],
                        "additionalProp2": [
                          "string"
                        ],
                        "additionalProp3": [
                          "string"
                        ]
                      }
                    }
                  ],
                  "supportStrategy": "carrier_approval_required"
                },
                "limitedQuantity": {
                  "countries": [
                    "string"
                  ],
                  "countryOverrides": [
                    {
                      "applicableCountries": [
                        "string"
                      ],
                      "categories": [
                        {
                          "applicableClasses": [
                            "string"
                          ],
                          "applicableDivisions": [
                            "string"
                          ],
                          "applicableIdentificationNumbers": [
                            "string"
                          ],
                          "applicableShippingNames": [
                            "string"
                          ],
                          "excludedClasses": [
                            "string"
                          ],
                          "excludedDivisions": [
                            "string"
                          ],
                          "excludedIdentificationNumbers": [
                            "string"
                          ],
                          "excludedShippingNames": [
                            "string"
                          ],
                          "maxVolume": 0,
                          "maxWeight": 0,
                          "volumeUnit": "ml",
                          "weightUnit": "lb"
                        }
                      ],
                      "excludedCountries": [
                        "string"
                      ],
                      "excludedPostalCodesByCountry": {
                        "additionalProp1": [
                          "string"
                        ],
                        "additionalProp2": [
                          "string"
                        ],
                        "additionalProp3": [
                          "string"
                        ]
                      },
                      "excludedRegionByCountry": {
                        "additionalProp1": [
                          "string"
                        ],
                        "additionalProp2": [
                          "string"
                        ],
                        "additionalProp3": [
                          "string"
                        ]
                      }
                    }
                  ],
                  "exclusionsByPostalCode": {
                    "additionalProp1": [
                      "string"
                    ],
                    "additionalProp2": [
                      "string"
                    ],
                    "additionalProp3": [
                      "string"
                    ]
                  },
                  "exclusionsByRegion": {
                    "additionalProp1": [
                      "string"
                    ],
                    "additionalProp2": [
                      "string"
                    ],
                    "additionalProp3": [
                      "string"
                    ]
                  },
                  "omitHazmatDetailsOnCarrierCall": true,
                  "supportStrategy": "carrier_approval_required"
                }
              },
              "hazmatLimitedQuantityExempt": true,
              "injectionAddress": {
                "addressType": "commercial",
                "city": "Albuquerque",
                "company": "ACME",
                "countryCode": "US",
                "emailAddress": "string",
                "name": "Wile E. Coyote",
                "phoneNumber": "string",
                "phoneNumberCountryCode": "+2",
                "postalCode": "87121",
                "state": "NM",
                "street1": "123 Main St.",
                "street2": "Suite 42"
              },
              "injectionLimitDestinations": true,
              "injectionProfileType": "carrier_provided_transportation_to_injection_site",
              "injectionRateModifier": {
                "modifierType": "flat",
                "modifierValue": 0
              },
              "injectionSiteTimezoneId": {
                "id": "string",
                "rules": {
                  "fixedOffset": true,
                  "transitionRules": [
                    {
                      "dayOfMonthIndicator": 0,
                      "dayOfWeek": "FRIDAY",
                      "localTime": {
                        "hour": 0,
                        "minute": 0,
                        "nano": 0,
                        "second": 0
                      },
                      "midnightEndOfDay": true,
                      "month": "APRIL",
                      "offsetAfter": {
                        "id": "string",
                        "rules": "string",
                        "totalSeconds": 0
                      },
                      "offsetBefore": {
                        "id": "string",
                        "rules": "string",
                        "totalSeconds": 0
                      },
                      "standardOffset": {
                        "id": "string",
                        "rules": "string",
                        "totalSeconds": 0
                      },
                      "timeDefinition": "STANDARD"
                    }
                  ],
                  "transitions": [
                    {
                      "dateTimeAfter": "2023-08-18T22:54:48.727Z",
                      "dateTimeBefore": "2023-08-18T22:54:48.727Z",
                      "duration": {
                        "nano": 0,
                        "negative": true,
                        "seconds": 0,
                        "units": [
                          {
                            "dateBased": true,
                            "duration": "string",
                            "durationEstimated": true,
                            "timeBased": true
                          }
                        ],
                        "zero": true
                      },
                      "gap": true,
                      "instant": "2023-08-18T22:54:48.727Z",
                      "offsetAfter": {
                        "id": "string",
                        "rules": "string",
                        "totalSeconds": 0
                      },
                      "offsetBefore": {
                        "id": "string",
                        "rules": "string",
                        "totalSeconds": 0
                      },
                      "overlap": true
                    }
                  ]
                }
              },
              "injectionSupportedDestinations": [
                {
                  "countryCode": "string",
                  "postalCodes": [
                    "string"
                  ]
                }
              ],
              "injectionTimeInTransitDays": 0,
              "labelAugmentations": [
                {
                  "fulfillmentCenterIds": [
                    "string"
                  ],
                  "injectionPosition": "bottom",
                  "name": "string",
                  "shipmentTagToMatch": "string",
                  "zpl": "string"
                }
              ],
              "originBasedSupportedRegionsByCountry": {
                "exclude": "US [HI,PR]",
                "include": "a service method only available in AK, US[AK]"
              },
              "originId": "string",
              "partnerId": "string",
              "partnerInjectionProfileId": "string",
              "partnerInjectionSiteId": "string",
              "partnerThirdPartyBillingAccountId": "string",
              "poBoxDeliveryExclusionsByCountry": [
                {
                  "allowedRegions": "US [HI,PR]",
                  "countryCode": "US"
                }
              ],
              "restrictions": {
                "customsValue": [
                  {
                    "conditions": {
                      "applicableCountries": [
                        "string"
                      ],
                      "excludedCountries": [
                        "string"
                      ]
                    },
                    "currency": "string",
                    "maxValue": 0
                  }
                ],
                "dimensions": [
                  {
                    "combined": 0,
                    "conditions": {
                      "applicableCountries": [
                        "string"
                      ],
                      "excludedCountries": [
                        "string"
                      ]
                    },
                    "dimensionUnit": "string",
                    "height": 0,
                    "length": 0,
                    "packageType": "box",
                    "thresholdType": "floor",
                    "width": 0
                  }
                ],
                "weights": [
                  {
                    "conditions": {
                      "applicableCountries": [
                        "string"
                      ],
                      "excludedCountries": [
                        "string"
                      ]
                    },
                    "packageType": "box",
                    "thresholdType": "floor",
                    "weight": 0,
                    "weightUnit": "string"
                  }
                ]
              },
              "returnToAddress": {
                "addressType": "commercial",
                "city": "Albuquerque",
                "company": "ACME",
                "countryCode": "US",
                "emailAddress": "string",
                "name": "Wile E. Coyote",
                "phoneNumber": "string",
                "phoneNumberCountryCode": "+2",
                "postalCode": "87121",
                "state": "NM",
                "street1": "123 Main St.",
                "street2": "Suite 42"
              },
              "saturdayDeliveryType": "all_zip_codes",
              "selectionModifiers": [
                {
                  "active": true,
                  "applicableIdentifiers": {
                    "carrier": "fedex",
                    "carrierRateId": "cb387c97-5a1c-4018-aecb-b6a7ff7649d5",
                    "carrierServiceMethodId": "fedex-home-delivery-service-method",
                    "fulfillmentContextId": "ff66d0fd-6354-416b-89cb-63f9d3971d65",
                    "injectionProfileId": "36f96f8f-c910-4eba-9ed5-2ae27557b141",
                    "originId": "d7e7cda6-9948-43fb-b595-f8b230f6b1a8",
                    "shipiumTenantId": "2da905a5-43c4-48ef-9860-36fd7d9d24f9"
                  },
                  "archived": true,
                  "criteria": [
                    {}
                  ],
                  "effectiveDateTime": "2022-04-13T13:15:19Z",
                  "expirationDateTime": "2022-04-18T08:11:55Z",
                  "name": "Block Texas For Slow carrier",
                  "partnerId": "f8569788-5001-4242-a04e-6156268011cd",
                  "selectionModifierId": "3826769e-aa5b-4a98-9966-50326b5cda28",
                  "selectionModifierUrn": "urn:selectionmodifier:3826769e-aa5b-4a98-9966-50326b5cda28:1",
                  "treatment": {
                    "applyTestMode": true,
                    "areaModifier": {
                      "areaModifierType": "fullPostalInclusion",
                      "areas": [
                        "12345",
                        "98765"
                      ]
                    },
                    "augmentationId": "80943a2c-7ec9-46ff-b7fe-eb8127d0e57c",
                    "labelAugmentation": {
                      "augmentationZpl": "string",
                      "labelAugmentPosition": "bottom",
                      "name": "string",
                      "shipmentTagToMatch": "string"
                    }
                  }
                }
              ],
              "serviceMethodIdentifier": "urn:carrierrate:86c6230a-4a2b-4f9b-8b71-a51627bbbcb2:1",
              "serviceMethodInTestMode": true,
              "serviceMethodName": "UPS SurePost",
              "serviceMethodUrn": "string",
              "shipiumInjectionProfileId": "string",
              "shipiumInjectionSiteId": "string",
              "shipiumTenantId": "string",
              "shipiumThirdPartyBillingAccountId": "string",
              "shipperAddress": {
                "addressType": "commercial",
                "city": "Albuquerque",
                "company": "ACME",
                "countryCode": "US",
                "emailAddress": "string",
                "name": "Wile E. Coyote",
                "phoneNumber": "string",
                "phoneNumberCountryCode": "+2",
                "postalCode": "87121",
                "state": "NM",
                "street1": "123 Main St.",
                "street2": "Suite 42"
              },
              "sortFacilityAddress": {
                "addressType": "commercial",
                "city": "Albuquerque",
                "company": "ACME",
                "countryCode": "US",
                "emailAddress": "string",
                "name": "Wile E. Coyote",
                "phoneNumber": "string",
                "phoneNumberCountryCode": "+2",
                "postalCode": "87121",
                "state": "NM",
                "street1": "123 Main St.",
                "street2": "Suite 42"
              },
              "taxIdentificationNumber": "string",
              "thirdPartyBillingSupported": true,
              "thirdPartyCredentials": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
              },
              "transportationType": "string",
              "unitedStatesPrincipalPartyInInterestAddress": {
                "addressType": "commercial",
                "city": "Albuquerque",
                "company": "ACME",
                "countryCode": "US",
                "emailAddress": "string",
                "name": "Wile E. Coyote",
                "phoneNumber": "string",
                "phoneNumberCountryCode": "+2",
                "postalCode": "87121",
                "state": "NM",
                "street1": "123 Main St.",
                "street2": "Suite 42"
              }
            }
          ],
          "zonesByCarrier": {
            "additionalProp1": [
              "string"
            ],
            "additionalProp2": [
              "string"
            ],
            "additionalProp3": [
              "string"
            ]
          },
          "zonesByServiceMethodIdentifier": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        },
        "effectiveShipDateTime": "2023-08-18T22:54:48.728Z",
        "estimatedInjectionDateTime": "2023-08-18T22:54:48.728Z",
        "injectionDetails": {
          "injectionCostDetails": {
            "injectionLineItemCurrencyCode": "usd",
            "injectionLineItemRate": 2.3,
            "injectionRateModifier": {
              "modifierType": "flat",
              "modifierValue": 0
            }
          },
          "partnerInjectionProfileId": "string",
          "partnerInjectionSiteId": "string",
          "requestInjectionProfileId": "string",
          "requestInjectionSiteId": "string",
          "shipiumInjectionProfileId": "string",
          "shipiumInjectionSiteId": "string"
        },
        "partnerId": "string",
        "ruleSetProcessingResult": {
          "filteredCarrierServiceMethods": [
            {
              "filterReason": "string",
              "filterReasons": [
                "string"
              ],
              "serviceMethodIdentifier": "string",
              "serviceMethodUrn": "string"
            }
          ],
          "processingTimestamp": "2023-08-18T22:54:48.728Z",
          "result": "no_selection",
          "ruleMakingSelection": {
            "name": "string",
            "ruleId": "string",
            "ruleUrn": "string"
          },
          "ruleSetUrn": "string",
          "selectedCarrierServiceMethods": [
            {
              "allowCarrierFailover": true,
              "bpmContentOnly": true,
              "carrier": "string",
              "carrierAccountId": "string",
              "carrierAccountInTestMode": true,
              "carrierRateId": "string",
              "carrierServiceMethodId": "ups-ground-service-method",
              "carrierServiceName": "UPS(MO)",
              "carrierSettingsId": "string",
              "credentials": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
              },
              "deliverySignatureTypes": [
                "AdultResidentSignature"
              ],
              "destinationCountries": [
                "string"
              ],
              "destinationType": "string",
              "failoverUndeliverable": true,
              "fulfillmentCenterIds": [
                "string"
              ],
              "fulfillmentContextId": "string",
              "fulfillmentContextPriority": 0,
              "fulfillmentContexts": [
                "string"
              ],
              "hazmat": {
                "dangerousGoods": {
                  "countryOverrides": [
                    {
                      "applicableCountries": [
                        "string"
                      ],
                      "categories": [
                        {
                          "applicableClasses": [
                            "string"
                          ],
                          "applicableDivisions": [
                            "string"
                          ],
                          "applicableIdentificationNumbers": [
                            "string"
                          ],
                          "applicableShippingNames": [
                            "string"
                          ],
                          "excludedClasses": [
                            "string"
                          ],
                          "excludedDivisions": [
                            "string"
                          ],
                          "excludedIdentificationNumbers": [
                            "string"
                          ],
                          "excludedShippingNames": [
                            "string"
                          ],
                          "maxVolume": 0,
                          "maxWeight": 0,
                          "volumeUnit": "ml",
                          "weightUnit": "lb"
                        }
                      ],
                      "excludedCountries": [
                        "string"
                      ],
                      "excludedPostalCodesByCountry": {
                        "additionalProp1": [
                          "string"
                        ],
                        "additionalProp2": [
                          "string"
                        ],
                        "additionalProp3": [
                          "string"
                        ]
                      },
                      "excludedRegionByCountry": {
                        "additionalProp1": [
                          "string"
                        ],
                        "additionalProp2": [
                          "string"
                        ],
                        "additionalProp3": [
                          "string"
                        ]
                      }
                    }
                  ],
                  "supportStrategy": "carrier_approval_required"
                },
                "limitedQuantity": {
                  "countries": [
                    "string"
                  ],
                  "countryOverrides": [
                    {
                      "applicableCountries": [
                        "string"
                      ],
                      "categories": [
                        {
                          "applicableClasses": [
                            "string"
                          ],
                          "applicableDivisions": [
                            "string"
                          ],
                          "applicableIdentificationNumbers": [
                            "string"
                          ],
                          "applicableShippingNames": [
                            "string"
                          ],
                          "excludedClasses": [
                            "string"
                          ],
                          "excludedDivisions": [
                            "string"
                          ],
                          "excludedIdentificationNumbers": [
                            "string"
                          ],
                          "excludedShippingNames": [
                            "string"
                          ],
                          "maxVolume": 0,
                          "maxWeight": 0,
                          "volumeUnit": "ml",
                          "weightUnit": "lb"
                        }
                      ],
                      "excludedCountries": [
                        "string"
                      ],
                      "excludedPostalCodesByCountry": {
                        "additionalProp1": [
                          "string"
                        ],
                        "additionalProp2": [
                          "string"
                        ],
                        "additionalProp3": [
                          "string"
                        ]
                      },
                      "excludedRegionByCountry": {
                        "additionalProp1": [
                          "string"
                        ],
                        "additionalProp2": [
                          "string"
                        ],
                        "additionalProp3": [
                          "string"
                        ]
                      }
                    }
                  ],
                  "exclusionsByPostalCode": {
                    "additionalProp1": [
                      "string"
                    ],
                    "additionalProp2": [
                      "string"
                    ],
                    "additionalProp3": [
                      "string"
                    ]
                  },
                  "exclusionsByRegion": {
                    "additionalProp1": [
                      "string"
                    ],
                    "additionalProp2": [
                      "string"
                    ],
                    "additionalProp3": [
                      "string"
                    ]
                  },
                  "omitHazmatDetailsOnCarrierCall": true,
                  "supportStrategy": "carrier_approval_required"
                }
              },
              "hazmatLimitedQuantityExempt": true,
              "injectionAddress": {
                "addressType": "commercial",
                "city": "Albuquerque",
                "company": "ACME",
                "countryCode": "US",
                "emailAddress": "string",
                "name": "Wile E. Coyote",
                "phoneNumber": "string",
                "phoneNumberCountryCode": "+2",
                "postalCode": "87121",
                "state": "NM",
                "street1": "123 Main St.",
                "street2": "Suite 42"
              },
              "injectionLimitDestinations": true,
              "injectionProfileType": "carrier_provided_transportation_to_injection_site",
              "injectionRateModifier": {
                "modifierType": "flat",
                "modifierValue": 0
              },
              "injectionSiteTimezoneId": {
                "id": "string",
                "rules": {
                  "fixedOffset": true,
                  "transitionRules": [
                    {
                      "dayOfMonthIndicator": 0,
                      "dayOfWeek": "FRIDAY",
                      "localTime": {
                        "hour": 0,
                        "minute": 0,
                        "nano": 0,
                        "second": 0
                      },
                      "midnightEndOfDay": true,
                      "month": "APRIL",
                      "offsetAfter": {
                        "id": "string",
                        "rules": "string",
                        "totalSeconds": 0
                      },
                      "offsetBefore": {
                        "id": "string",
                        "rules": "string",
                        "totalSeconds": 0
                      },
                      "standardOffset": {
                        "id": "string",
                        "rules": "string",
                        "totalSeconds": 0
                      },
                      "timeDefinition": "STANDARD"
                    }
                  ],
                  "transitions": [
                    {
                      "dateTimeAfter": "2023-08-18T22:54:48.728Z",
                      "dateTimeBefore": "2023-08-18T22:54:48.728Z",
                      "duration": {
                        "nano": 0,
                        "negative": true,
                        "seconds": 0,
                        "units": [
                          {
                            "dateBased": true,
                            "duration": "string",
                            "durationEstimated": true,
                            "timeBased": true
                          }
                        ],
                        "zero": true
                      },
                      "gap": true,
                      "instant": "2023-08-18T22:54:48.728Z",
                      "offsetAfter": {
                        "id": "string",
                        "rules": "string",
                        "totalSeconds": 0
                      },
                      "offsetBefore": {
                        "id": "string",
                        "rules": "string",
                        "totalSeconds": 0
                      },
                      "overlap": true
                    }
                  ]
                }
              },
              "injectionSupportedDestinations": [
                {
                  "countryCode": "string",
                  "postalCodes": [
                    "string"
                  ]
                }
              ],
              "injectionTimeInTransitDays": 0,
              "labelAugmentations": [
                {
                  "fulfillmentCenterIds": [
                    "string"
                  ],
                  "injectionPosition": "bottom",
                  "name": "string",
                  "shipmentTagToMatch": "string",
                  "zpl": "string"
                }
              ],
              "originBasedSupportedRegionsByCountry": {
                "exclude": "US [HI,PR]",
                "include": "a service method only available in AK, US[AK]"
              },
              "originId": "string",
              "partnerId": "string",
              "partnerInjectionProfileId": "string",
              "partnerInjectionSiteId": "string",
              "partnerThirdPartyBillingAccountId": "string",
              "poBoxDeliveryExclusionsByCountry": [
                {
                  "allowedRegions": "US [HI,PR]",
                  "countryCode": "US"
                }
              ],
              "restrictions": {
                "customsValue": [
                  {
                    "conditions": {
                      "applicableCountries": [
                        "string"
                      ],
                      "excludedCountries": [
                        "string"
                      ]
                    },
                    "currency": "string",
                    "maxValue": 0
                  }
                ],
                "dimensions": [
                  {
                    "combined": 0,
                    "conditions": {
                      "applicableCountries": [
                        "string"
                      ],
                      "excludedCountries": [
                        "string"
                      ]
                    },
                    "dimensionUnit": "string",
                    "height": 0,
                    "length": 0,
                    "packageType": "box",
                    "thresholdType": "floor",
                    "width": 0
                  }
                ],
                "weights": [
                  {
                    "conditions": {
                      "applicableCountries": [
                        "string"
                      ],
                      "excludedCountries": [
                        "string"
                      ]
                    },
                    "packageType": "box",
                    "thresholdType": "floor",
                    "weight": 0,
                    "weightUnit": "string"
                  }
                ]
              },
              "returnToAddress": {
                "addressType": "commercial",
                "city": "Albuquerque",
                "company": "ACME",
                "countryCode": "US",
                "emailAddress": "string",
                "name": "Wile E. Coyote",
                "phoneNumber": "string",
                "phoneNumberCountryCode": "+2",
                "postalCode": "87121",
                "state": "NM",
                "street1": "123 Main St.",
                "street2": "Suite 42"
              },
              "saturdayDeliveryType": "all_zip_codes",
              "selectionModifiers": [
                {
                  "active": true,
                  "applicableIdentifiers": {
                    "carrier": "fedex",
                    "carrierRateId": "cb387c97-5a1c-4018-aecb-b6a7ff7649d5",
                    "carrierServiceMethodId": "fedex-home-delivery-service-method",
                    "fulfillmentContextId": "ff66d0fd-6354-416b-89cb-63f9d3971d65",
                    "injectionProfileId": "36f96f8f-c910-4eba-9ed5-2ae27557b141",
                    "originId": "d7e7cda6-9948-43fb-b595-f8b230f6b1a8",
                    "shipiumTenantId": "2da905a5-43c4-48ef-9860-36fd7d9d24f9"
                  },
                  "archived": true,
                  "criteria": [
                    {}
                  ],
                  "effectiveDateTime": "2022-04-13T13:15:19Z",
                  "expirationDateTime": "2022-04-18T08:11:55Z",
                  "name": "Block Texas For Slow carrier",
                  "partnerId": "f8569788-5001-4242-a04e-6156268011cd",
                  "selectionModifierId": "3826769e-aa5b-4a98-9966-50326b5cda28",
                  "selectionModifierUrn": "urn:selectionmodifier:3826769e-aa5b-4a98-9966-50326b5cda28:1",
                  "treatment": {
                    "applyTestMode": true,
                    "areaModifier": {
                      "areaModifierType": "fullPostalInclusion",
                      "areas": [
                        "12345",
                        "98765"
                      ]
                    },
                    "augmentationId": "80943a2c-7ec9-46ff-b7fe-eb8127d0e57c",
                    "labelAugmentation": {
                      "augmentationZpl": "string",
                      "labelAugmentPosition": "bottom",
                      "name": "string",
                      "shipmentTagToMatch": "string"
                    }
                  }
                }
              ],
              "serviceMethodIdentifier": "urn:carrierrate:86c6230a-4a2b-4f9b-8b71-a51627bbbcb2:1",
              "serviceMethodInTestMode": true,
              "serviceMethodName": "UPS SurePost",
              "serviceMethodUrn": "string",
              "shipiumInjectionProfileId": "string",
              "shipiumInjectionSiteId": "string",
              "shipiumTenantId": "string",
              "shipiumThirdPartyBillingAccountId": "string",
              "shipperAddress": {
                "addressType": "commercial",
                "city": "Albuquerque",
                "company": "ACME",
                "countryCode": "US",
                "emailAddress": "string",
                "name": "Wile E. Coyote",
                "phoneNumber": "string",
                "phoneNumberCountryCode": "+2",
                "postalCode": "87121",
                "state": "NM",
                "street1": "123 Main St.",
                "street2": "Suite 42"
              },
              "sortFacilityAddress": {
                "addressType": "commercial",
                "city": "Albuquerque",
                "company": "ACME",
                "countryCode": "US",
                "emailAddress": "string",
                "name": "Wile E. Coyote",
                "phoneNumber": "string",
                "phoneNumberCountryCode": "+2",
                "postalCode": "87121",
                "state": "NM",
                "street1": "123 Main St.",
                "street2": "Suite 42"
              },
              "taxIdentificationNumber": "string",
              "thirdPartyBillingSupported": true,
              "thirdPartyCredentials": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
              },
              "transportationType": "string",
              "unitedStatesPrincipalPartyInInterestAddress": {
                "addressType": "commercial",
                "city": "Albuquerque",
                "company": "ACME",
                "countryCode": "US",
                "emailAddress": "string",
                "name": "Wile E. Coyote",
                "phoneNumber": "string",
                "phoneNumberCountryCode": "+2",
                "postalCode": "87121",
                "state": "NM",
                "street1": "123 Main St.",
                "street2": "Suite 42"
              }
            }
          ]
        },
        "serviceMethodIdentifier": "string",
        "serviceMethodName": "string",
        "serviceMethodUrn": "string",
        "status": "no_decision",
        "statusDetails": "string",
        "thirdPartyBilling": true
      },
      "carrierSelectionDateTime": "2023-08-18T22:54:48.728Z",
      "carrierSelectionExpiration": "2023-08-18T22:54:48.728Z",
      "carrierSelectionId": "string",
      "partnerShipmentId": "string",
      "partnerTenantId": "string",
      "ruleSetProcessingResult": {
        "filteredCarrierServiceMethods": [
          {
            "filterReason": "string",
            "filterReasons": [
              "string"
            ],
            "serviceMethodIdentifier": "string",
            "serviceMethodUrn": "string"
          }
        ],
        "processingTimestamp": "2023-08-18T22:54:48.728Z",
        "result": "no_selection",
        "ruleMakingSelection": {
          "name": "string",
          "ruleId": "string",
          "ruleUrn": "string"
        },
        "ruleSetUrn": "string",
        "selectedCarrierServiceMethods": [
          {
            "allowCarrierFailover": true,
            "bpmContentOnly": true,
            "carrier": "string",
            "carrierAccountId": "string",
            "carrierAccountInTestMode": true,
            "carrierRateId": "string",
            "carrierServiceMethodId": "ups-ground-service-method",
            "carrierServiceName": "UPS(MO)",
            "carrierSettingsId": "string",
            "credentials": {
              "additionalProp1": "string",
              "additionalProp2": "string",
              "additionalProp3": "string"
            },
            "deliverySignatureTypes": [
              "AdultResidentSignature"
            ],
            "destinationCountries": [
              "string"
            ],
            "destinationType": "string",
            "failoverUndeliverable": true,
            "fulfillmentCenterIds": [
              "string"
            ],
            "fulfillmentContextId": "string",
            "fulfillmentContextPriority": 0,
            "fulfillmentContexts": [
              "string"
            ],
            "hazmat": {
              "dangerousGoods": {
                "countryOverrides": [
                  {
                    "applicableCountries": [
                      "string"
                    ],
                    "categories": [
                      {
                        "applicableClasses": [
                          "string"
                        ],
                        "applicableDivisions": [
                          "string"
                        ],
                        "applicableIdentificationNumbers": [
                          "string"
                        ],
                        "applicableShippingNames": [
                          "string"
                        ],
                        "excludedClasses": [
                          "string"
                        ],
                        "excludedDivisions": [
                          "string"
                        ],
                        "excludedIdentificationNumbers": [
                          "string"
                        ],
                        "excludedShippingNames": [
                          "string"
                        ],
                        "maxVolume": 0,
                        "maxWeight": 0,
                        "volumeUnit": "ml",
                        "weightUnit": "lb"
                      }
                    ],
                    "excludedCountries": [
                      "string"
                    ],
                    "excludedPostalCodesByCountry": {
                      "additionalProp1": [
                        "string"
                      ],
                      "additionalProp2": [
                        "string"
                      ],
                      "additionalProp3": [
                        "string"
                      ]
                    },
                    "excludedRegionByCountry": {
                      "additionalProp1": [
                        "string"
                      ],
                      "additionalProp2": [
                        "string"
                      ],
                      "additionalProp3": [
                        "string"
                      ]
                    }
                  }
                ],
                "supportStrategy": "carrier_approval_required"
              },
              "limitedQuantity": {
                "countries": [
                  "string"
                ],
                "countryOverrides": [
                  {
                    "applicableCountries": [
                      "string"
                    ],
                    "categories": [
                      {
                        "applicableClasses": [
                          "string"
                        ],
                        "applicableDivisions": [
                          "string"
                        ],
                        "applicableIdentificationNumbers": [
                          "string"
                        ],
                        "applicableShippingNames": [
                          "string"
                        ],
                        "excludedClasses": [
                          "string"
                        ],
                        "excludedDivisions": [
                          "string"
                        ],
                        "excludedIdentificationNumbers": [
                          "string"
                        ],
                        "excludedShippingNames": [
                          "string"
                        ],
                        "maxVolume": 0,
                        "maxWeight": 0,
                        "volumeUnit": "ml",
                        "weightUnit": "lb"
                      }
                    ],
                    "excludedCountries": [
                      "string"
                    ],
                    "excludedPostalCodesByCountry": {
                      "additionalProp1": [
                        "string"
                      ],
                      "additionalProp2": [
                        "string"
                      ],
                      "additionalProp3": [
                        "string"
                      ]
                    },
                    "excludedRegionByCountry": {
                      "additionalProp1": [
                        "string"
                      ],
                      "additionalProp2": [
                        "string"
                      ],
                      "additionalProp3": [
                        "string"
                      ]
                    }
                  }
                ],
                "exclusionsByPostalCode": {
                  "additionalProp1": [
                    "string"
                  ],
                  "additionalProp2": [
                    "string"
                  ],
                  "additionalProp3": [
                    "string"
                  ]
                },
                "exclusionsByRegion": {
                  "additionalProp1": [
                    "string"
                  ],
                  "additionalProp2": [
                    "string"
                  ],
                  "additionalProp3": [
                    "string"
                  ]
                },
                "omitHazmatDetailsOnCarrierCall": true,
                "supportStrategy": "carrier_approval_required"
              }
            },
            "hazmatLimitedQuantityExempt": true,
            "injectionAddress": {
              "addressType": "commercial",
              "city": "Albuquerque",
              "company": "ACME",
              "countryCode": "US",
              "emailAddress": "string",
              "name": "Wile E. Coyote",
              "phoneNumber": "string",
              "phoneNumberCountryCode": "+2",
              "postalCode": "87121",
              "state": "NM",
              "street1": "123 Main St.",
              "street2": "Suite 42"
            },
            "injectionLimitDestinations": true,
            "injectionProfileType": "carrier_provided_transportation_to_injection_site",
            "injectionRateModifier": {
              "modifierType": "flat",
              "modifierValue": 0
            },
            "injectionSiteTimezoneId": {
              "id": "string",
              "rules": {
                "fixedOffset": true,
                "transitionRules": [
                  {
                    "dayOfMonthIndicator": 0,
                    "dayOfWeek": "FRIDAY",
                    "localTime": {
                      "hour": 0,
                      "minute": 0,
                      "nano": 0,
                      "second": 0
                    },
                    "midnightEndOfDay": true,
                    "month": "APRIL",
                    "offsetAfter": {
                      "id": "string",
                      "rules": "string",
                      "totalSeconds": 0
                    },
                    "offsetBefore": {
                      "id": "string",
                      "rules": "string",
                      "totalSeconds": 0
                    },
                    "standardOffset": {
                      "id": "string",
                      "rules": "string",
                      "totalSeconds": 0
                    },
                    "timeDefinition": "STANDARD"
                  }
                ],
                "transitions": [
                  {
                    "dateTimeAfter": "2023-08-18T22:54:48.728Z",
                    "dateTimeBefore": "2023-08-18T22:54:48.728Z",
                    "duration": {
                      "nano": 0,
                      "negative": true,
                      "seconds": 0,
                      "units": [
                        {
                          "dateBased": true,
                          "duration": "string",
                          "durationEstimated": true,
                          "timeBased": true
                        }
                      ],
                      "zero": true
                    },
                    "gap": true,
                    "instant": "2023-08-18T22:54:48.728Z",
                    "offsetAfter": {
                      "id": "string",
                      "rules": "string",
                      "totalSeconds": 0
                    },
                    "offsetBefore": {
                      "id": "string",
                      "rules": "string",
                      "totalSeconds": 0
                    },
                    "overlap": true
                  }
                ]
              }
            },
            "injectionSupportedDestinations": [
              {
                "countryCode": "string",
                "postalCodes": [
                  "string"
                ]
              }
            ],
            "injectionTimeInTransitDays": 0,
            "labelAugmentations": [
              {
                "fulfillmentCenterIds": [
                  "string"
                ],
                "injectionPosition": "bottom",
                "name": "string",
                "shipmentTagToMatch": "string",
                "zpl": "string"
              }
            ],
            "originBasedSupportedRegionsByCountry": {
              "exclude": "US [HI,PR]",
              "include": "a service method only available in AK, US[AK]"
            },
            "originId": "string",
            "partnerId": "string",
            "partnerInjectionProfileId": "string",
            "partnerInjectionSiteId": "string",
            "partnerThirdPartyBillingAccountId": "string",
            "poBoxDeliveryExclusionsByCountry": [
              {
                "allowedRegions": "US [HI,PR]",
                "countryCode": "US"
              }
            ],
            "restrictions": {
              "customsValue": [
                {
                  "conditions": {
                    "applicableCountries": [
                      "string"
                    ],
                    "excludedCountries": [
                      "string"
                    ]
                  },
                  "currency": "string",
                  "maxValue": 0
                }
              ],
              "dimensions": [
                {
                  "combined": 0,
                  "conditions": {
                    "applicableCountries": [
                      "string"
                    ],
                    "excludedCountries": [
                      "string"
                    ]
                  },
                  "dimensionUnit": "string",
                  "height": 0,
                  "length": 0,
                  "packageType": "box",
                  "thresholdType": "floor",
                  "width": 0
                }
              ],
              "weights": [
                {
                  "conditions": {
                    "applicableCountries": [
                      "string"
                    ],
                    "excludedCountries": [
                      "string"
                    ]
                  },
                  "packageType": "box",
                  "thresholdType": "floor",
                  "weight": 0,
                  "weightUnit": "string"
                }
              ]
            },
            "returnToAddress": {
              "addressType": "commercial",
              "city": "Albuquerque",
              "company": "ACME",
              "countryCode": "US",
              "emailAddress": "string",
              "name": "Wile E. Coyote",
              "phoneNumber": "string",
              "phoneNumberCountryCode": "+2",
              "postalCode": "87121",
              "state": "NM",
              "street1": "123 Main St.",
              "street2": "Suite 42"
            },
            "saturdayDeliveryType": "all_zip_codes",
            "selectionModifiers": [
              {
                "active": true,
                "applicableIdentifiers": {
                  "carrier": "fedex",
                  "carrierRateId": "cb387c97-5a1c-4018-aecb-b6a7ff7649d5",
                  "carrierServiceMethodId": "fedex-home-delivery-service-method",
                  "fulfillmentContextId": "ff66d0fd-6354-416b-89cb-63f9d3971d65",
                  "injectionProfileId": "36f96f8f-c910-4eba-9ed5-2ae27557b141",
                  "originId": "d7e7cda6-9948-43fb-b595-f8b230f6b1a8",
                  "shipiumTenantId": "2da905a5-43c4-48ef-9860-36fd7d9d24f9"
                },
                "archived": true,
                "criteria": [
                  {}
                ],
                "effectiveDateTime": "2022-04-13T13:15:19Z",
                "expirationDateTime": "2022-04-18T08:11:55Z",
                "name": "Block Texas For Slow carrier",
                "partnerId": "f8569788-5001-4242-a04e-6156268011cd",
                "selectionModifierId": "3826769e-aa5b-4a98-9966-50326b5cda28",
                "selectionModifierUrn": "urn:selectionmodifier:3826769e-aa5b-4a98-9966-50326b5cda28:1",
                "treatment": {
                  "applyTestMode": true,
                  "areaModifier": {
                    "areaModifierType": "fullPostalInclusion",
                    "areas": [
                      "12345",
                      "98765"
                    ]
                  },
                  "augmentationId": "80943a2c-7ec9-46ff-b7fe-eb8127d0e57c",
                  "labelAugmentation": {
                    "augmentationZpl": "string",
                    "labelAugmentPosition": "bottom",
                    "name": "string",
                    "shipmentTagToMatch": "string"
                  }
                }
              }
            ],
            "serviceMethodIdentifier": "urn:carrierrate:86c6230a-4a2b-4f9b-8b71-a51627bbbcb2:1",
            "serviceMethodInTestMode": true,
            "serviceMethodName": "UPS SurePost",
            "serviceMethodUrn": "string",
            "shipiumInjectionProfileId": "string",
            "shipiumInjectionSiteId": "string",
            "shipiumTenantId": "string",
            "shipiumThirdPartyBillingAccountId": "string",
            "shipperAddress": {
              "addressType": "commercial",
              "city": "Albuquerque",
              "company": "ACME",
              "countryCode": "US",
              "emailAddress": "string",
              "name": "Wile E. Coyote",
              "phoneNumber": "string",
              "phoneNumberCountryCode": "+2",
              "postalCode": "87121",
              "state": "NM",
              "street1": "123 Main St.",
              "street2": "Suite 42"
            },
            "sortFacilityAddress": {
              "addressType": "commercial",
              "city": "Albuquerque",
              "company": "ACME",
              "countryCode": "US",
              "emailAddress": "string",
              "name": "Wile E. Coyote",
              "phoneNumber": "string",
              "phoneNumberCountryCode": "+2",
              "postalCode": "87121",
              "state": "NM",
              "street1": "123 Main St.",
              "street2": "Suite 42"
            },
            "taxIdentificationNumber": "string",
            "thirdPartyBillingSupported": true,
            "thirdPartyCredentials": {
              "additionalProp1": "string",
              "additionalProp2": "string",
              "additionalProp3": "string"
            },
            "transportationType": "string",
            "unitedStatesPrincipalPartyInInterestAddress": {
              "addressType": "commercial",
              "city": "Albuquerque",
              "company": "ACME",
              "countryCode": "US",
              "emailAddress": "string",
              "name": "Wile E. Coyote",
              "phoneNumber": "string",
              "phoneNumberCountryCode": "+2",
              "postalCode": "87121",
              "state": "NM",
              "street1": "123 Main St.",
              "street2": "Suite 42"
            }
          }
        ]
      },
      "shipiumShipmentId": "string",
      "shipiumTenantId": "string"
    },
    "failureReason": "string",
    "filteredFulfillmentContextDetails": [
      {
        "fulfillmentContextId": "string",
        "matchInformation": [
          "string"
        ],
        "matchOriginId": "string",
        "matchParams": {
          "asOfDateTime": "2023-08-18T22:54:48.728Z",
          "country": "string",
          "fulfillmentContextId": "string",
          "fulfillmentType": "at_large",
          "partnerId": "string",
          "postalCode": "string",
          "tags": [
            "string"
          ],
          "thirdPartyBillingAccountSetId": "string",
          "urn": "string"
        },
        "matchPartnerProvidedTenantId": "string",
        "matchShipiumTenantId": "string",
        "matchThirdPartyBillingAccountSetId": "string",
        "matchThirdPartyBillingAccountSetPartnerProvidedId": "string",
        "matchType": "direct_request",
        "name": "string",
        "partnerId": "string",
        "urn": "string"
      }
    ],
    "fulfillmentContextDetailsSearch": {
      "country": "string",
      "fulfillmentType": "at_large",
      "partnerId": "string",
      "postalCode": "string",
      "tag": "string",
      "tenantId": "string",
      "thirdPartyBillingAccountSetId": "string"
    },
    "httpStatusCode": 0,
    "matchedFulfillmentContextDetail": {
      "fulfillmentContextId": "string",
      "matchInformation": [
        "string"
      ],
      "matchOriginId": "string",
      "matchParams": {
        "asOfDateTime": "2023-08-18T22:54:48.728Z",
        "country": "string",
        "fulfillmentContextId": "string",
        "fulfillmentType": "at_large",
        "partnerId": "string",
        "postalCode": "string",
        "tags": [
          "string"
        ],
        "thirdPartyBillingAccountSetId": "string",
        "urn": "string"
      },
      "matchPartnerProvidedTenantId": "string",
      "matchShipiumTenantId": "string",
      "matchThirdPartyBillingAccountSetId": "string",
      "matchThirdPartyBillingAccountSetPartnerProvidedId": "string",
      "matchType": "direct_request",
      "name": "string",
      "partnerId": "string",
      "urn": "string"
    },
    "matchingShipOptionDetail": {
      "name": "string",
      "partnerId": "string",
      "partnerProvidedId": "string",
      "shipOptionEntries": {
        "description": "string",
        "name": "string",
        "originId": "string",
        "partnerProvidedId": "string",
        "serviceMethods": [
          "string"
        ],
        "shipOptionEntryId": "FE91F3A8-6838-469A-B9F8-2D82127573DC"
      },
      "shipOptionId": "FE91F3A8-6838-469A-B9F8-2D82127573DC"
    },
    "megaMethodRequestParams": {
      "asOfDate": "2023-08-18T22:54:48.728Z",
      "currencyCode": "string",
      "generateLabel": true,
      "includeInjectionProfiles": true,
      "injectionParameters": [
        {
          "injectionProfileId": "string",
          "injectionSiteId": "string"
        }
      ],
      "labelParameters": {
        "currencyCode": "string",
        "customLabelEntries": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "includeLabelImagesInResponse": true,
        "labelFormats": [
          "string"
        ],
        "manifest": true,
        "testMode": true
      },
      "shipmentParameters": {
        "businessDaysOfTransit": 3,
        "carrierName": "UPS",
        "carrierTrackingId": "1Z999AA10123456784",
        "customsInfo": {
          "aesInternalTransactionNumber": "string",
          "customsDescription": "9 mm steel screws",
          "customsItems": [
            {
              "commodityDescription": "baby socks",
              "commodityPartNumber": "string",
              "countryOfManufacture": "CN",
              "customsValue": 12.34,
              "customsValueCurrency": "usd",
              "customsWeight": {
                "weight": 50,
                "weightUnit": "lb"
              },
              "electronicExportCommodityInformation": {
                "eccnNumber": "EAR99",
                "exportInformationCode": "LC",
                "exportLicenseInformation": {
                  "exportLicense": {
                    "licenseExpirationDate": "2023-08-18",
                    "licenseLineValue": 0,
                    "licenseNumber": "string"
                  },
                  "licenseExemptionCode": "NLR",
                  "licenseType": "C33"
                },
                "exportType": "domestic",
                "scheduleBInformation": {
                  "scheduleBNumber": "6404195500",
                  "scheduleBQuantity": 0,
                  "scheduleBUnitOfMeasurement": "barrels"
                }
              },
              "harmonizedTariffNumber": "string",
              "marksAndNumbers": "string",
              "productId": "RN03947--Z43121",
              "quantity": 3,
              "quantityUnitOfMeasurement": "bag"
            }
          ],
          "electronicExportInformation": {
            "exportDate": "2023-08-18",
            "pointOfOrigin": "string"
          },
          "invoiceDate": "1970-01-01",
          "invoiceNumber": "abcde-f12345-67890-abcdef",
          "reasonForExport": "sale",
          "totalCustomsValue": 12.34,
          "totalCustomsValueCurrency": "usd",
          "ultimateConsigneeAddress": {
            "addressType": "commercial",
            "city": "Albuquerque",
            "company": "ACME",
            "countryCode": "US",
            "emailAddress": "string",
            "name": "Wile E. Coyote",
            "phoneNumber": "string",
            "phoneNumberCountryCode": "+2",
            "postalCode": "87121",
            "state": "NM",
            "street1": "123 Main St.",
            "street2": "Suite 42"
          },
          "ultimateConsigneeType": "DIRECT_CONSUMER"
        },
        "deliveredDateTime": "2019-10-31T10:50:11.123456Z",
        "deliveryNote": "string",
        "deliverySignatureOption": "resident_signature",
        "deliveryWindow": {
          "endWindow": {
            "hour": 0,
            "minute": 0,
            "nano": 0,
            "second": 0
          },
          "startWindow": {
            "hour": 0,
            "minute": 0,
            "nano": 0,
            "second": 0
          },
          "timeZone": {
            "id": "string",
            "rules": {
              "fixedOffset": true,
              "transitionRules": [
                {
                  "dayOfMonthIndicator": 0,
                  "dayOfWeek": "FRIDAY",
                  "localTime": {
                    "hour": 0,
                    "minute": 0,
                    "nano": 0,
                    "second": 0
                  },
                  "midnightEndOfDay": true,
                  "month": "APRIL",
                  "offsetAfter": {
                    "id": "string",
                    "rules": "string",
                    "totalSeconds": 0
                  },
                  "offsetBefore": {
                    "id": "string",
                    "rules": "string",
                    "totalSeconds": 0
                  },
                  "standardOffset": {
                    "id": "string",
                    "rules": "string",
                    "totalSeconds": 0
                  },
                  "timeDefinition": "STANDARD"
                }
              ],
              "transitions": [
                {
                  "dateTimeAfter": "2023-08-18T22:54:48.728Z",
                  "dateTimeBefore": "2023-08-18T22:54:48.728Z",
                  "duration": {
                    "nano": 0,
                    "negative": true,
                    "seconds": 0,
                    "units": [
                      {
                        "dateBased": true,
                        "duration": "string",
                        "durationEstimated": true,
                        "timeBased": true
                      }
                    ],
                    "zero": true
                  },
                  "gap": true,
                  "instant": "2023-08-18T22:54:48.728Z",
                  "offsetAfter": {
                    "id": "string",
                    "rules": "string",
                    "totalSeconds": 0
                  },
                  "offsetBefore": {
                    "id": "string",
                    "rules": "string",
                    "totalSeconds": 0
                  },
                  "overlap": true
                }
              ]
            }
          }
        },
        "desiredDeliveryDate": "2019-10-31T20:00:00Z",
        "destinationAddress": {
          "addressType": "commercial",
          "city": "Albuquerque",
          "company": "ACME",
          "countryCode": "US",
          "emailAddress": "string",
          "name": "Wile E. Coyote",
          "phoneNumber": "string",
          "phoneNumberCountryCode": "+2",
          "postalCode": "87121",
          "state": "NM",
          "street1": "123 Main St.",
          "street2": "Suite 42"
        },
        "forceThirdPartyBilling": true,
        "fulfillmentContext": "string",
        "fulfillmentType": "at_large",
        "ignoreUpgradeSpendLimits": true,
        "orderItemQuantities": [
          {
            "deliveryEstimateId": "0b3d140a-525b-43a7-896c-cdc381580d61",
            "hazmat": true,
            "hazmatInfo": {
              "category": "defined",
              "containerType": "aluminum_jerrican",
              "hazardClass": "class_8_corrosive_material",
              "hazmatId": "UN1755",
              "packingGroup": "ii",
              "packingInstructionCode": "967",
              "properShippingName": "Chromic Acid Solution",
              "quantity": 2.1,
              "quantityType": "gross",
              "quantityUnits": "l",
              "subsidiaryClasses": [
                "8.1"
              ],
              "transportMode": "passenger_and_cargo_aircraft"
            },
            "partnerOrderId": "myCustomPartnerOrderId123",
            "productDetails": [
              "string"
            ],
            "productId": "RN03947--Z43121",
            "quantity": 3,
            "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312"
          }
        ],
        "orderedDateTime": "2019-10-29T09:12:33.123456Z",
        "packagingType": {
          "linearDimensions": {
            "height": 10,
            "length": 13,
            "linearUnit": "in",
            "width": 12
          },
          "packagingMaterial": "box",
          "packagingSizeName": "13x12x10 Box",
          "packagingTypeId": "ebd94f8b-d390-4c9c-987f-b88343f5bf45",
          "packagingWeight": {
            "weight": 50,
            "weightUnit": "lb"
          }
        },
        "partnerShipmentId": "myCustomPartnerShipmentId123",
        "purchaseOrderIdentifier": "string",
        "referenceIdentifier": "string",
        "referenceIdentifier2": "string",
        "referenceIdentifier3": "string",
        "referenceIdentifier4": "string",
        "referenceIdentifier5": "string",
        "saturdayDelivery": true,
        "shipFromAddress": {
          "addressType": "commercial",
          "city": "Albuquerque",
          "company": "ACME",
          "countryCode": "US",
          "emailAddress": "string",
          "name": "Wile E. Coyote",
          "phoneNumber": "string",
          "phoneNumberCountryCode": "+2",
          "postalCode": "87121",
          "state": "NM",
          "street1": "123 Main St.",
          "street2": "Suite 42"
        },
        "shipOption": "Standard",
        "shipmentTags": [
          "string"
        ],
        "shippedDateTime": "2019-10-29T09:12:33.123456Z",
        "tenantId": "string",
        "thirdPartyBillingSetId": "string",
        "totalWeight": {
          "weight": 50,
          "weightUnit": "lb"
        }
      },
      "simulation": true
    }
  },
  "estimatedDeliveryDate": "2023-08-18T22:54:48.728Z",
  "forceThirdPartyBilling": true,
  "fulfillmentCenterId": "74065136-85c2-499b-b893-bd812ac0c00f",
  "fulfillmentContext": "string",
  "fulfillmentContextId": "string",
  "fulfillmentType": "at_large",
  "ignoreUpgradeSpendLimits": true,
  "injectionAddress": {
    "addressType": "commercial",
    "city": "Albuquerque",
    "company": "ACME",
    "countryCode": "US",
    "emailAddress": "string",
    "name": "Wile E. Coyote",
    "phoneNumber": "string",
    "phoneNumberCountryCode": "+2",
    "postalCode": "87121",
    "state": "NM",
    "street1": "123 Main St.",
    "street2": "Suite 42"
  },
  "orderItemQuantities": [
    {
      "deliveryEstimateId": "0b3d140a-525b-43a7-896c-cdc381580d61",
      "hazmat": true,
      "hazmatInfo": {
        "category": "defined",
        "containerType": "aluminum_jerrican",
        "hazardClass": "class_8_corrosive_material",
        "hazmatId": "UN1755",
        "packingGroup": "ii",
        "packingInstructionCode": "967",
        "properShippingName": "Chromic Acid Solution",
        "quantity": 2.1,
        "quantityType": "gross",
        "quantityUnits": "l",
        "subsidiaryClasses": [
          "8.1"
        ],
        "transportMode": "passenger_and_cargo_aircraft"
      },
      "partnerOrderId": "myCustomPartnerOrderId123",
      "productDetails": [
        "string"
      ],
      "productId": "RN03947--Z43121",
      "quantity": 3,
      "shipiumOrderId": "4dc43fff-c3af-4d7b-8a18-e01f2b4cb312"
    }
  ],
  "orderedDateTime": "2019-10-29T09:12:33.123456Z",
  "packagingType": {
    "linearDimensions": {
      "height": 10,
      "length": 13,
      "linearUnit": "in",
      "width": 12
    },
    "packagingMaterial": "box",
    "packagingSizeName": "13x12x10 Box",
    "packagingTypeId": "ebd94f8b-d390-4c9c-987f-b88343f5bf45",
    "packagingWeight": {
      "weight": 50,
      "weightUnit": "lb"
    }
  },
  "partnerShipmentId": "myCustomPartnerShipmentId123",
  "partnerTenantId": "string",
  "partnerThirdPartyBillingSetId": "string",
  "purchaseOrderIdentifier": "string",
  "rawDesiredDeliveryDate": "2019-10-31T10:50:11.123456Z",
  "referenceIdentifier": "string",
  "referenceIdentifier2": "string",
  "referenceIdentifier3": "string",
  "referenceIdentifier4": "string",
  "referenceIdentifier5": "string",
  "requestTenantId": "string",
  "requestThirdPartyBillingSetId": "string",
  "saturdayDelivery": true,
  "shipFromAddress": {
    "addressType": "commercial",
    "city": "Albuquerque",
    "company": "ACME",
    "countryCode": "US",
    "emailAddress": "string",
    "name": "Wile E. Coyote",
    "phoneNumber": "string",
    "phoneNumberCountryCode": "+2",
    "postalCode": "87121",
    "state": "NM",
    "street1": "123 Main St.",
    "street2": "Suite 42"
  },
  "shipOption": "Standard",
  "shipiumShipmentId": "0840c7a2-e6ab-4755-8aa2-9a986297ad6d",
  "shipiumTenantId": "string",
  "shipiumThirdPartyBillingSetId": "string",
  "shipmentProperties": [
    "string"
  ],
  "shipmentTags": [
    "string"
  ],
  "shippedDateTime": "2019-10-29T09:12:33.123456Z",
  "totalWeight": {
    "weight": 50,
    "weightUnit": "lb"
  }
}

Resources

Your Shipium team member is available to help along the way. However, you might find these resources helpful:

Batch Label Creation API

Get started

Retrieve batch shipping labels from the Batch Label Creation API

📘
Authentication for API Calls

Test the API call

👉
Test mode

Example cURL call

Example request body

Example standard response without full shipment details

Example response with full shipment details

Resources

Get started

Retrieve batch shipping labels from the Batch Label Creation API

📘Authentication for API Calls

Test the API call

👉Test mode

Example cURL call

Example request body

Example standard response without full shipment details

Example response with full shipment details

Resources

📘
Authentication for API Calls

👉
Test mode