Packaging Planner

Learn how to use Shipium's Packaging Planner API to optimize your organization's shipment packaging.

Suggest Edits

About the Packaging Planner API

Selecting the best box available for a shipment can present challenges. The Packaging Planner application programming interface (API) simplifies this process by configuring the boxes you need for your shipment.

There are three ways to call the Packaging Planner API:

  • With Full Linear Dimensions. This method requires no additional configuration of your Shipium account to make calls to the API. You simply include the dimensions of packaging and shipment contents in the API call.
  • With Packaging IDs. You establish packaging IDs for your most common box sizes and then include the packagingId value(s) in the API call.
  • With Package Set ID. You group common box size configurations into sets and then include the packageSetId value(s) in the API call. This method could be beneficial if your fulfillment center has a specific set of boxes available that you can refer to in each API call.

This document provides guidance for each use case. When including full linear dimensions for a shipment's contents, no additional configuration is required. However, if your organization includes an identification for a package or a package set, you'll need to configure your Shipium account in order to call the Packaging Planner API successfully.

📘

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 Packaging Planner API.

The following section includes instructions for enabling your account to be able to call the APIs with packaging IDs or packaging set IDs.

Configuring your account to enable use of the Packaging Planner API (with packaging IDs or packaging set ID)

To start using the Packaging Planner API by including packaging IDs or packaging set IDs, you’ll need to complete the following steps. First, you'll need to access the Shipium Console.

For configuration of either packaging IDs or packaging set IDs, you'll start by navigating to Configure and then Fulfillment Configuration in the lefthand menu.

Packaging IDs

Within Fulfillment Configuration, you'll scroll to the Packaging Configuration category, which includes Packaging.

After selecting Packaging, you'll complete the following steps to establishing packaging standards for your organization.

  1. Select the + Add Packaging button at the bottom of the + Add Packaging card, or select the + icon at the top left of the card.
  1. You'll need to provide the required information about your packaging type(s). If you need assistance estimating packaging weight information, you might find the technical specifications for typical box sizes from Uline helpful.
  • Linear Unit. You'll select centimeters or inches as your unit of measurement from the dropdown menu.
  • Weight Unit. You'll select kilograms or pounds as your unit of weight from the dropdown menu.
  • Packaging Length. This is the numerical value of the longest side of your package.
  • Packaging Width. This is the numerical value of the second longest side of your package.
  • Packaging Height. This is the numerical value of the shortest side of your package.
  • Packaging Weight. This is the numerical value of the estimated weight of your package.
  • Max Content Weight. This is the numerical value of the estimated maximum weight of the entirety of contents typically packed into a shipment of this packaging size for your organization.
  • Packaging Material. You'll select box, envelope, or flat pack as your packaging type from the dropdown menu.
  • Unsupported Product Details. You can optionally designate types of products as restricted from this packaging type by selecting ORMD (Other Regulated Materials—Domestic), LIO (Lithium-Ion), or Fragile from the dropdown menu.
  • Name. The name is what you want to call this packaging setup. The package dimensions and package type auto-populate in this field. Shipium recommends keeping this value as the name and appending it with additional identifying information.
  • Description. You can provide an optional description to help organize your packaging.

Next, you'll have an opportunity to review the Add Packaging Summary before saving the new packaging.

Obtain the packagingId value needed for the API call

  1. To retrieve the packagingId value to pass in the API call, you'll need to access the details of your newly created packaging by selecting Detail within its card on your Packaging homepage.
  1. The Packaging ID value to copy is located near the top left of the details screen, as shown in the following screenshot. You'll include this value as the packagingId when calling Shipium's APIs.

Packaging Set IDs

Within Fulfillment Configuration, you'll scroll to the Packaging Configuration category, which includes Packaging Set.

After selecting Packaging Set, you'll complete the following steps to establish packaging sets for your organization.

  1. Select the + Add Packaging Sets button at the bottom of the + Add Packaging Set card, or select the + icon at the top left of the card.
  1. You'll need to provide the required information about your packaging type(s):
  • Name. The name is what you want to call this packaging set. Shipium recommends including the name of the facility that uses this packaging.
  • Description. You can provide an optional description to help organize your packaging sets.
  • Packaging Select. From the dropdown menu, you'll choose the packaging you created when adding new packaging that you wish to include in this packaging set.

Next, you'll have an opportunity to review the Add Packaging Set Summary before saving the new packaging set.

