Skip to content

Shipment ​

Type: schema

Description ​

Shipment on an order. Shape depends on store type: ShipmentStandard for B2B/B2C, ShipmentMarketplace when marketplace fields are present.

TypeScript Definition ​

typescript
Shipment: components["schemas"]["ShipmentStandard"] | components["schemas"]["ShipmentMarketplace"]

Component References ​

ReferenceResolves To
components["schemas"]["ShipmentStandard"]ShipmentStandard
components["schemas"]["ShipmentMarketplace"]ShipmentMarketplace

OpenAPI Schema ​

json
{
  "description": "Shipment on an order. Shape depends on store type: `ShipmentStandard` for B2B/B2C, `ShipmentMarketplace` when marketplace fields are present.",
  "oneOf": [
    {
      "$ref": "#/components/schemas/ShipmentStandard"
    },
    {
      "$ref": "#/components/schemas/ShipmentMarketplace"
    }
  ],
  "title": "Shipment",
  "x-tags": [
    "Shipping"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: