Skip to main content
GET
/
api
/
warehouses
Get all warehouses
curl --request GET \
  --url https://api.example.com/api/warehouses \
  --header 'Authorization: <authorization>' \
  --header 'organization-id: <organization-id>'
[
  {
    "name": "Main Warehouse",
    "code": "WH-001",
    "city": "New York",
    "country": "United States",
    "address": "123 Warehouse Street, New York, NY 10001",
    "primary": true
  }
]

Headers

​
Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Response

200 - application/json

The warehouses have been successfully retrieved.

​
name
string
required

The name of the warehouse

Example:

"Main Warehouse"

​
code
string
required

The unique code identifier for the warehouse

Example:

"WH-001"

​
city
string
required

The city where the warehouse is located

Example:

"New York"

​
country
string
required

The country where the warehouse is located

Example:

"United States"

​
address
string
required

The full address of the warehouse

Example:

"123 Warehouse Street, New York, NY 10001"

​
primary
boolean
required

Indicates if this is the primary warehouse

Example:

true