Obtain the packagingSetId value needed for the API call

  1. To retrieve the packagingSetId value to pass in the API call, you'll need to access the details of your newly created packaging set by selecting Detail within its card on your Packaging Set homepage.
  1. The Packaging Set ID value to copy is located near the top left of the details screen, as shown in the following screenshot. You'll include this value as the packagingSetId when calling Shipium's APIs.

Retrieve packaging guidance from the API

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

API typeAPI endpoint
POST/api/v1/packaging/planner

📘

Authentication for API Calls

In the cURL examples 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

Testing the API call

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

API typeAPI endpoint
GET/api/v1/packaging/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"
}

Shipium assumptions for the Packaging Planner API

  • Package and content properties
    All items being packed and all packages being packed into are three-dimensional, solid, rectangular objects or can be represented as such.

Response attributes for all use cases calling the Packaging Planner API

The Packaging Planner response attributes for passing full linear dimensions, packaging IDs, and packaging set IDs in the API call are defined in the following table.

Response attributeDescription
packagePlanIdA universally unique identifier (UUID) value representing this unique package plan response
packageCountThe number of boxes that the items were packed into. This will be 1 unless the items are evaluated not to fit into the largest box available. The prioritization is the use of fewest packages based on cost.
packagesThe boxes that were selected and the items that were packed into each box
packages.packagePlanPackageIdA UUID uniquely identifying this package as part of this unique plan
packages.linearDimensionsLinear dimensions and unit of measurement of the box available for items to be packed into
packages.linearDimensions.lengthThe numerical value of the longest side of the box
packages.linearDimensions.widthThe numerical value of the second longest side of the box
packages.linearDimensions.heightThe numerical value of the shortest side of the box
packages.linearDimensions.linearUnitUnits dimensions specified in either centimeters or inches
packages.maxContentWeightMaximum total combined weight of the items packed into the box
packages.maxContentWeight.weightMaximum weight of the packed items
packages.maxContentWeight.weightUnitThe unit of measurement the maximum weight is specified in
packages.packageContentsA list of the items packed into the box
packages.packageEstimatedWeightThe estimated weight of the packed box and all its contents
packages.packageEstimatedWeight.weightThe weight of the packed box
packages.packageEstimatedWeight.weightUnitThe unit of measurement the estimated weight is specified in
packages.packagingTypeIdThe Shipium ID value for the packaging that was selected
Note: This response attribute is only returned when calling the API with Packaging ID(s) or Packaging Set ID(s).
packages.packagingSizeNameThe name assigned to the specified box size
packages.packagingWeightThe weight of the empty packaging
packages.packagingWeight.weightThe weight of the unpacked, empty box
packages.packagingWeight.weightUnitThe unit of measurement the packaging weight is specified in
volumetricPackEfficiencyCalculation of the entire volume of packed items and the selected box's available volume

Retrieve packaging guidance by including full linear dimensions in the API call (primary use case)

The following table provides all required and optional fields for calling the Packaging Planner API with full linear dimensions of your package contents. You can find additional support in the Packaging Planner API Reference.

Request fieldRequired/OptionalField typeDescription
itemsRequiredAn array of Item entities.A list of the items to be packed into an available box
includeDetailsRequiredBoolean
Limited to true, false, or empty. Defaults to true, which results in full linear dimensions of the items being returned in the API call response		A flag indicating whether to include dimensional details of the items to be packed in the API call response
packagingRequiredPackaging
Must contain at least one item		Dimensions and restrictions for available boxes to pack the items into
packaging.linearDimensionsRequiredLinear DimensionThe linear dimensions and unit of a box available for packing
packaging.linearDimensions.lengthRequiredDecimal
Limited to a value greater than zero		Length of the longest side of the box to be packed
packaging.linearDimensions.widthRequiredDecimal
Limited to a value greater than zero		Length of the second longest side of the box to be packed
packaging.linearDimensions.heightRequiredDecimal
Limited to a value greater than zero		Length of the shortest side of the box to be packed
packaging.linearDimensions.linearUnitRequiredString
Limited to inch (in) or centimeter (cm)		The unit of measurement the linear dimensions of the box are specified in
packaging.maxContentWeightRequiredWeightThe maximum total combined weight of the items packed into the box
packaging.maxContentWeight.weightRequiredDecimal
Limited to a positive value		The maximum weight of all the packed items
packaging.maxContentWeight.weightUnitRequiredString enumeration
Limited to either pound (lb) or kilogram (kg)		The unit of measurement the maximum weight is specified in
packaging.packagingWeightRequiredWeightThe weight of the empty box
packaging.packagingWeight.weightRequiredDecimal
Limited to a positive value		The weight of the empty box
packaging.packagingWeight.weightUnitRequiredString enumeration
Limited to either pound (lb) or kilogram (kg)		The unit of measurement the empty box weight is specified in
packaging.unsupportedProductDetailsOptionalString enumeration
Limited to ormd (Other Regulated Materials—Domestic), li (Lithium-Ion), or fragile 		Restricted product types that cannot be packed into this box (e.g., hazmat)

