Sign in

v1

latestOpenAPI 3.0.32026-07-13149852.3 MB
warehouse

Warehouse - Get

Retrieve all warehouses for the current account.

get/warehouse/get

Query parameters

selectorobject required

Query selector object for filtering results

limitnumber

Max results to return

Example:50
skipnumber

Number of results to skip

sortobject

Sort fields object, e.g. { "name": 1 }

Response

Array of warehouses

_idstring required

Unique warehouse identifier

namestring required

Warehouse name

typestring required

Warehouse type

store_idstring

Associated store ID

is_defaultboolean

Whether this is the default warehouse

statesstring[]

State routing assignments

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "store_id": "507f1f77bcf86cd799439011"
  }
]