---
title: "List Warehouses"
method: GET
path: "/v1/merchant/warehouse/list"
tags: ["Merchant API"]
---

# List Warehouses

`GET /v1/merchant/warehouse/list`

## Request

- Base URL: `http://{{base_url}}`
- URL: `http://{{base_url}}/v1/merchant/warehouse/list`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/extensiv/apis/integration-manager-api-formerly-cartrover/docs/v1/merchant/warehouse/list/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of all warehouses set up in CartRover. Any filters should be passed with the URL as GET arguments.

### Filters
|    Argument     |    Description       |
|------------------------|-------------------------------------------------------------------------------------|
|    include_disabled    |    Y or N. Default N   Also return warehouses listed as disabled   in CartRover?    |

### Array Response Fields
|    Field     |    Data Type     |    Length     |    Description       |
|---------------------------|------------------|---------------|---------------------------------------------------------------------------------------------------------------|
|    inventory_warehouse    |    String    |  |    Warehouse Name within CartRover    |
|    wms\_warehouse_name    |    String    |  |    Optional Warehouse Name provided by WMS    |
|    wms\_warehouse_id    |    String    |  |    Optional Warehouse ID provided by WMS    |
|    extra_params    |    Array    |  |    List of "addresses" and "contacts" for   this warehouse.    |
|    disabled    |    boolean    |  |    true if this warehouse is disabled. Disabled warehouses are   not used for inventory sync in CartRover.    |
|    is_default    |    boolean    |  |    true if this is the default warehouse.    |
|    restock_level    |    Int    |  |    Global requested restock level if inventory drops below   this level for any item    |

The key for each warehouse in the array is the internal CartRover warehouyse id. This is needed for modifying the warehouse fields via the API.

## Headers

- `Content-Type` string

## Response `200`

OK

- object

---

[API](https://skmtc.dev/extensiv/apis/integration-manager-api-formerly-cartrover.md) - [All operations](https://skmtc.dev/extensiv/apis/integration-manager-api-formerly-cartrover/llms.txt) - [OpenAPI document](https://skmtc.dev/extensiv/apis/integration-manager-api-formerly-cartrover/revisions/125e6deac675?raw)