Warehouses

List warehouses

Lists the account warehouses, paginated.

GET
/v1/warehouses

Returns the warehouses of every seller of the account, newest first, with pagination totals. Without a filter, you get the active and the archived ones.

Filter by sellerId and status (active or archived). To find a seller's default warehouse, filter by sellerId and look for isDefault: true:

curl "$BACKEND_URL/v1/warehouses?sellerId=$SELLER_ID&status=active" \
  -H "Authorization: Bearer mk_your_api_key"

The balance of each warehouse is not here. It is in Get variant balance.

Authorization

api_key
headerAuthorizationBearer <token>

API key (mk_...)

Query Parameters

page?integer

Page number, starting at 1. Defaults to 1. A page beyond pagination.totalPages is not an error: it returns empty data.

Range1 <= value <= 9007199254740991
Default1
pageSize?integer

Items per page, from 1 to 100. Defaults to 20.

Range1 <= value <= 100
Default20
sellerId?string

Only the warehouses of this seller.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
status?string

Only warehouses in this state. Omit it to list the active and the archived ones.

Value in"active""archived"

Response Body

A page of warehouses, newest first.

application/json
  1. response

One page of warehouses.

data*array<>

The warehouses of this page, newest first.

pagination*

Where this page sits in the whole listing: the totals and whether there are pages before and after it.

curl -X GET "https://example.com/v1/warehouses"
{  "data": [    {      "id": "e41c9a07-26b8-4d53-a0f1-8c3b7d5e9a12",      "sellerId": "3d1c8a52-7f0e-4b0a-8a65-9c1b2f6d7e01",      "name": "Overflow warehouse",      "externalId": "erp-wh-02",      "isDefault": false,      "status": "active",      "createdAt": "2026-10-11T09:30:00.000Z",      "updatedAt": "2026-10-11T09:30:00.000Z"    },    {      "id": "b7e2a1c4-5d3f-4e8a-9b6c-2f1d0a8e7c35",      "sellerId": "3d1c8a52-7f0e-4b0a-8a65-9c1b2f6d7e01",      "name": "Default",      "externalId": null,      "isDefault": true,      "status": "active",      "createdAt": "2026-10-10T12:00:00.000Z",      "updatedAt": "2026-10-10T12:00:00.000Z"    }  ],  "pagination": {    "page": 1,    "pageSize": 20,    "totalItems": 2,    "totalPages": 1,    "hasNext": false,    "hasPrev": false  }}