Example cURL call

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

Example request body

{
  "packaging": [
    {
      "linearDimensions": {
        "height": 1,
        "length": 1,
        "linearUnit": "in",
        "width": 1
      },
      "maxContentWeight": {
        "weight": 50,
        "weightUnit": "lb"
      },
      "packagingMaterial": "box",
      "packagingSizeName": "1x1x1",
      "packagingWeight": {
        "weight": 1,
        "weightUnit": "lb"
      }
    },
    {
      "linearDimensions": {
        "height": 10,
        "length": 10,
        "linearUnit": "in",
        "width": 10
      },
      "maxContentWeight": {
        "weight": 50,
        "weightUnit": "lb"
      },
      "packagingMaterial": "box",
      "packagingSizeName": "10x10x10",
      "packagingWeight": {
        "weight": 1,
        "weightUnit": "lb"
      }
    },
        {
      "linearDimensions": {
        "height": 6,
        "length": 6,
        "linearUnit": "in",
        "width": 6
      },
      "maxContentWeight": {
        "weight": 50,
        "weightUnit": "lb"
      },
      "packagingMaterial": "box",
      "packagingSizeName": "6x6x6",
      "packagingWeight": {
        "weight": 1,
        "weightUnit": "lb"
      }
    }
  ],
    "items": [
        {
           "productLinearDimensions": {
                "width": 2,
                "length": 2,
                "height": 2,
                "linearUnit": "in"
            },
            "productId": "item1",
            "productWeight": {
                "weight": 2,
                "weightUnit": "oz"
            },
            "quantity": 1
        },
        {
            "productLinearDimensions": {
                "width": 4,
                "length": 4,
                "height": 4,
                "linearUnit": "in"
            },
            "productId": "item2",
            "productWeight": {
                "weight": 1,
                "weightUnit": "oz"
            },
            "quantity": 1
        }
    ]
}

Example standard response body

{
   "packagePlanId": "5fd53424-c47f-4acd-8d8d-b950adf641ee",
   "packageCount":1,
   "unpackableItems":[],
   "packages":[
      {
         "packagePlanPackageId": "d696b20e-b060-4169-89e7-75178135b7f1",
         "linearDimensions":{
            "linearUnit":"in",
            "length":5.5,
            "height":5,
            "width":5
         },
         "maxContentWeight":{
            "weight":100,
            "weightUnit":"oz"
         },
         "packagingWeight":{
            "weight":2,
            "weightUnit":"oz"
         },
         "packagingMaterial":"box",
         "packagingSizeName":"5x5x5",
         "packageEstimatedWeight":{
            "weight":3,
            "weightUnit":"oz"
         },
         "packageContents":[
            {
               "productLinearDimensions":{
                  "width":1,
                  "length":2,
                  "height":1,
                  "linearUnit":"in"
               },
               "productId":"item2",
               "productWeight":{
                  "weight":2,
                  "weightUnit":"oz"
               },
               "quantity":2,
               "productDetails":[
                  
               ]
            }
         ]
      }
   ],
   "volumetricPackEfficiency":46.55
}

Example response containing unpackable items

