ShipmentList
Type: schema
TypeScript Definition
typescript
ShipmentList: {{
order_number?: string;
sales_channel?: {
id?: string | null;
name?: string | null;
type?: string | null;
};
reference_number?: string;
/** Format: double */
sub_total?: number;
/** Format: double */
sub_total_including_tax?: number;
/** Format: double */
grand_total?: number;
/** Format: double */
coupon_discount_amount?: number;
/** Format: double */
promotion_discount_amount?: number;
/** Format: double */
loyalty_point_redeemed?: number;
seller_id?: string | null;
marketplace_listing?: unknown[];
/** @description Per-box packing summary. Empty until packing is assigned. */
packing?: components["schemas"]["ShipmentBox"][];
} & components["schemas"]["ShipmentInfo"];
/**
* ShipmentMarketplace
* @description Shipment payload for marketplace stores, including seller and order amount breakdown fields.
*/
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["ShipmentBox"] | ShipmentBox |
components["schemas"]["ShipmentInfo"] | ShipmentInfo |
OpenAPI Schema
json
{
"allOf": [
{
"type": "object",
"properties": {
"order_number": {
"type": "string"
},
"sales_channel": {
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
}
}
},
"reference_number": {
"type": "string"
},
"sub_total": {
"type": "number",
"format": "double"
},
"sub_total_including_tax": {
"type": "number",
"format": "double"
},
"grand_total": {
"type": "number",
"format": "double"
},
"coupon_discount_amount": {
"type": "number",
"format": "double"
},
"promotion_discount_amount": {
"type": "number",
"format": "double"
},
"loyalty_point_redeemed": {
"type": "number",
"format": "double"
},
"seller_id": {
"type": [
"string",
"null"
]
},
"marketplace_listing": {
"type": "array"
},
"packing": {
"description": "Per-box packing summary. Empty until packing is assigned.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentBox"
}
}
}
},
{
"$ref": "#/components/schemas/ShipmentInfo"
}
],
"title": "ShipmentList",
"x-tags": [
"Shipping"
]
}Auto-generated from OpenAPI spec and TypeScript definitions