API вивантаження аналітики (замовлення з усіма деталями одним запитом)
1. Загальна інформація
API вивантаження аналітики (замовлення з усіма деталями одним запитом)
Є моживість завантажувати всі завершені замовлення через партнерський API. Один запит повертає все, що платформа знає про кожне замовлення, всередині самого замовлення: позиції, ціни та знижки, клієнта, оплату, кур'єра й оператора, POS-систему, в яку було передано замовлення, і його ID там, ID замовлення в Glovo, списання й нарахування бонусів, історію статусів, журнал змін, скасування та повернення. Дані лише читаються — API нічого не змінює.
Важливо! Вивантажуються лише завершені замовлення: виконані, невдалі та скасовані. Замовлення в роботі не повертаються. Замовлення з'являється у вивантаженні приблизно через 5 хвилин після завершення. Один запит — одна доба (за київським часом): за замовчуванням сьогодні, будь-який минулий день — через date=РРРР-ММ-ДД.
Важливо! API повертає повні дані клієнтів (телефон, ім'я, адресу) та імена співробітників. Надавайте доступ лише користувачу, якого партнер уповноважив отримувати ці дані.
Важливо! Ліміт: 5 запитів на хвилину, 20 на годину та 100 на добу на акаунт. Один запит повертає до 100 замовлень, тож за добу можна завантажити близько 10 000 замовлень. Ліміт окремий від API статистики замовлень.
Зверніть увагу! Деякі факти платформа не зберігає, і вони завжди порожні: коментар до скасування, хто створив промокод, баланс бонусів після операції, автор і коментар бонусної операції. Бонусні операції без замовлення (ручні коригування, згоряння) не вивантажуються. Журнал змін зберігається 6 місяців.
2. Покрокова інструкція з доступу
1. Відкрийте в Панелі керування → Клієнти → Ролі та створіть (або відкрийте) роль із правом «Звіти статистики замовлень → Акаунт» (Order statistics report → Account).


2. Відкрийте Користувачі → створіть (або оберіть) користувача, який читатиме дані, і призначте йому цю роль. Користувач, який має роль "Адміністратор акаунта" або "Повний доступ" також має вже такі права.

3. Відкрийте вкладку API користувача й натисніть «Перегенерувати Api Token».

4. У вкладці "Список Auth Token'ів" натисніть «Створити новий Auth Token».

5. Для отримання інформації Вам знадобляться такі дані: ID акаунта (Current Account Token), Api Token, Auth Token і посилання на документацію API.
- ID акаунта (Current Account Token)

Api Token

Auth Token

посилання на документацію API
https://docs.dots.live/
! Ви можете самостійно отримати дані в Панелі керування як описано вище або ж звернутися до чату підтримки і вони зможуть надіслати Вам ці дані.
3. Запити та дані
3.1. Замовлення
Завершені замовлення однієї доби (за київським часом, з 00:00 до 00:00), обрані за часом завершення. Без дати запит повертає сьогоднішній день з 00:00; для іншого дня додайте date=РРРР-ММ-ДД (наприклад, date=2026-11-04). Великий день читається посторінково. Кожне замовлення містить:
Дані | Що містить |
Замовлення | ID, номер, час створення й завершення, статус (виконане / невдале / скасоване), канал (сайт, застосунок, оператор, панель закладу, POS, Glovo), тип отримання (доставка, самовивіз, у закладі) |
Заклад | компанія, філія, назва та адреса закладу |
Клієнт | ID, телефон, ім'я, адреса доставки |
Позиції | назва, кількість, ціна, стандартна ціна, сума, модифікатори, ID позицій у POS |
Ціни | сума до знижок, сума знижки, доставка, пакування, оплачено бонусами, чайові, сервісний збір, підсумок — у копійках |
Знижки | джерело кожної знижки: акція, промокод, ручна знижка, сертифікат, бонуси |
Оплата | тип (готівка, онлайн, термінал кур'єра, бонуси) і статус (очікує, не вдалася, утримано, списано) |
Люди | кур'єр, відповідальний оператор, хто створив замовлення — кожен з ID, ім'ям і роллю |
POS | POS-система, в яку замовлення фактично передано (iiko / Syrve, Poster, …), ID замовлення в ній, статус передачі |
Маркетплейс | для замовлень Glovo: ID замовлення в Glovo |
Бонусні операції | бонуси, списані за замовлення, кешбек, нарахований за замовлення, кешбек за відгук — сума, статус, час |
Історія статусів | кожен статус: з якого, в який, коли, хто (клієнт, співробітник закладу з роллю, кур'єр, POS, Glovo, агент, підтримка Dots; порожньо для автоматичної зміни) |
Журнал змін | ціна, ціна доставки, бонуси, тип оплати, адреса, дані клієнта, кур'єр, оператор, коментар, промокод — хто, коли, до / після |
Скасування | на якому статусі, причина, чи передано в POS, чи прийняв заклад, чи був призначений кур'єр, хто скасував |
Повернення | сума, час, статус, спосіб (платіжний провайдер) |
Корисно! Типові запити: …/analytics/orders — сьогодні; …/analytics/orders?date=2026-11-04 — 4 листопада; …/analytics/orders?date=2026-11-04&page=2 — наступні 100 замовлень цього дня, поки hasMore = true.
Корисно! ID замовлення в POS (pos.orderId) належить тій POS-системі, в яку замовлення справді передано, тож його можна звіряти з iiko, Poster чи будь-якою іншою підключеною POS. Якщо замовлення повторно передали в іншу POS, показується остання.
Зверніть увагу! Якщо якийсь сервіс платформи не відповів, замовлення все одно повертаються, але POS-система чи повернення окремих замовлень порожні, а meta.isComplete = false. Запросіть цей день ще раз трохи пізніше, щоб отримати повну відповідь.
Зверніть увагу! Дата в майбутньому або в неправильному форматі (наприклад, 04.11.2026) відхиляється з помилкою 422. Сьогоднішній список доповнюється до кінця дня.
3.2. Бонусні операції всередині замовлення
У кожному замовленні є список bonusOperations (порожній, якщо бонуси не використовувались і не нараховувались):
Дані | Що містить |
order_write_off | бонуси, якими оплачено замовлення; сума від'ємна |
order_accrual | кешбек, нарахований за замовлення; сума додатна |
review_accrual | кешбек, нарахований за відгук клієнта до замовлення |
Сума | у копійках |
Статус | waiting — ще не завершено; succeed — виконано; cancelled — замовлення невдале або скасоване, бонуси не списані / не нараховані |
Час | коли операцію створено та завершено (порожньо, якщо платформа не зберігає цей момент) |
Зверніть увагу! ID операції, її автор і коментар порожні. Ручні нарахування / списання та згоряння, не пов'язані із замовленням, у вивантаження не входять.
3.3. Хто є хто (співробітники та кур'єри)
Окремого списку співробітників немає: кожна людина в замовленні (кур'єр, оператор, хто створив замовлення, хто змінив статус чи замовлення) приходить з ID, ім'ям і роллю прямо в замовленні.
Дані | Що містить |
Співробітник закладу | ID, ім'я, назва ролі |
Кур'єр | ID, ім'я, позивний |
Клієнт, POS, Glovo, агент | лише тип (у клієнта також ID) |
Підтримка Dots | показується як підтримка Dots без імені |
Корисно! Партнер може зібрати власний довідник співробітників із замовлень: та сама людина завжди має той самий ID.
3.4. Ліміти та помилки
Відповіді, які може отримати партнер:
Дані | Що містить |
429 too_many_requests | ліміт вичерпано; у відповіді вказано, через скільки секунд повторити |
403 statistics_forbidden | у користувача немає права «Звіт статистики замовлень → Акаунт» або він з іншого акаунта |
401 | немає або неправильний Api Token чи Auth Token |
404 account_not_found | неправильний ID акаунта |
422 validation_failed | дата в майбутньому, неправильний формат дати, забагато рядків на сторінку |
502 statistics_unavailable | платформа не відповіла; повторіть пізніше |
200 з meta.isComplete = false | замовлення повернуто, але частини даних (POS-система, повернення) бракує; запросіть день ще раз пізніше |
Важливо! Рахується кожен запит, зокрема повторний. Завантажуйте день посторінково й зберігайте сторінки, а не запитуйте їх знову; місяць історії — щонайменше 30 запитів.
4. Приклади використання та поради
• Щоденне завантаження: щоранку партнер завантажує вчорашній день з date=<вчора> (1–3 запити для звичайного дня).
• Звірка з POS: партнер порівнює pos.orderId і підсумок кожного замовлення зі своїм звітом iiko / Poster.
• Звірка з Glovo: marketplace.orderId — це ID замовлення в Glovo.
• Аналіз лояльності: bonusOperations показують, скільки бонусів витрачено й нараховано на замовлення та за день.
• Аналіз скасувань: блок скасування показує, на якому статусі скасовують замовлення і чи кухня або кур'єр уже почали роботу.
• Початкова історія: один запит на добу (плюс додаткові сторінки для завантажених днів); через ліміт 100 запитів на добу довгу історію завантажують за кілька днів.
• Не опитуйте сьогоднішній день щохвилини: відповідь за сьогодні оновлюється раз на 3 хвилини, а часті запити витрачають добовий ліміт.
5. Часті питання
Як отримати замовлення за конкретний день?
Додайте date=РРРР-ММ-ДД, наприклад date=2026-11-04. Без date повертається сьогодні з 00:00 (за київським часом).
Чому немає сьогоднішнього замовлення?
Вивантажуються лише завершені замовлення, приблизно через 5 хвилин після завершення. Замовлення в роботі не повертаються.
Де бонусні операції та співробітники?
Усередині кожного замовлення: bonusOperations, а також об'єкти кур'єра / оператора / автора з ID, ім'ям і роллю. Окремих запитів для них немає.
Чому POS-система замовлення порожня?
Замовлення не передавалося в POS (наприклад, замовлення Glovo без POS) або платформа тимчасово не відповіла — тоді meta.isComplete = false; запросіть день ще раз пізніше.
Що означає meta.isComplete = false?
Замовлення правильні, але частина даних була тимчасово недоступна. Така відповідь не кешується — наступний запит отримає свіжі дані.
Чому коментар до скасування порожній?
Платформа не зберігає коментар до скасування; доступна лише причина.
Чому журнал змін порожній для старого замовлення?
Історія замовлення зберігається 6 місяців.
Партнер отримує 429. Що робити?
Зачекайте кількість секунд із відповіді. Ліміт — 5 на хвилину, 20 на годину, 100 на добу на акаунт.
Чи можна збільшити ліміт?
Так, це робить команда розробки; надішліть запит з очікуваним обсягом партнера.
Чи була ця стаття корисною?
Дякуємо за відгук!