Batch Label Creation API
Learn how to use Shipium's Batch Label Creation API to generate multiple shipment labels in one call.
About the Batch Label Creation API
Creating shipping labels in batches is possible through the Batch Label Creation application programming interface (API), which enables your organization to retrieve labels for up to 150 shipments in one API call to Shipium's Carrier Selection service.
This document provides guidance for using the Batch Label Creation API. The Carrier and Method Selection with Label Single Call document provides more information about using the Carrier Selection service and printing labels.
Getting started with Shipium
If your organization doesn't already have a Shipium account, you'll want to visit Getting Started with Shipium to set up your account before you can use the Batch Label Creation API.
Retrieve batch shipping labels from the 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 | /api/v1/shipment/bulkprocessing/labels |
Authentication for API Calls
In the cURL example on this page, the environment variable
AUTHSTRINGis 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
Testing the API call
The ping endpoint for testing your API call is included in the following table.
| API type | API endpoint |
|---|---|
| PING | /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 Implementation team member is available to help along the way. However, you might find these resources helpful:
Updated about 2 months ago