Skip to content

WarehouseDetail ​

Type: schema

TypeScript Definition ​

typescript
WarehouseDetail: {components["schemas"]["Warehouse"] & {
            /** @description Relevant for marketplace type stores only. `null` for b2b and b2c type stores. */
            seller_id?: $Read<string | null>
}

Component References ​

ReferenceResolves To
components["schemas"]["Warehouse"]Warehouse

OpenAPI Schema ​

json
{
  "title": "WarehouseDetail",
  "allOf": [
    {
      "$ref": "#/components/schemas/Warehouse"
    },
    {
      "type": "object",
      "properties": {
        "seller_id": {
          "description": "Relevant for marketplace type stores only. `null` for b2b and b2c type stores.",
          "type": [
            "string",
            "null"
          ],
          "readOnly": true
        },
        "service_provider_id": {
          "description": "Shipping service providers linked to this warehouse.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "channel_id": {
          "description": "Sales channels this warehouse is scoped to. Write-only; read the resolved channels from the warehouse's `channels`.",
          "type": "array",
          "items": {
            "type": "string"
          },
          "writeOnly": true
        },
        "marketplace_listing": {
          "description": "Marketplaces this warehouse is listed on.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "marketplace_id": {
                "type": "string"
              }
            }
          },
          "readOnly": true
        },
        "shipping_boxes": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/StoreShippingBox"
          },
          "readOnly": true
        },
        "shipping_providers": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ShippingOption"
          },
          "readOnly": true
        },
        "manual_methods": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/WarehouseManualMethod"
          },
          "readOnly": true
        },
        "available_shipping_options": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/WarehouseShippingOption"
          },
          "readOnly": true
        }
      }
    }
  ],
  "x-tags": [
    "Store"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: