Skip to content

ShipmentItem

Type: schema

Description

Shipment item model

TypeScript Definition

typescript
ShipmentItem: {{
            product_id?: string;
            product_name?: string;
            product_image_url?: string | null;
            sku?: string;
            quantity?: number;
            free_quantity?: number;
            is_free_item?: boolean;
        };
        /**
         * SingleSelectAttribute
         * @description Attribute for single-select values
         */
}

OpenAPI Schema

json
{
  "title": "ShipmentItem",
  "description": "Shipment item model",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/ShipmentItem",
    "description": "API reference for the ShipmentItem schema"
  },
  "properties": {
    "product_id": {
      "type": "string"
    },
    "product_name": {
      "type": "string"
    },
    "product_image_url": {
      "type": [
        "string",
        "null"
      ]
    },
    "sku": {
      "type": "string"
    },
    "quantity": {
      "type": "integer"
    },
    "free_quantity": {
      "type": "integer"
    },
    "is_free_item": {
      "type": "boolean"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: