Warehouses

Endpoint for retrieving the warehouses linked to your account. Use this to get warehouse IDs needed for the X-Warehouse-Id header on other endpoints.

GET/api/v1/warehouses

List warehouses

Retrieve a list of all warehouses available to your account. This endpoint does not require the X-Warehouse-Id header.

No query parameters are required.

Request

GET

/api/v1/warehouses

curl https://api.example.com/api/v1/warehouses \
  -H "Authorization: ApiKey {your-api-key}"

Response

{
  "status": "success",
  "message": "Fetched warehouses.",
  "data": {
    "warehouses": [
      {
        "id": 1,
        "name": "Miami Warehouse",
        "code": "MIA",
        "inbound_creation_enabled": true,
        "effective_is_default": true,
        "check_in_location_mode": "free_text",
        "address": {
          "address_line_1": "123 Main St",
          "address_line_2": null,
          "city": "Miami",
          "state": "FL",
          "zip": "33101",
          "country_code": "US"
        }
      }
    ]
  }
}

Response fields

Name
id
Type
integer
Description
The warehouse ID. Use this as the X-Warehouse-Id header value on other API endpoints.
Name
name
Type
string
Description
Display name of the warehouse.
Name
code
Type
string
Description
Short code identifier for the warehouse.
Name
inbound_creation_enabled
Type
boolean
Description
Whether inbound order creation is enabled for this warehouse.
Name
effective_is_default
Type
boolean
Description
Whether this is the default warehouse for your account.
Name
check_in_location_mode
Type
string
Description
How locations are assigned during check-in: free_text or warehouse_map.
Name
address
Type
object
Description
The warehouse address with address_line_1, address_line_2, city, state, zip, and country_code.