Skip to content

Warehouses

Operations related to warehouses

Operations

List warehouses

Request

Returns all warehouses available to the merchant.

See the Pagination section in the API overview above for details on how pagination works.

Security
BearerAuth
Query
limitinteger, [ 1 .. 100 ]

Number of items to return per page (for pagination)

Default:20
curl -i -X GET \
  'https://hive-merchant-api.redocly.app/_mock/merchant-api-v2/mapi_v2_oas31/warehouses?limit=20' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

A list of warehouses

Bodyapplication/json
dataArray of objects(Warehouse)
paginationobject(Pagination)
Response
{
  "data": [
    { … }
  ],
  "pagination": {
    "first_page_url": "https://app.hive.app/merchant_api/v2/collection_of_items?limit=20",
    "limit": 20,
    "next_page_url": "https://app.hive.app/merchant_api/v2/collection_of_items?limit=20&page=eyJpZCI6MTIzNDU2fQ"
  }
}