OrderShipmentDetail
Type: schema
TypeScript Definition
typescript
OrderShipmentDetail: {{
order_number: string;
/** Format: date-time */
order_date: string;
order_status: components["schemas"]["OrderStatus"];
sales_channel: {
id: string;
name: string;
type: string;
};
payment_status: components["schemas"]["PaymentStatus"];
customer_name: string;
customer_id?: string;
/** @description Type of the sales channel, repeated flat alongside `sales_channel`. */
sales_channel_type?: string;
/** Format: double */
sub_total?: number;
/** Format: double */
total_tax?: number;
/** Format: double */
shipping_amount?: number;
/** Format: double */
grand_total?: number;
coupon_code?: string | null;
/** Format: double */
coupon_discount_amount?: number;
/** Format: double */
coupon_discount_percent?: number | null;
shipments: components["schemas"]["Shipment"][];
allowed_actions: components["schemas"]["InventoryAction"][];
};
/** @enum {unknown} */
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["OrderStatus"] | OrderStatus |
components["schemas"]["PaymentStatus"] | PaymentStatus |
components["schemas"]["Shipment"] | Shipment |
components["schemas"]["InventoryAction"] | InventoryAction |
OpenAPI Schema
json
{
"type": "object",
"properties": {
"order_number": {
"type": "string"
},
"order_date": {
"type": "string",
"format": "date-time"
},
"order_status": {
"$ref": "#/components/schemas/OrderStatus"
},
"sales_channel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"name",
"type"
]
},
"payment_status": {
"$ref": "#/components/schemas/PaymentStatus"
},
"customer_name": {
"type": "string"
},
"customer_id": {
"type": "string"
},
"sales_channel_type": {
"description": "Type of the sales channel, repeated flat alongside `sales_channel`.",
"type": "string"
},
"sub_total": {
"type": "number",
"format": "double"
},
"total_tax": {
"type": "number",
"format": "double"
},
"shipping_amount": {
"type": "number",
"format": "double"
},
"grand_total": {
"type": "number",
"format": "double"
},
"coupon_code": {
"type": [
"string",
"null"
]
},
"coupon_discount_amount": {
"type": "number",
"format": "double"
},
"coupon_discount_percent": {
"type": [
"number",
"null"
],
"format": "double"
},
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Shipment"
}
},
"allowed_actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryAction"
}
}
},
"required": [
"order_number",
"order_date",
"order_status",
"sales_channel",
"payment_status",
"customer_name",
"shipments",
"allowed_actions"
],
"title": "OrderShipmentDetail"
}Auto-generated from OpenAPI spec and TypeScript definitions