Retrieve List of Warehouses

Returns all enabled warehouses for the account associated with your API key. Warehouse IDs and identifiers are required across various endpoints and can be included in query parameters to filter results.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 1000
Defaults to 1

1-based page number to return. Defaults to 1.

integer
1 to 1000
Defaults to 50

Number of results per page. Defaults to a server-configured value; check the response metadata for the effective size.

Warehouse List Sort Enum | null
Defaults to null

Field to sort warehouses by (e.g., id, name, identifier). See the schema for allowed values.

Ordering | null
Defaults to null

Sort direction: ASC (ascending) or DESC (descending).

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json