---
title: "POST /api/v1/packaging/planner"
method: POST
path: "/api/v1/packaging/planner"
tags: ["packagePlanner"]
---

# POST /api/v1/packaging/planner

`POST /api/v1/packaging/planner`

## Headers

- `x-delegated-partner-id` string

## Request body

- union
  - object
    - `includeDetails` boolean, nullable
    - `items` ProductSchema[], required
      - `productLinearDimensions` LinearDimensionSchema, required
        - `linearUnit` 'in' | 'cm', required
        - `length` number, required
        - `height` number, required
        - `width` number, required
      - `productWeight` WeightSchema, required
        - `weight` number, required
        - `weightUnit` 'lb' | 'kg' | 'g' | 'oz', required
      - `quantity` number, required
      - `productId` string, required
      - `productReferenceIdentifier` string
      - `productDetails` string[], nullable, required — Product details that the packaging does not support.
      - `productCompressionFactor` object, nullable
        - `compressionFactor` number
        - `compressHeight` boolean
        - `compressWidth` boolean
        - `compressDepth` boolean
    - `packagingIds` string[], nullable
    - `packagingSetId` string, nullable
    - `packaging` PartnerPackagingSchema[], nullable, required
      - `linearDimensions` LinearDimensionSchema, required
        - `linearUnit` 'in' | 'cm', required
        - `length` number, required
        - `height` number, required
        - `width` number, required
      - `maxContentWeight` WeightSchema, required
        - `weight` number, required
        - `weightUnit` 'lb' | 'kg' | 'g' | 'oz', required
      - `packagingWeight` WeightSchema, required
        - `weight` number, required
        - `weightUnit` 'lb' | 'kg' | 'g' | 'oz', required
      - `packagingMaterial` 'box' | 'envelope' | 'flat_pack', required — The type of packaging used to create the package for the shipment.
      - `packagingSizeName` string, required
      - `packagingTypeId` string
      - `unsupportedProductDetails` string[], nullable — Product details that the packaging does not support.
    - `packingStrategyOptions` PackingStrategySchema, nullable
      - `packingAlgorithm` 'standard' | 'volumetric'
      - `packingAlgorithmOptions` object, nullable
        - `volumetricPackingEfficiency` number
        - `pureVolumetricPacking` boolean, nullable
    - `maxItemsPerPackage` number, nullable
    - `referenceIdentifier` string
    - `referenceIdentifier2` string
    - `referenceIdentifier3` string
    - `referenceIdentifier4` string
    - `referenceIdentifier5` string
  - object
    - `includeDetails` boolean, nullable
    - `items` ProductSchema[], required
      - `productLinearDimensions` LinearDimensionSchema, required
        - `linearUnit` 'in' | 'cm', required
        - `length` number, required
        - `height` number, required
        - `width` number, required
      - `productWeight` WeightSchema, required
        - `weight` number, required
        - `weightUnit` 'lb' | 'kg' | 'g' | 'oz', required
      - `quantity` number, required
      - `productId` string, required
      - `productReferenceIdentifier` string
      - `productDetails` string[], nullable, required — Product details that the packaging does not support.
      - `productCompressionFactor` object, nullable
        - `compressionFactor` number
        - `compressHeight` boolean
        - `compressWidth` boolean
        - `compressDepth` boolean
    - `packagingIds` string[], nullable
    - `packagingSetId` string, nullable, required
    - `packaging` PartnerPackagingSchema[], nullable
      - `linearDimensions` LinearDimensionSchema, required
        - `linearUnit` 'in' | 'cm', required
        - `length` number, required
        - `height` number, required
        - `width` number, required
      - `maxContentWeight` WeightSchema, required
        - `weight` number, required
        - `weightUnit` 'lb' | 'kg' | 'g' | 'oz', required
      - `packagingWeight` WeightSchema, required
        - `weight` number, required
        - `weightUnit` 'lb' | 'kg' | 'g' | 'oz', required
      - `packagingMaterial` 'box' | 'envelope' | 'flat_pack', required — The type of packaging used to create the package for the shipment.
      - `packagingSizeName` string, required
      - `packagingTypeId` string
      - `unsupportedProductDetails` string[], nullable — Product details that the packaging does not support.
    - `packingStrategyOptions` PackingStrategySchema, nullable
      - `packingAlgorithm` 'standard' | 'volumetric'
      - `packingAlgorithmOptions` object, nullable
        - `volumetricPackingEfficiency` number
        - `pureVolumetricPacking` boolean, nullable
    - `maxItemsPerPackage` number, nullable
    - `referenceIdentifier` string
    - `referenceIdentifier2` string
    - `referenceIdentifier3` string
    - `referenceIdentifier4` string
    - `referenceIdentifier5` string
  - object
    - `includeDetails` boolean, nullable
    - `items` ProductSchema[], required
      - `productLinearDimensions` LinearDimensionSchema, required
        - `linearUnit` 'in' | 'cm', required
        - `length` number, required
        - `height` number, required
        - `width` number, required
      - `productWeight` WeightSchema, required
        - `weight` number, required
        - `weightUnit` 'lb' | 'kg' | 'g' | 'oz', required
      - `quantity` number, required
      - `productId` string, required
      - `productReferenceIdentifier` string
      - `productDetails` string[], nullable, required — Product details that the packaging does not support.
      - `productCompressionFactor` object, nullable
        - `compressionFactor` number
        - `compressHeight` boolean
        - `compressWidth` boolean
        - `compressDepth` boolean
    - `packagingIds` string[], nullable, required
    - `packagingSetId` string, nullable
    - `packaging` PartnerPackagingSchema[], nullable
      - `linearDimensions` LinearDimensionSchema, required
        - `linearUnit` 'in' | 'cm', required
        - `length` number, required
        - `height` number, required
        - `width` number, required
      - `maxContentWeight` WeightSchema, required
        - `weight` number, required
        - `weightUnit` 'lb' | 'kg' | 'g' | 'oz', required
      - `packagingWeight` WeightSchema, required
        - `weight` number, required
        - `weightUnit` 'lb' | 'kg' | 'g' | 'oz', required
      - `packagingMaterial` 'box' | 'envelope' | 'flat_pack', required — The type of packaging used to create the package for the shipment.
      - `packagingSizeName` string, required
      - `packagingTypeId` string
      - `unsupportedProductDetails` string[], nullable — Product details that the packaging does not support.
    - `packingStrategyOptions` PackingStrategySchema, nullable
      - `packingAlgorithm` 'standard' | 'volumetric'
      - `packingAlgorithmOptions` object, nullable
        - `volumetricPackingEfficiency` number
        - `pureVolumetricPacking` boolean, nullable
    - `maxItemsPerPackage` number, nullable
    - `referenceIdentifier` string
    - `referenceIdentifier2` string
    - `referenceIdentifier3` string
    - `referenceIdentifier4` string
    - `referenceIdentifier5` string

