Skip to content

OrderItem

Type: schema

TypeScript Definition

typescript
OrderItem: {{
            readonly product_id?: string;
            readonly product_name?: string;
            readonly product_image_url?: string | null;
            sku: string;
            readonly on_offer?: boolean;
            readonly on_promotion?: boolean;
            on_subscription?: boolean;
            subscription_plan?: string | null;
            readonly subscription_interval?: number | null;
            readonly subscription_frequency?: string | null;
            quantity: number;
            readonly free_quantity?: number;
            readonly is_free_item?: boolean;
            /** Format: double */
            readonly selling_price?: number;
            /** Format: double */
            readonly listing_price?: number;
            /** Format: double */
            readonly promotion_discount_amount?: number;
            /** Format: double */
            readonly coupon_discount_amount?: number;
            /** @enum {unknown} */
            readonly tax_type?: "GST";
            /** Format: float */
            readonly tax_rate?: number;
            /** Format: double */
            readonly tax_amount?: number;
            /** Format: double */
            readonly shipping_additional_cost?: number;
        };
        /**
         * OrderList
         * @description order list model
         */
}

OpenAPI Schema

json
{
  "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
    },
    "shipping_additional_cost": {
      "type": "number",
      "format": "double",
      "readOnly": true
    }
  },
  "required": [
    "sku",
    "quantity"
  ],
  "title": "OrderItem",
  "x-tags": [
    "Orders"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: