ShipmentStandard
Type: schema
Description
Shipment payload for B2B/B2C stores without marketplace-only fields.
TypeScript Definition
typescript
ShipmentStandard: {components["schemas"]["ShipmentInfo"] & {
shipment_items?: (components["schemas"]["ShipmentItemStandard"] | (components["schemas"]["ShipmentItemStandard"] & {
is_free_item: $Read<boolean>
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["ShipmentInfo"] | ShipmentInfo |
components["schemas"]["ShipmentItemStandard"] | ShipmentItemStandard |
OpenAPI Schema
json
{
"description": "Shipment payload for B2B/B2C stores without marketplace-only fields.",
"allOf": [
{
"$ref": "#/components/schemas/ShipmentInfo"
},
{
"type": "object",
"properties": {
"shipment_items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ShipmentItemStandard"
},
{
"allOf": [
{
"$ref": "#/components/schemas/ShipmentItemStandard"
},
{
"type": "object",
"properties": {
"is_free_item": {
"type": "boolean",
"readOnly": true
},
"selling_price_excluding_tax": {
"type": "number",
"format": "double",
"readOnly": true
}
},
"required": [
"is_free_item"
]
}
]
}
]
}
}
}
},
{
"$ref": "#/components/schemas/ShipmentPackingAndProgression"
}
],
"title": "ShipmentStandard",
"x-tags": [
"Shipping"
]
}Auto-generated from OpenAPI spec and TypeScript definitions