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;
            /**
             * @description Current status of the order (e.g., "pending," "processing," "shipped," etc.).
             * @enum {string}
             */
            status?: "draft" | "awaiting_approval" | "cancelled" | "shipped" | "delivered" | "awaiting_shipment" | "pending" | "payment_failed" | "schedule_requested";
            /**
             * @description Current payment status of the order (e.g., "pending," "success," "failed").
             * @enum {string}
             */
            payment_status?: "pending" | "success" | "failed" | "partially_paid" | "refunded";
            /** @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;
            /** @description Number of loyalty points redeemed in the order. */
            loyalty_point_redeemed?: number;
            /** @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"];
            loyalty_point_earned?: number;
            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"]["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": {
      "description": "Current status of the order (e.g., \"pending,\" \"processing,\" \"shipped,\" etc.).",
      "type": "string",
      "enum": [
        "draft",
        "awaiting_approval",
        "cancelled",
        "shipped",
        "delivered",
        "awaiting_shipment",
        "pending",
        "payment_failed",
        "schedule_requested"
      ]
    },
    "payment_status": {
      "description": "Current payment status of the order (e.g., \"pending,\" \"success,\" \"failed\").",
      "type": "string",
      "enum": [
        "pending",
        "success",
        "failed",
        "partially_paid",
        "refunded"
      ]
    },
    "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": "integer"
    },
    "credit_balance_used": {
      "description": "Amount of credit balance used in the order.",
      "type": "integer"
    },
    "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": "integer"
    },
    "currency": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "code": {
          "type": "string"
        },
        "symbol": {
          "type": "string"
        }
      }
    },
    "sales_channel": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      }
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "title": "OrderList",
  "x-tags": [
    "Orders"
  ]
}

---

Auto-generated from OpenAPI spec and TypeScript definitions