Get a warehouse

GET

api

{team_slug}

{app_slug}

warehouses

{warehouse_slug}

Error

A valid request URL is required to generate request examples

{
  "data": {
    "address": {
      "country": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "state": "<string>",
      "street_address": "<string>"
    },
    "app_id": "<string>",
    "available_online": true,
    "created_at": "<string>",
    "id": "<string>",
    "markets": [
      {
        "active": true,
        "country_codes": [
          "<string>"
        ],
        "created_at": "<string>",
        "currency_code": "<string>",
        "id": "<string>",
        "locale": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "updated_at": "<string>"
      }
    ],
    "name": "<string>",
    "slug": "<string>",
    "updated_at": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

Authorizations

Authorization

string

header

required

Management API token, sent as Authorization: Bearer <token>.

Path Parameters

warehouse_slug

string

required

Warehouse slug

app_slug

string

required

App slug

team_slug

string

required

Team slug

Response

Warehouse data

data

object

Show child attributes

details

string[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

success

boolean

Error

A valid request URL is required to generate request examples

{
  "data": {
    "address": {
      "country": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "state": "<string>",
      "street_address": "<string>"
    },
    "app_id": "<string>",
    "available_online": true,
    "created_at": "<string>",
    "id": "<string>",
    "markets": [
      {
        "active": true,
        "country_codes": [
          "<string>"
        ],
        "created_at": "<string>",
        "currency_code": "<string>",
        "id": "<string>",
        "locale": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "updated_at": "<string>"
      }
    ],
    "name": "<string>",
    "slug": "<string>",
    "updated_at": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "message": "<string>",
  "success": true
}

Management API

Shopper API

Customers API

Digital Assets Management API

Authorizations

Path Parameters

Response