Asteril CRM

AsterilCRM API v4: довідник методів

GET /api/v4/credentials — Права поточного ключа

Повертає список scope, доступних ключу. Доступний будь-якому валідному ключу.

GET /api/v4/orders/history — Історія змін замовлень

Журнал змін полів замовлень, відсортований за `id` за зростанням.

Рекомендований цикл читання: перший запит без фільтрів або з `filter[sinceId]`, збереженим раніше;
обробити отримані записи; зберегти `id` останнього; якщо `pagination.totalPageCount` більше 1,
одразу зробити наступний запит з новим `filter[sinceId]`. Періодичність опитування 5–15 хвилин.

Потрібен scope `orders.history`.

  • filter[sinceId] — Лише записи з `id` більшим за вказаний. Не поєднується з `page`.
  • filter[orderId] — Ідентифікатор замовлення
  • filter[systemName][] — Системні імена змінених полів, наприклад `status`, `responsible_id`. Набір залежить від CRM, зокрема від її власних полів.
  • filter[startDate] — Зміни не раніше вказаного моменту, `YYYY-MM-DD HH:MM:SS`
  • filter[endDate] — Зміни не пізніше вказаного моменту, `YYYY-MM-DD HH:MM:SS`
  • limit — Кількість записів на сторінку
  • page — Номер сторінки, від 1
  • timezone — Часова зона для дат у фільтрах і відповіді

GET /api/v4/products/reservations — Резерви товарів

Резерви товарів у замовленнях: один запис на позицію замовлення і склад, як на сторінці Товари → Резерви.
Відсортовано за позицією замовлення і складом.

Метод працює, коли в CRM увімкнено звичайні склади; при Складі AsterilCRM — 400 `Warehouse mode is not enabled`
(для нього є `GET /api/v4/warehouse/reservations`).

Потрібен scope `products.reservations`.

  • filter[name] — Частина назви товару
  • filter[vendorCode] — Частина артикулу
  • filter[warehouseId] — Склад резерву
  • filter[orderId] — Ідентифікатор замовлення
  • filter[needMove] — 1 — склад резерву відрізняється від складу відвантаження замовлення (товар треба перемістити), 0 — не відрізняється або склад відвантаження не вказано
  • filter[shipped] — 1 — замовлення відвантажене, 0 — ні
  • limit — Кількість записів на сторінку
  • page — Номер сторінки, від 1

GET /api/v4/warehouse/reservations — Резерви Складу AsterilCRM

Зарезервовані товари невідвантажених замовлень, згруповані за артикулом, складом резерву і складом відвантаження,
як на сторінці Склад AsterilCRM → Резерви. Відсортовано за артикулом, складом резерву і складом відвантаження.

Метод працює, коли в CRM увімкнено Склад AsterilCRM; при звичайних складах — 400 `Warehouse mode is not enabled`
(для них є `GET /api/v4/products/reservations`).

Потрібен scope `warehouse.reservations`.

  • filter[vendorCode] — Частина артикулу
  • filter[warehouseIds][] — Склади резерву
  • filter[shipmentWarehouseIds][] — Склади відвантаження замовлень
  • limit — Кількість записів на сторінку
  • page — Номер сторінки, від 1

GET /api/v4/novaposhta/accounts — Акаунти Нової пошти

Усі акаунти модуля «Нова пошта», включно з вимкненими, з ключем `id`.
`id` — значення поля доставки `account` у замовленні. Ключі та токени перевізника не повертаються.

Потрібен scope `novaposhta.accounts`.

GET /api/v4/new_post/accounts — Акаунти Нової пошти (новий модуль)

Усі акаунти модуля «Нова пошта (новий модуль)», включно з вимкненими, з ключем `id`.
`id` — значення поля доставки `account` у замовленні. Ключі та токени перевізника не повертаються.

Потрібен scope `new_post.accounts`.

GET /api/v4/ukrposhta/accounts — Акаунти Укрпошти

Усі акаунти модуля «Укрпошта», включно з вимкненими, з ключем `id`.
`id` — значення поля доставки `account` у замовленні. Ключі та токени перевізника не повертаються.

Потрібен scope `ukrposhta.accounts`.