AdminOrder
Type: schema
TypeScript Definition
typescript
AdminOrder: {{
/** @description Same value as `order_number`. */
id?: $Read<string>;
order_number?: string;
/** @description Identifier of the cart the order was created from. */
cart_id?: $Read<string>;
/** Format: date-time */
order_date?: string;
status?: components["schemas"]["OrderStatus"];
payment_status?: components["schemas"]["PaymentStatus"];
/** @description Indicates whether the order was synced from Marketplace. */
marketplace_synced?: boolean;
/** Format: date-time */
payment_success_date?: string | null;
customer_id?: string;
customer_email?: string | null;
customer_phone?: string | null;
customer_note?: string | null;
is_promotion_applied?: boolean;
promotion_discount_amount?: number | null;
/** Format: double */
promotion_discount_percent?: $Read<number | null>;
is_coupon_applied?: boolean;
coupon_code?: string | null;
coupon_id?: $Read<string | null>;
/** Format: double */
coupon_discount_amount?: number | null;
/** Format: double */
coupon_discount_percent?: $Read<number | null>;
on_subscription?: boolean;
fulfillment_preference?: components["schemas"]["AdminFulfillmentPreference"];
sales_channel?: {
id: string;
name: string;
type: string;
};
metadata?: {
[key: string]: string | null;
} | null;
/** Format: double */
subtotal?: number;
/** Format: double */
subtotal_tax?: number;
/** Format: double */
subtotal_including_tax?: number;
/** Format: double */
shipping_amount?: number;
/** Format: double */
shipping_tax_rate?: number;
/** Format: double */
shipping_total_tax?: number;
/** Format: double */
shipping_amount_including_tax?: number;
/** Format: double */
total_tax?: number;
/** Format: double */
grand_total?: number;
loyalty_point_redeemed?: number;
credit_balance_used?: number;
/** Format: double */
to_be_paid?: number;
loyalty_point_earned?: number;
order_items_count?: number;
currency?: {
name?: string;
code?: string;
symbol?: string;
};
feedback?: string | null;
allowed_actions?: components["schemas"]["OrderAction"][];
applied_coupons?: components["schemas"]["AdminAppliedCoupon"][];
applied_promotions?: components["schemas"]["AdminAppliedPromotion"][];
/** Format: date-time */
created_at?: string;
/** Format: date-time */
modified_at?: string;
};
/**
* OrderAddress
* @description Address snapshot captured at checkout for an order or invoice.
*/
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["OrderStatus"] | OrderStatus |
components["schemas"]["PaymentStatus"] | PaymentStatus |
components["schemas"]["AdminFulfillmentPreference"] | AdminFulfillmentPreference |
components["schemas"]["OrderAction"] | OrderAction |
components["schemas"]["AdminAppliedCoupon"] | AdminAppliedCoupon |
components["schemas"]["AdminAppliedPromotion"] | AdminAppliedPromotion |
OpenAPI Schema
json
{
"type": "object",
"properties": {
"id": {
"description": "Same value as `order_number`.",
"type": "string",
"readOnly": true
},
"order_number": {
"type": "string"
},
"cart_id": {
"description": "Identifier of the cart the order was created from.",
"type": "string",
"readOnly": true
},
"order_date": {
"type": "string",
"format": "date-time"
},
"status": {
"$ref": "#/components/schemas/OrderStatus"
},
"payment_status": {
"$ref": "#/components/schemas/PaymentStatus"
},
"marketplace_synced": {
"description": "Indicates whether the order was synced from Marketplace.",
"type": "boolean"
},
"payment_success_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"customer_id": {
"type": "string"
},
"customer_email": {
"type": [
"string",
"null"
]
},
"customer_phone": {
"type": [
"string",
"null"
]
},
"customer_note": {
"type": [
"string",
"null"
]
},
"is_promotion_applied": {
"type": "boolean"
},
"promotion_discount_amount": {
"type": [
"integer",
"null"
]
},
"promotion_discount_percent": {
"type": [
"number",
"null"
],
"format": "double",
"readOnly": true
},
"is_coupon_applied": {
"type": "boolean"
},
"coupon_code": {
"type": [
"string",
"null"
]
},
"coupon_id": {
"type": [
"string",
"null"
],
"readOnly": true
},
"coupon_discount_amount": {
"type": [
"number",
"null"
],
"format": "double"
},
"coupon_discount_percent": {
"type": [
"number",
"null"
],
"format": "double",
"readOnly": true
},
"on_subscription": {
"type": "boolean"
},
"fulfillment_preference": {
"$ref": "#/components/schemas/AdminFulfillmentPreference"
},
"sales_channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"name",
"type"
]
},
"metadata": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"subtotal": {
"type": "number",
"format": "double"
},
"subtotal_tax": {
"type": "number",
"format": "double"
},
"subtotal_including_tax": {
"type": "number",
"format": "double"
},
"shipping_amount": {
"type": "number",
"format": "double"
},
"shipping_tax_rate": {
"type": "number",
"format": "double"
},
"shipping_total_tax": {
"type": "number",
"format": "double"
},
"shipping_amount_including_tax": {
"type": "number",
"format": "double"
},
"total_tax": {
"type": "number",
"format": "double"
},
"grand_total": {
"type": "number",
"format": "double"
},
"loyalty_point_redeemed": {
"type": "integer"
},
"credit_balance_used": {
"type": "integer"
},
"to_be_paid": {
"type": "number",
"format": "double"
},
"loyalty_point_earned": {
"type": "integer"
},
"order_items_count": {
"type": "integer"
},
"currency": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"symbol": {
"type": "string"
}
}
},
"feedback": {
"type": [
"string",
"null"
]
},
"allowed_actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderAction"
}
},
"applied_coupons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdminAppliedCoupon"
}
},
"applied_promotions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdminAppliedPromotion"
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"modified_at": {
"type": "string",
"format": "date-time"
}
},
"title": "Order",
"x-tags": [
"Orders"
]
}Auto-generated from OpenAPI spec and TypeScript definitions