OrderItem

Type: schema

TypeScript Definition

OrderItem: {{
            product_id?: $Read<string>;
            product_name?: $Read<string>;
            product_image_url?: $Read<string | null>;
            sku: string;
            on_offer?: $Read<boolean>;
            on_promotion?: $Read<boolean>;
            on_subscription?: boolean;
            subscription_plan?: string | null;
            subscription_interval?: $Read<number | null>;
            subscription_frequency?: $Read<string | null>;
            quantity: number;
            free_quantity?: $Read<number>;
            is_free_item?: $Read<boolean>;
            /** Format: double */
            selling_price?: $Read<number>;
            /** Format: double */
            listing_price?: $Read<number>;
            /** Format: double */
            promotion_discount_amount?: $Read<number>;
            /** Format: double */
            coupon_discount_amount?: $Read<number>;
            /** @enum {unknown} */
            tax_type?: $Read<"GST">;
            /** Format: float */
            tax_rate?: $Read<number>;
            /** Format: double */
            tax_amount?: $Read<number>;
            /** Format: double */
            handling_charge_excluding_tax?: $Read<number>;
            /** Format: double */
            handling_charge_including_tax?: number;
            /** Format: double */
            handling_charge_tax_rate?: number;
            variant_id?: string | null;
            variant_name?: string | null;
        };
        /**
         * OrderList
         * @description order list model
         */
}

OpenAPI Schema

{
  "type": "object",
  "properties": {
    "product_id": {
      "type": "string",
      "readOnly": true
    },
    "product_name": {
      "type": "string",
      "readOnly": true
    },
    "product_image_url": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "sku": {
      "type": "string"
    },
    "on_offer": {
      "type": "boolean",
      "readOnly": true
    },
    "on_promotion": {
      "type": "boolean",
      "readOnly": true
    },
    "on_subscription": {
      "type": "boolean"
    },
    "subscription_plan": {
      "type": [
        "string",
        "null"
      ]
    },
    "subscription_interval": {
      "type": [
        "integer",
        "null"
      ],
      "readOnly": true
    },
    "subscription_frequency": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    },
    "quantity": {
      "type": "integer"
    },
    "free_quantity": {
      "type": "integer",
      "readOnly": true
    },
    "is_free_item": {
      "type": "boolean",
      "readOnly": true
    },
    "selling_price": {
      "type": "number",
      "format": "double",
      "readOnly": true
    },
    "listing_price": {
      "type": "number",
      "format": "double",
      "readOnly": true
    },
    "promotion_discount_amount": {
      "type": "number",
      "format": "double",
      "readOnly": true
    },
    "coupon_discount_amount": {
      "type": "number",
      "format": "double",
      "readOnly": true
    },
    "tax_type": {
      "enum": [
        "GST"
      ],
      "readOnly": true
    },
    "tax_rate": {
      "type": "number",
      "format": "float",
      "readOnly": true
    },
    "tax_amount": {
      "type": "number",
      "format": "double",
      "readOnly": true
    },
    "handling_charge_excluding_tax": {
      "type": "number",
      "format": "double",
      "readOnly": true
    },
    "handling_charge_including_tax": {
      "type": "number",
      "format": "double"
    },
    "handling_charge_tax_rate": {
      "type": "number",
      "format": "double"
    },
    "variant_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "variant_name": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "sku",
    "quantity"
  ],
  "title": "OrderItem",
  "x-tags": [
    "Orders"
  ]
}

---

Auto-generated from OpenAPI spec and TypeScript definitions