---
title: "List Merchants"
method: GET
path: "/v1/wms/merchant/list"
tags: ["Warehouse API"]
---

# List Merchants

`GET /v1/wms/merchant/list`

## Request

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

This will return all merchants belonging to the WMS account. 

### Response Fields
The response is a numerically indexed array with each element containing the following keys.

|     Field      |     Data Type         |     Length      |     Description         |
|-------------------|-----------------------|-----------------|----------------------------------|
|    merchant_pk    |    Int    |        |   CartRover merchant ID    |
|    name    |    String    |        |    Merchant Name    |
|    discontinued_sw    |    String    |        |    Y or N. Y for disabled.    |

## 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)