Get started

The Packaging Planner API typically is called with three different kinds of data, depending on the use case: full linear dimensions, packaging IDs, or package set IDs. To call the API using full linear dimensions, you can begin with the instructions in this document.

To use the Packaging Planner API with packaging or package set IDs, you must first configure your account. Guidance can be found in the Packaging Planner documentation.

Retrieve packaging guidance from the Packaging Planner 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.

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.

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.

Packing strategies

When retrieving packaging guidance, you can specify different options that affect which packing algorithm is used. You also can include a compression factor to be applied to your packing strategy.

Packing algorithms

The packing algorithms currently supported are listed in the following table.

Volumetric packing algorithm options

When using the volumetric algorithm, you can specify a packingAlgorithmOptions.volumetricPackingEfficiency that will allow your packing to be constrained more (less than 1) or less (greater than 1) than the raw dimensions of the packaging.

Another optional specification within packingAlgorithmOptions is pureVolumetricPacking. This option does not place restrictions on product height, width, or length relative to the size of the packaging.

Packing algorithm block example

{
  "packingStrategyOptions": {
    "packingAlgorithm": "volumetric",
    "packingAlgorithmOptions": {
      "pureVolumetricPacking": true,
      "volumetricPackingEfficiency": 1.0
    }
  }
}

Packing compression

You can opt to include a compression factor in your packing strategy, whether standard or volumetric, that reflects the degree to which a product can be compressed in one or more dimensions. You'll specify values for the productCompressionFactor property within the items array.

Packing compression block example

{
  "productCompressionFactor": {
    "compressionFactor": 0.2,
    "compressHeight": true,
    "compressWidth": false,
    "compressLength": false
  }
}

Packaging compression block in context of the items block

{
  "items": [
    {
      "productId": "item1",
      "productLinearDimensions": {
        "width": 1,
        "length": 1,
        "height": 1,
        "linearUnit": "in"
      },
      "productWeight": { "weight": 1, "weightUnit": "oz" },
      "quantity": 5,
      "productCompressionFactor": {
        "compressionFactor": 0.1,
        "compressDepth": true,
        "compressWidth": true,
        "compressHeight": true
      }
    }
  ]
}

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

The following tables provide 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.

Required fields

Optional fields

Packing strategy options (applies to all use cases)

The following optional fields can be included with any of the above use cases to specify packing algorithm behavior.

Optional fields

Packing compression options (applies to all use cases)

The following optional fields can be included within the items array for any use case to specify compression behavior.

Optional fields

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" },
      "maxItemsPerPackage": 10
    },
    {
      "linearDimensions": {
        "height": 10,
        "length": 10,
        "linearUnit": "in",
        "width": 10
      },
      "maxContentWeight": { "weight": 50, "weightUnit": "lb" },
      "packagingMaterial": "box",
      "packagingSizeName": "10x10x10",
      "packagingWeight": { "weight": 1, "weightUnit": "lb" },
      "maxItemsPerPackage": 20
    },
    {
      "linearDimensions": {
        "height": 6,
        "length": 6,
        "linearUnit": "in",
        "width": 6
      },
      "maxContentWeight": { "weight": 50, "weightUnit": "lb" },
      "packagingMaterial": "box",
      "packagingSizeName": "6x6x6",
      "packagingWeight": { "weight": 1, "weightUnit": "lb" },
      "maxItemsPerPackage": 15
    }
  ],
  "referenceIdentifier": "PACKAGE_A",
  "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
    }
  ]
}

Resources

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

• Terms and Definitions
• Troubleshooting Guide
• Contact Shipium Support

Updated 6 months ago