OrderList
Type: schema
Description
order list model
TypeScript Definition
typescript
OrderList: {{
/** @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" | "confirmed" | "partially_scheduled" | "awaiting_shipment" | "shipped" | "partially_shipped" | "undelivered" | "partially_undelivered" | "return_to_origin" | "partially_return_to_origin" | "complete" | "partially_delivered" | "cancelled";
/**
* @description Current payment status of the order (e.g., "pending," "success," "failed").
* @enum {string}
*/
payment_status?: "pending" | "success" | "failed" | "partially_paid";
/**
* Format: date-time
* @description Date and time when the payment for the order was successfully processed.
*/
payment_success_date?: string;
/** @description Indicates whether the order has a refund associated with it or not. */
has_refund?: boolean;
/** @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_note?: string | null;
loyalty_point_earned?: number;
currency?: {
name?: string;
code?: string;
symbol?: string;
};
/** @description Order identifier (same value as `order_number`). */
id?: string;
/** @description ULID of the cart the order was created from. `null` if unavailable. */
cart_id?: string | null;
/** @description Whether the order is in an active (non-terminal) state. */
active?: boolean;
/** @description Fulfillment type for the order (e.g. `delivery`, `collect-in-store`). */
fulfillment_type?: string;
/** @description Type of the sales channel the order belongs to. */
sales_channel_type?: string;
/** Format: date-time */
created_at?: string;
/** Format: date-time */
modified_at?: string;
};
/**
* OrderPayment
* @description A payment of the order, or a refund of one (`transaction_type`). Every payment has the common fields; the method's own fields depend on `payment_method`: a card's `card_number` and `card_type`, netbanking's `bank_name`, UPI's `upi_id`, a wallet's `wallet_name`, a bank transfer's (`IMPS`, `NEFT`, `RTGS`) `bank_account_number` and `bank_name`. A payment whose method isn't known yet (`payment_method` empty or `null`) or has no fields of its own (e.g. `NACH`, cash, loyalty points) has only the common fields.
*/
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["OrderItem"] | OrderItem |
OpenAPI Schema
json
{
"title": "OrderList",
"description": "order list model",
"type": "object",
"externalDocs": {
"url": "https://llm-docs.commercengine.io/storefront/schemas/OrderList",
"description": "API reference for the OrderList schema"
},
"properties": {
"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",
"confirmed",
"partially_scheduled",
"awaiting_shipment",
"shipped",
"partially_shipped",
"undelivered",
"partially_undelivered",
"return_to_origin",
"partially_return_to_origin",
"complete",
"partially_delivered",
"cancelled"
]
},
"payment_status": {
"description": "Current payment status of the order (e.g., \"pending,\" \"success,\" \"failed\").",
"type": "string",
"enum": [
"pending",
"success",
"failed",
"partially_paid"
]
},
"payment_success_date": {
"description": "Date and time when the payment for the order was successfully processed.",
"type": "string",
"format": "date-time"
},
"has_refund": {
"description": "Indicates whether the order has a refund associated with it or not.",
"type": "boolean"
},
"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_note": {
"type": [
"string",
"null"
]
},
"loyalty_point_earned": {
"type": "integer"
},
"currency": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"symbol": {
"type": "string"
}
}
},
"id": {
"description": "Order identifier (same value as `order_number`).",
"type": "string"
},
"cart_id": {
"description": "ULID of the cart the order was created from. `null` if unavailable.",
"type": [
"string",
"null"
]
},
"active": {
"description": "Whether the order is in an active (non-terminal) state.",
"type": "boolean"
},
"fulfillment_type": {
"description": "Fulfillment type for the order (e.g. `delivery`, `collect-in-store`).",
"type": "string"
},
"sales_channel_type": {
"description": "Type of the sales channel the order belongs to.",
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"modified_at": {
"type": "string",
"format": "date-time"
}
}
}Auto-generated from OpenAPI spec and TypeScript definitions