List Locations

get

https://api.warehance.com/v1/locations

Required permissions: read_locations, read_warehouses

Get a list of locations for your organization or client.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

sort_by

string

enum

Specifies the field by which to sort the returned warehouses:

created_at: Sort by the creation date of the warehouse.
name: Sort by the name of the warehouse.

Allowed:

warehouse_id

integer

≥ 1

Filter locations by warehouse ID.

limit

integer

1 to 100

Defaults to 25

The maximum number of items to return in the response. Used for pagination. Must be between 1 and 100.

offset

integer

≥ 0

Defaults to 0

The number of items to skip before starting to return results. Used for offset-based pagination. Cannot be used together with the cursor parameter.

cursor

string

A cursor for pagination. Use the next_cursor value from a previous response to fetch the next page of results. This provides more efficient pagination than offset-based pagination, especially for large datasets. Cannot be used together with the offset parameter.

order_by

string

enum

Defaults to asc

Specifies the sort direction of the returned items:

asc: Ascending order. For dates, this means from oldest to newest. For numbers, this means from smallest to largest.
desc: Descending order. For dates, this means from newest to oldest. For numbers, this means from largest to smallest.

Allowed:

search_value

string

A value to search for within the items. The specific fields searched depend on the endpoint.

Responses

200A list of locations

400Example Error Response