Warehouses: Bimp API methods
Bimp API methods for the “Warehouses” resource (/org2/warehouse/…): 1 method. Base URL: https://app.bimpsoft.com. All requests except login pass the company token in the access-token header — see Getting started with the API.
| Method | What it does |
|---|---|
POST /org2/warehouse/api-readList | A request to view a list of warehouses |
api-readList
POST /org2/warehouse/api-readList
A request to view a list of warehouses
Request body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
pagination | object | yes | |
pagination.offset | number | yes | Begin from {offset} elements |
pagination.count | number | yes | Limit of paginated elemets |
main | boolean | If specified, filters warehouses by main flag (true = only main, false = only non-main) |
Response: data field
| Field | Type | Description |
|---|---|---|
[].uuid | string (uuid) | |
[].name | string | |
[].main | boolean | Indicates whether this warehouse is marked as main |
curl -X POST 'https://app.bimpsoft.com/org2/warehouse/api-readList' \
-H 'access-token: <company token>' \
-H 'Content-Type: application/json' \
-d '{"pagination":{"offset":0,"count":10}}'Interactive documentation with a test request option: https://app.bimpsoft.com/docs. The OpenAPI specification is updated together with Bimp; this page is generated from it automatically.