List warehouses.

get

https://api.getbyrd.com/v2/warehouse/warehouses

Returns the warehouses your account is linked to: the warehouses
your stock can be stored in and your shipments sent from. See
Listing warehouses.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ids

array of uuids

Only return the warehouses with these IDs (comma-separated UUIDs).

ids

sort_by

string

enum

Field to sort the warehouses by; only name is supported.

Allowed:

order

string

enum

Sort direction for sort_by: asc (default) or desc.

Allowed:

carrier_name

string

Only return the warehouses that ship with this carrier, given as a carrier identifier such as dhl_de.

per_page

integer

≥ 1

Defaults to 250

Number of results per page

page

integer

≥ 0

Defaults to 0

Result page to jump to, 0-indexed

string

The search term

fields

array of strings

Model fields to search through; comma separated

fields

Headers

string

enum

Defaults to application/vnd.byrd.customer+json

Generated from available response content types

Allowed:

Responses

200Success response to a valid request

400Generic error response

403Generic error response