ShipmentDetail
Type: schema
TypeScript Definition
typescript
ShipmentDetail: {{
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 | null;
/** @description Business name on the billing address. `null` for B2C orders placed without business details. */
billing_business_name?: string | null;
shipment_detail: components["schemas"]["Shipment"];
allowed_actions: components["schemas"]["ShipmentAction"][];
customer_id?: string;
/** @description Type of the sales channel, repeated flat alongside `sales_channel`. */
sales_channel_type?: string;
/** @description The base shipment this replacement was created for. Present (non-null) only when this shipment is a replacement shipment. */
base_shipment?: components["schemas"]["RelatedShipmentSummary"] | null;
/** @description The replacement shipment created for this shipment. Present (non-null) only when this shipment has a replacement. */
replacement_shipment?: components["schemas"]["RelatedShipmentSummary"] | null;
};
/** ShipmentInfo */
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["OrderStatus"] | OrderStatus |
components["schemas"]["PaymentStatus"] | PaymentStatus |
components["schemas"]["Shipment"] | Shipment |
components["schemas"]["ShipmentAction"] | ShipmentAction |
components["schemas"]["RelatedShipmentSummary"] | RelatedShipmentSummary |
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",
"null"
]
},
"billing_business_name": {
"description": "Business name on the billing address. `null` for B2C orders placed without business details.",
"type": [
"string",
"null"
]
},
"shipment_detail": {
"$ref": "#/components/schemas/Shipment"
},
"allowed_actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentAction"
}
},
"customer_id": {
"type": "string"
},
"sales_channel_type": {
"description": "Type of the sales channel, repeated flat alongside `sales_channel`.",
"type": "string"
},
"base_shipment": {
"description": "The base shipment this replacement was created for. Present (non-null) only when this shipment is a replacement shipment.",
"oneOf": [
{
"$ref": "#/components/schemas/RelatedShipmentSummary"
},
{
"type": "null"
}
]
},
"replacement_shipment": {
"description": "The replacement shipment created for this shipment. Present (non-null) only when this shipment has a replacement.",
"oneOf": [
{
"$ref": "#/components/schemas/RelatedShipmentSummary"
},
{
"type": "null"
}
]
}
},
"required": [
"order_number",
"order_date",
"order_status",
"sales_channel",
"payment_status",
"shipment_detail",
"allowed_actions"
],
"title": "ShipmentDetail"
}Auto-generated from OpenAPI spec and TypeScript definitions