ShipmentItem

Type: schema

Description

Shipment item model

TypeScript Definition

ShipmentItem: {{
            product_id: string;
            readonly product_name?: string;
            variant_id: string | null;
            readonly variant_name?: string | null;
            readonly product_image_url?: string | null;
            readonly sku?: string;
            quantity: number;
            free_quantity?: number;
            readonly is_free_item?: boolean;
        };
        /** ShipmentList */
}

OpenAPI Schema

{
  "description": "Shipment item model",
  "type": "object",
  "properties": {
    "product_id": {
      "type": "string"
    },
    "product_name": {
      "type": "string",
      "readOnly": true
    },
    "variant_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "variant_name": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "product_image_url": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "sku": {
      "type": "string",
      "readOnly": true
    },
    "quantity": {
      "type": "integer"
    },
    "free_quantity": {
      "type": "integer"
    },
    "is_free_item": {
      "type": "boolean",
      "readOnly": true
    }
  },
  "required": [
    "product_id",
    "variant_id",
    "quantity"
  ],
  "title": "ShipmentItem",
  "x-tags": [
    "Orders"
  ]
}

---

Auto-generated from OpenAPI spec and TypeScript definitions