{
   "packagePlanId": "f5a6e6de-9df3-48f1-9171-dcce9947576a",
   "packageCount":1,
   "unpackableItems":[
      {
         "productLinearDimensions":{
            "width":100,
            "length":200,
            "height":100,
            "linearUnit":"in"
         },
         "productId":"bigolproductthatisstillsomehow2oz",
         "productWeight":{
            "weight":2,
            "weightUnit":"oz"
         },
         "quantity":1,
         "productDetails":[
            
         ]
      }
   ],
   "packages":[
      {
         "packagePlanPackageId": "27ed6590-f068-4168-8e2c-2fa0fbf73957",
         "linearDimensions":{
            "linearUnit":"in",
            "length":5.5,
            "height":5,
            "width":5
         },
         "maxContentWeight":{
            "weight":100,
            "weightUnit":"oz"
         },
         "packagingWeight":{
            "weight":2,
            "weightUnit":"oz"
         },
         "packagingMaterial":"box",
         "packagingSizeName":"5x5x5",
         "packageEstimatedWeight":{
            "weight":3,
            "weightUnit":"oz"
         },
         "packageContents":[
            {
               "productLinearDimensions":{
                  "width":1,
                  "length":2,
                  "height":1,
                  "linearUnit":"in"
               },
               "productId":"item2",
               "productWeight":{
                  "weight":2,
                  "weightUnit":"oz"
               },
               "quantity":2,
               "productDetails":[
                  
               ]
            }
         ]
      }
   ],
   "volumetricPackEfficiency":46.55
}

Example response containing unpackable items with "includeDetails": false

{
   "packagePlanId": "e56cbc7d-a630-4ed6-9da8-4e77166b23e8",
   "packageCount":1,
   "unpackableItems":[
      {
         "productId":"bigolproductthatisstillsomehow2oz",
         "quantity":1,
      }
   ],
   "packages":[
      {
         "packagePlanPackageId": "4353ea95-4a7c-40f4-8998-5bd17a4bf676",
         "linearDimensions":{
            "linearUnit":"in",
            "length":5.5,
            "height":5,
            "width":5
         },
         "maxContentWeight":{
            "weight":100,
            "weightUnit":"oz"
         },
         "packagingWeight":{
            "weight":2,
            "weightUnit":"oz"
         },
         "packagingMaterial":"box",
         "packagingSizeName":"5x5x5",
         "packageEstimatedWeight":{
            "weight":3,
            "weightUnit":"oz"
         },
         "packageContents":[
            {
               "productId":"item2",
               "quantity":2,
            }
         ]
      }
   ],
   "volumetricPackEfficiency":46.55
}

Retrieve packaging guidance by including packaging IDs in the API call

The following table provides all required and optional fields for calling the Packaging Planner API with packaging ID(s). You can find additional support in the Packaging Planner API Reference.

Request fieldRequired/OptionalField propertiesDescription
includeDetailsRequiredBoolean
Boolean
Limited to TRUE, FALSE, or empty. Defaults to TRUE, which results in full linear dimensions of the items being returned in the API call response		A flag indicating whether to include dimensional details of the items to be packed in the API call response
itemsRequiredItemA list of the items to be packed into an available box
packagingIdsRequiredarray of String values
Limited to valid IDs found within the Shipium platform		A list of strings representing the Shipium generated ID of a packaging asset configured through the Shipium console

Example cURL call

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

Example request body

{
    "packagingIds": ["4610efde-2270-449e-a187-cd18b4e8316b","5463ceca-15f4-11ee-be56-0242ac120002"],
    "items": [
        {
            "productLinearDimensions": {
                "width": 2,
                "length": 2,
                "height": 2,
                "linearUnit": "in"
            },
            "productId": "item1",
            "productWeight": {
                "weight": 2,
                "weightUnit": "oz"
            },
            "quantity": 1
        },
        {
            "productLinearDimensions": {
                "width": 4,
                "length": 4,
                "height": 4,
                "linearUnit": "in"
            },
            "productId": "item2",
            "productWeight": {
                "weight": 1,
                "weightUnit": "oz"
            },
            "quantity": 1
        }
    ]
}

Example standard response

{
   "packagePlanId": "01b727d9-dd1c-4b57-b51a-9b6d49b73534",
   "packageCount":1,
   "packages":[
      {
         "packagePlanPackageId": "467b50bc-988e-4e9a-a520-4b6a63c9ced8",
         "linearDimensions":{
            "linearUnit":"in",
            "length":5.5,
            "height":5,
            "width":5
         },
         "maxContentWeight":{
            "weight":100,
            "weightUnit":"oz"
         },
         "packagingWeight":{
            "weight":2,
            "weightUnit":"oz"
         },
         "packagingMaterial":"box",
         "packagingSizeName":"5x5x5",
         "packageEstimatedWeight":{
            "weight":3,
            "weightUnit":"oz"
         },
         packagingTypeId: "5463ceca-15f4-11ee-be56-0242ac120002",
         "packageContents":[
            {
               "productLinearDimensions":{
                  "width":1,
                  "length":2,
                  "height":1,
                  "linearUnit":"in"
               },
               "productId":"item2",
               "productWeight":{
                  "weight":2,
                  "weightUnit":"oz"
               },
               "quantity":2,
               "productDetails":[
                  
               ]
            }
         ]
      }
   ],
   "volumetricPackEfficiency":46.55
}