## Response `200`

Default Response

- object
  - `packageCount` number
  - `packagePlanId` string
  - `unpackableItems` ProductResponseSchema[], nullable
    - `productLinearDimensions` LinearDimensionSchema
      - `linearUnit` 'in' | 'cm', required
      - `length` number, required
      - `height` number, required
      - `width` number, required
    - `productWeight` WeightSchema
      - `weight` number, required
      - `weightUnit` 'lb' | 'kg' | 'g' | 'oz', required
    - `quantity` number, required
    - `productId` string, required
    - `productReferenceIdentifier` string
    - `productDetails` string[] — Product details that the packaging does not support.
    - `productCompressionFactor` object, nullable
      - `compressionFactor` number
      - `compressHeight` boolean
      - `compressWidth` boolean
      - `compressDepth` boolean
  - `packages` BinPackingPackageSchema[]
    - `linearDimensions` LinearDimensionSchema
      - `linearUnit` 'in' | 'cm', required
      - `length` number, required
      - `height` number, required
      - `width` number, required
    - `maxContentWeight` WeightSchema
      - `weight` number, required
      - `weightUnit` 'lb' | 'kg' | 'g' | 'oz', required
    - `packagingWeight` WeightSchema
      - `weight` number, required
      - `weightUnit` 'lb' | 'kg' | 'g' | 'oz', required
    - `packagingMaterial` 'box' | 'envelope' | 'flat_pack' — The type of packaging used to create the package for the shipment.
    - `packagePlanPackageId` string
    - `packagingTypeId` string
    - `packagingSizeName` string
    - `packageEstimatedWeight` WeightSchema
      - `weight` number, required
      - `weightUnit` 'lb' | 'kg' | 'g' | 'oz', required
    - `volumetricPackEfficiency` number
    - `maxItemsPerPackage` number
    - `packageContents` ProductResponseSchema[], nullable
      - `productLinearDimensions` LinearDimensionSchema
        - `linearUnit` 'in' | 'cm', required
        - `length` number, required
        - `height` number, required
        - `width` number, required
      - `productWeight` WeightSchema
        - `weight` number, required
        - `weightUnit` 'lb' | 'kg' | 'g' | 'oz', required
      - `quantity` number, required
      - `productId` string, required
      - `productReferenceIdentifier` string
      - `productDetails` string[] — Product details that the packaging does not support.
      - `productCompressionFactor` object, nullable
        - `compressionFactor` number
        - `compressHeight` boolean
        - `compressWidth` boolean
        - `compressDepth` boolean
  - `volumetricPackEfficiency` number
  - `packingStrategyOptions` PackingStrategySchema, nullable
    - `packingAlgorithm` 'standard' | 'volumetric'
    - `packingAlgorithmOptions` object, nullable
      - `volumetricPackingEfficiency` number
      - `pureVolumetricPacking` boolean, nullable
  - `maxItemsPerPackage` number, nullable
  - `referenceIdentifier` string
  - `referenceIdentifier2` string
  - `referenceIdentifier3` string
  - `referenceIdentifier4` string
  - `referenceIdentifier5` string

---

[API](https://skmtc.net/shipium/apis/shipium-api.md) · [All operations](https://skmtc.net/shipium/apis/shipium-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shipium/shipium-api/revisions/7ef5dbd6a025/schema)