Master API
List Sub Accounts
Get a list of all Sub Accounts
Note: Any filters should be passed with the URL as GET arguments.
Filters
| Argument | Description |
|---|---|
| include_discontinued | N or Y. Default N. If Y, accounts that have been discontinued will be returned as well |
Response Fields
| Field | Data Type | Length | Description |
|---|---|---|---|
| warehouses | Array | List of Warehouse sub-accounts | |
| merchants | Array | List of Merchant sub-accounts |
warehouses Fields
warehouses is a numerically indexed array with each element containing the following keys.
| Field | Data Type | Length | Description |
|---|---|---|---|
| fclient_pk | Int | CartRover warehouse ID | |
| company | String | Warehouse Company Name | |
| discontinued_sw | String | Y or N. Y for disabled. |
merchants Fields
merchants is a numerically indexed array with each element containing the following keys.
| Field | Data Type | Length | Description |
|---|---|---|---|
| merchant_pk | Int | CartRover merchant ID | |
| company | String | Merchant Company Name | |
| discontinued_sw | String | Y or N. Y for disabled. |
get/v1/master/list_sub
Request
- Base URLhttp://{{base_url}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Response
OK
object required
Changes
No recorded changes to this operation across all 1 revision of this API.