Example response for request to not include product details in response

{
   "packagePlanId": "77db2333-ddd2-4824-be9d-b7f5c11de3cc",
   "packageCount":1,
   "packages":[
      {
         "packagePlanPackageId": "9077bcdd-911d-4b4c-88c7-b1a0a40f5eb0",
         "linearDimensions":{
            "linearUnit":"in",
            "length":5.5,
            "height":5,
            "width":5
         },
         "maxContentWeight":{
            "weight":100,
            "weightUnit":"oz"
         },
         "packagingWeight":{
            "weight":2,
            "weightUnit":"oz"
         },
         "packagingMaterial":"box",
         "packagingSizeName":"5x5x5",
         "packageEstimatedWeight":{
            "weight":3,
            "weightUnit":"oz"
         },
         packagingTypeId: "5463ceca-15f4-11ee-be56-0242ac120002",
         "packageContents":[
            {
               "productId":"item2",
               "quantity":2
            }
         ]
      }
   ],
   "volumetricPackEfficiency":46.55
}

Retrieve packaging guidance by including packaging set IDs in the API call

The following table provides all required and optional fields for calling the Packaging Planner API with packaging set ID(s). You can find additional support in the Packaging Planner API Reference.

Request fieldRequired/OptionalField propertiesDescription
includeDetailsRequiredBoolean
Boolean
Limited to TRUE, FALSE, or empty. Defaults to TRUE, which results in full linear dimensions of the items being returned in the API call response		A flag indicating whether to include dimensional details of the items to be packed in the API call response
itemsRequiredItemA list of the items to be packed into an available box
items.productDetailsOptionalString
Limited to ORMD (Other Regulated Materials—Domestic), LIO (Lithium-Ion), or Fragile		Product details that could affect the boxes available to pack the items into, due to box type restrictions for shipping these types of products
items.productIdRequiredString
Required when products cannot fit into a single box and need to be split into two boxes		Identifier for the product being packed
items.productLinearDimensionsRequiredLinear DimensionThe linear dimensions and unit of an item to be packed
items.productLinearDimension.lengthRequiredDecimal
Limited to a value greater than zero		Length of the longest side of the item to be packed
items.productLinearDimension.widthRequiredDecimal
Limited to a value greater than zero		Length of the second longest side of the item to be packed
items.productLinearDimension.heightRequiredDecimal
Limited to a value greater than zero		Length of the shortest side of the item to be packed
items.productLinearDimension.linearUnitRequiredString
Limited to inch (in) or centimeter (cm)		The unit of measurement the size of the item to be packed is specified in
items.productWeightRequiredWeightThe weight of the item to be packed
items.productWeight.weightRequiredDecimal
Limited to a value greater than zero		The weight of the item to be packed
items.productWeight.weightUnitRequiredString
Limited to either pound (lb) or kilogram (kg)		The unit of measurement the weight of the item to be packed is specified in
items.quantityRequiredInteger
Limited to a value greater than zero		The number of items to be packed
packagingSetIdRequiredString
Limited to a valid ID found within the Shipium platform		A list of strings representing the Shipium generated ID of a packaging set asset configured through the Shipium console

Example cURL call

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

Example request body

{
    "packagingSetId": "d160dda4-cfcf-48be-9842-86c50d6ceea4",
    "items": [
        {
            "productLinearDimensions": {
                "width": 2,
                "length": 2,
                "height": 2,
                "linearUnit": "in"
            },
            "productId": "item1",
            "productWeight": {
                "weight": 2,
                "weightUnit": "oz"
            },
            "quantity": 1
        },
        {
            "productLinearDimensions": {
                "width": 4,
                "length": 4,
                "height": 4,
                "linearUnit": "in"
            },
            "productId": "item2",
            "productWeight": {
                "weight": 1,
                "weightUnit": "oz"
            },
            "quantity": 1
        }
    ]
}

Example standard response

