Склади: методи API Bimp
Методи API Bimp для ресурсу «Склади» (/org2/warehouse/…): 1 метод. Базова адреса: https://app.bimpsoft.com. Усі запити, крім входу, передають токен компанії в заголовку access-token — див. Початок роботи з API.
| Метод | Що робить |
|---|---|
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
Тіло запиту (JSON)
| Поле | Тип | Обов’язкове | Опис |
|---|---|---|---|
pagination | object | так | |
pagination.offset | number | так | Begin from {offset} elements |
pagination.count | number | так | Limit of paginated elemets |
main | boolean | If specified, filters warehouses by main flag (true = only main, false = only non-main) |
Відповідь: поле data
| Поле | Тип | Опис |
|---|---|---|
[].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: <токен компанії>' \
-H 'Content-Type: application/json' \
-d '{"pagination":{"offset":0,"count":10}}'
Інтерактивна документація з можливістю надіслати тестовий запит: https://app.bimpsoft.com/docs. Специфікація OpenAPI оновлюється разом із Bimp; ця сторінка згенерована з неї автоматично.