Skip to content

Packaging ​

Type: schema

Description ​

Packing dimensions for a product without variants. null when the product has variants, or when no packaging is configured.

TypeScript Definition ​

typescript
Packaging: {{
            /** Format: float */
            pack_width: number;
            /** Format: float */
            pack_height: number;
            /** Format: float */
            pack_length: number;
            /** Format: float */
            pack_dry_weight: number;
            /** Format: int32 */
            units_per_pack: number;
            /** @description Indicates whether items can be rotated during packing or must be kept in a strictly vertical orientation. */
            vertical_rotation: boolean;
            /** Format: float */
            shipper_width: number | null;
            /** Format: float */
            shipper_height: number | null;
            /** Format: float */
            shipper_length: number | null;
            /** Format: float */
            shipper_dry_weight: number | null;
            /** Format: int32 */
            units_per_shipper: number | null;
        } | null;
        /**
         * @description pagination metadata structure
         * @example {
         *       "total_records": 100,
         *       "total_pages": 4,
         *       "previous_page": null,
         *       "next_page": 2,
         *       "limit": 25
         *     }
         */
}

OpenAPI Schema ​

json
{
  "title": "Packaging",
  "description": "Packing dimensions for a product without variants. `null` when the product has variants, or when no packaging is configured.",
  "type": [
    "object",
    "null"
  ],
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/Packaging",
    "description": "API reference for the Packaging schema"
  },
  "required": [
    "pack_width",
    "pack_height",
    "pack_length",
    "pack_dry_weight",
    "units_per_pack",
    "vertical_rotation",
    "shipper_width",
    "shipper_height",
    "shipper_length",
    "shipper_dry_weight",
    "units_per_shipper"
  ],
  "properties": {
    "pack_width": {
      "type": "number",
      "format": "float"
    },
    "pack_height": {
      "type": "number",
      "format": "float"
    },
    "pack_length": {
      "type": "number",
      "format": "float"
    },
    "pack_dry_weight": {
      "type": "number",
      "format": "float"
    },
    "units_per_pack": {
      "type": "integer",
      "format": "int32"
    },
    "vertical_rotation": {
      "description": "Indicates whether items can be rotated during packing or must be kept in a strictly vertical orientation.",
      "type": "boolean"
    },
    "shipper_width": {
      "type": [
        "number",
        "null"
      ],
      "format": "float"
    },
    "shipper_height": {
      "type": [
        "number",
        "null"
      ],
      "format": "float"
    },
    "shipper_length": {
      "type": [
        "number",
        "null"
      ],
      "format": "float"
    },
    "shipper_dry_weight": {
      "type": [
        "number",
        "null"
      ],
      "format": "float"
    },
    "units_per_shipper": {
      "type": [
        "integer",
        "null"
      ],
      "format": "int32"
    }
  },
  "x-tags": [
    "Catalog"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: