OrderList

Type: schema

Description

order list model

TypeScript Definition

OrderList: {{
            /** @description Order id. Same as order number. */
            id: string;
            /** @description Unique number associated with the order. */
            order_number: string;
            /**
             * Format: date-time
             * @description Date and time when the order was placed.
             */
            order_date: string;
            status: components["schemas"]["OrderStatus"];
            payment_status: components["schemas"]["PaymentStatus"];
            /** @description Date and time when the payment for the order was successfully processed. */
            payment_success_date: string | null;
            /** @enum {unknown} */
            fulfillment_type: "collect-in-store" | "delivery";
            /** @description Indicates whether the order includes subscription items. */
            on_subscription: boolean;
            /**
             * Format: double
             * @description Total amount for the order, including all items, taxes, and discounts.
             */
            grand_total: number;
            /**
             * Format: double
             * @description Number of loyalty points redeemed in the order.
             */
            loyalty_point_redeemed: number;
            /**
             * Format: double
             * @description Amount of credit balance used in the order.
             */
            credit_balance_used: number;
            /**
             * Format: double
             * @description Amount remaining to be paid for the order.
             */
            to_be_paid: number;
            /** @description Total count of items included in the order. */
            order_items_count: number;
            order_items: components["schemas"]["OrderItem"][];
            customer_id: string;
            customer_note: string | null;
            billing_address: components["schemas"]["CustomerAddress"];
            shipping_address: components["schemas"]["CustomerAddress"];
            /** Format: double */
            loyalty_point_earned: number;
            coupon_code: string | null;
            currency: {
                name: string;
                code: string;
                symbol: string;
            };
            sales_channel?: {
                id: string;
                name: string;
                type: string;
            };
            metadata?: {
                [key: string]: string;
            };
            /** Format: date-time */
            created_at: string;
            /** Format: date-time */
            modified_at: string;
        };
        /**
         * OrderPayment
         * @description Order Payment
         */
}

Component References

Reference	Resolves To
components["schemas"]["OrderStatus"]	OrderStatus
components["schemas"]["PaymentStatus"]	PaymentStatus
components["schemas"]["OrderItem"]	OrderItem
components["schemas"]["CustomerAddress"]	CustomerAddress

OpenAPI Schema

{
  "description": "order list model",
  "type": "object",
  "properties": {
    "id": {
      "description": "Order id. Same as order number.",
      "type": "string"
    },
    "order_number": {
      "description": "Unique number associated with the order.",
      "type": "string"
    },
    "order_date": {
      "description": "Date and time when the order was placed.",
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "$ref": "#/components/schemas/OrderStatus"
    },
    "payment_status": {
      "$ref": "#/components/schemas/PaymentStatus"
    },
    "payment_success_date": {
      "description": "Date and time when the payment for the order was successfully processed.",
      "type": [
        "string",
        "null"
      ]
    },
    "fulfillment_type": {
      "enum": [
        "collect-in-store",
        "delivery"
      ]
    },
    "on_subscription": {
      "description": "Indicates whether the order includes subscription items.",
      "type": "boolean"
    },
    "grand_total": {
      "description": "Total amount for the order, including all items, taxes, and discounts.",
      "type": "number",
      "format": "double"
    },
    "loyalty_point_redeemed": {
      "description": "Number of loyalty points redeemed in the order.",
      "type": "number",
      "format": "double"
    },
    "credit_balance_used": {
      "description": "Amount of credit balance used in the order.",
      "type": "number",
      "format": "double"
    },
    "to_be_paid": {
      "description": "Amount remaining to be paid for the order.",
      "type": "number",
      "format": "double"
    },
    "order_items_count": {
      "description": "Total count of items included in the order.",
      "type": "integer"
    },
    "order_items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrderItem"
      }
    },
    "customer_id": {
      "type": "string"
    },
    "customer_note": {
      "type": [
        "string",
        "null"
      ]
    },
    "billing_address": {
      "$ref": "#/components/schemas/CustomerAddress"
    },
    "shipping_address": {
      "$ref": "#/components/schemas/CustomerAddress"
    },
    "loyalty_point_earned": {
      "type": "number",
      "format": "double"
    },
    "coupon_code": {
      "type": [
        "string",
        "null"
      ]
    },
    "currency": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "code": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      },
      "required": [
        "name",
        "code",
        "symbol"
      ]
    },
    "sales_channel": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "type"
      ]
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "id",
    "order_number",
    "order_date",
    "status",
    "payment_status",
    "payment_success_date",
    "fulfillment_type",
    "on_subscription",
    "grand_total",
    "loyalty_point_redeemed",
    "credit_balance_used",
    "to_be_paid",
    "order_items_count",
    "order_items",
    "customer_id",
    "customer_note",
    "billing_address",
    "shipping_address",
    "loyalty_point_earned",
    "coupon_code",
    "currency",
    "created_at",
    "modified_at"
  ],
  "title": "OrderList",
  "x-tags": [
    "Orders"
  ]
}

---

Auto-generated from OpenAPI spec and TypeScript definitions