{
   "packagePlanId": "98e713de-ede9-4539-8cda-bf30df660415",
   "packageCount":1,
   "unpackableItems":[
      {
         "productLinearDimensions":{
            "width":100,
            "length":200,
            "height":100,
            "linearUnit":"in"
         },
         "productId":"bigolproductthatisstillsomehow2oz",
         "productWeight":{
            "weight":2,
            "weightUnit":"oz"
         },
         "quantity":1,
         "productDetails":[
            
         ]
      }
   ],
   "packages":[
      {
         "packagePlanPackageId": "d015ac15-2d06-48ee-88c3-1da475e5d0c7",
         "linearDimensions":{
            "linearUnit":"in",
            "length":5.5,
            "height":5,
            "width":5
         },
         "maxContentWeight":{
            "weight":100,
            "weightUnit":"oz"
         },
         "packagingWeight":{
            "weight":2,
            "weightUnit":"oz"
         },
         "packagingMaterial":"box",
         "packagingTypeId":"c26f69e5-a1ce-4b0f-abec-0dded100860c",
         "packagingSizeName":"5x5x5",
         "packageEstimatedWeight":{
            "weight":3,
            "weightUnit":"oz"
         },
         "packageContents":[
            {
               "productLinearDimensions":{
                  "width":1,
                  "length":2,
                  "height":1,
                  "linearUnit":"in"
               },
               "productId":"item2",
               "productWeight":{
                  "weight":2,
                  "weightUnit":"oz"
               },
               "quantity":2,
               "productDetails":[
                  
               ]
            }
         ]
      }
   ],
   "volumetricPackEfficiency":46.55
}

Example response for unpackable items

{
   "packagePlanId": "718a2543-0c35-458b-83c0-f2446947e33c",
   "packageCount":1,
   "unpackableItems":[
      {
         "productLinearDimensions":{
            "width":100,
            "length":200,
            "height":100,
            "linearUnit":"in"
         },
         "productId":"bigolproductthatisstillsomehow2oz",
         "productWeight":{
            "weight":2,
            "weightUnit":"oz"
         },
         "quantity":1,
         "productDetails":[
            
         ]
      }
   ],
   "packages":[
      {
         "packagePlanPackageId": "555dfcac-30e4-4899-8347-aad2a9571718",
         "linearDimensions":{
            "linearUnit":"in",
            "length":5.5,
            "height":5,
            "width":5
         },
         "maxContentWeight":{
            "weight":100,
            "weightUnit":"oz"
         },
         "packagingWeight":{
            "weight":2,
            "weightUnit":"oz"
         },
         "packagingMaterial":"box",
         "packagingTypeId":"c26f69e5-a1ce-4b0f-abec-0dded100860c",
         "packagingSizeName":"5x5x5",
         "packageEstimatedWeight":{
            "weight":3,
            "weightUnit":"oz"
         },
         "packageContents":[
            {
               "productLinearDimensions":{
                  "width":1,
                  "length":2,
                  "height":1,
                  "linearUnit":"in"
               },
               "productId":"item2",
               "productWeight":{
                  "weight":2,
                  "weightUnit":"oz"
               },
               "quantity":2,
               "productDetails":[
                  
               ]
            }
         ]
      }
   ],
   "volumetricPackEfficiency":46.55
}

Example response for unpackable items and request to not include product details in response

{
   "packagePlanId": "0c6e3be0-f8da-4dd1-8ef9-9da5f8ccb469",
   "packageCount":1,
   "unpackableItems":[
      {
         "productId":"bigolproductthatisstillsomehow2oz",
         "quantity":1
      }
   ],
   "packages":[
      {
         "packagePlanPackageId": "0304a14a-a1e9-41b9-b545-935eaf9a392f",
         "linearDimensions":{
            "linearUnit":"in",
            "length":5.5,
            "height":5,
            "width":5
         },
         "maxContentWeight":{
            "weight":100,
            "weightUnit":"oz"
         },
         "packagingWeight":{
            "weight":2,
            "weightUnit":"oz"
         },
         "packagingMaterial":"box",
         "packagingTypeId":"c26f69e5-a1ce-4b0f-abec-0dded100860c",
         "packagingSizeName":"5x5x5",
         "packageEstimatedWeight":{
            "weight":3,
            "weightUnit":"oz"
         },
         "packageContents":[
               "productId":"item2",
               "quantity":2,
            }
         ]
      }
   ],
   "volumetricPackEfficiency":46.55
}

Resources

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

Updated 2 days ago