Склади через API
Склади через API потрібні для інтеграцій, які працюють із залишками, документами, продажами, поставками або синхронізацією кількості по магазинах.
Повʼязані інструкції:
Endpoint-и
| Метод | Endpoint | Призначення |
|---|---|---|
| GET | /v1/stocks | отримати список складів |
| GET | /v1/stocks/:id | отримати один склад |
Створення, оновлення й видалення складів через API V1 не описані.
Поля складу
У відповіді API склад містить:
| Поле | Призначення |
|---|---|
id | ID складу. |
title | Назва складу або магазину. |
code | Код складу. |
active | Чи активний склад. |
filial_id | Філія або юридична особа, до якої належить склад. |
created_at | Дата створення. |
updated_at | Дата оновлення. |
Де використовується stock_id
stock_id або конкретні складські поля використовуються в різних ресурсах:
| Ресурс | Поле або параметр |
|---|---|
| Товари | stock_id разом з extended=true для розрахунку remains, reserve, waiting. |
| Документи | stock_from_id і stock_to_id. |
| Залишки | stock_id у /v1/reports/remains. |
| Резерви | stock_id у /v1/reports/reserves. |
| Очікування | stock_id у /v1/reports/waitings. |
stock_from_id і stock_to_id
У документах напрям складу залежить від типу документа:
stock_from_id- склад, з якого товар списується або резервується;stock_to_id- склад, на який товар надходить.
Наприклад:
- продаж використовує склад списання;
- надходження використовує склад оприбуткування;
- переміщення використовує обидва склади;
- замовлення покупця резервує товар зі складу;
- замовлення постачальнику формує очікування на склад.
Перед створенням документів через API інтеграція має точно визначити, який склад є джерелом, а який - отримувачем. Помилка в складі змінить облік не там, де очікує користувач.
Філії та склади
Поле filial_id показує, до якої філії або юридичної особи належить склад.
Це важливо, якщо компанія веде облік по кількох філіях або юридичних особах і зовнішня система має синхронізувати дані тільки певної частини бізнесу.
Чеклист
Перед використанням складів в інтеграції перевірте:
- які склади активні;
- які склади потрібно показувати зовнішній системі;
- чи потрібно фільтрувати склади за філією;
- який склад використовувати для продажів;
- який склад використовувати для поставок;
- як інтеграція обробляє переміщення між складами;
- чи потрібні залишки по кожному складу окремо або сумарно.
Підсумок
API складів дає довідник складів і магазинів. Самі складські кількості потрібно отримувати через Звіти через API, а документи мають передавати правильні stock_from_id і stock_to_id.