SHshipium
packagePlanner

POST /api/v1/packaging/planner

Changed on

Request

Request body

OR
OR

Example request

{
  "items": [
    {
      "productDetails": [
        "Fragile",
        "ORMD"
      ]
    }
  ],
  "packaging": [
    {
      "packagingMaterial": "box",
      "unsupportedProductDetails": [
        "Li-ion"
      ]
    }
  ]
}

Response

Default Response

packageCountnumber
packagePlanIdstring
volumetricPackEfficiencynumber
maxItemsPerPackagenumber nullable
referenceIdentifierstring
referenceIdentifier2string
referenceIdentifier3string
referenceIdentifier4string
referenceIdentifier5string

Example response

{
  "unpackableItems": [
    {
      "productDetails": [
        "Fragile",
        "ORMD"
      ]
    }
  ],
  "packages": [
    {
      "packagingMaterial": "box",
      "packageContents": [
        {
          "productDetails": [
            "Fragile",
            "ORMD"
          ]
        }
      ]
    }
  ]
}

Changes