API

Отримати статистику за каналами продажу

GET/api/crm/v2/sales_channelsv2
operationId: salesChannels.default

Повертає виручку, кількість замовлень та середній чек по кожному каналу продажу. За один запит повертаються дані до двох періодів для порівняння місяць до місяця. Підсумки періоду вже підраховані, а для графіків повертаються лише непорожні години в UTC. Переведіть їх у часовий пояс користувача та згрупуйте за днями або місяцями. До виручки входять лише виконані замовлення.

Авторизація

api-token + language + role

Параметри запиту

date_creation_fromstring

Приклад: 01/08/2026

date_creation_tostring

Приклад: 31/08/2026

date_comparison_fromstring

Другий період; порожній, якщо немає з чим порівнювати

Приклад: 01/07/2026

date_comparison_tostring

Приклад: 31/07/2026

chain_idinteger
branch_idinteger
delivery_methodstring (OrderDelivery)

Спосіб доставки: кур'єр або самовивіз

Значення:courierpickup

payment_statusstring (OrderPayment)

Статус оплати: не оплачено, очікує, оплачено

Значення:not_paidwaitingpaid

operator_idinteger
downloadstring

Повертає зведену таблицю періоду A у форматі CSV замість JSON

Значення:yes

Приклад: yes

Відповіді

OK

object
statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringможе бути null

Приклад: 2026-08-01 00:00:00

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

date_creation_toobject (FilterDateTo)
valuestringможе бути null

Приклад: 2026-08-31 23:59:59

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

date_creation_rangeobject (FilterDateRange)

Готові періоди фільтра за датою; нижня межа розраховується у часовому поясі користувача. value — період, якому відповідають поточні *_from та *_to; null — довільний період. default — період, який сервер підставляє у запит без дат: також застосовується при першому завантаженні розділу та при скиданні. Верхня межа періоду завжди дорівнює поточному дню користувача, тому option її не містить: передавати *_to для готового періоду не потрібно, сервер встановлює її самостійно. Період довший за рік обрізається зі сторони новішої межі.

valuestring (DateRange) може бути null

Готовий період фільтра за датою. Власного параметра запиту не має: нижня межа вже розрахована в option і підставляється в *_from. Верхня межа не передається ні у відповіді, ні у запиті — вона завжди дорівнює поточному дню користувача і задається сервером.

Значення:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Приклад: today

defaultstring (DateRange) обов’язковий

Готовий період фільтра за датою. Власного параметра запиту не має: нижня межа вже розрахована в option і підставляється в *_from. Верхня межа не передається ні у відповіді, ні у запиті — вона завжди дорівнює поточному дню користувача і задається сервером.

Значення:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Приклад: today

typestringобов’язковий

Приклад: select

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

optionarray of objectобов’язковий
valuestring (DateRange) обов’язковий

Готовий період фільтра за датою. Власного параметра запиту не має: нижня межа вже розрахована в option і підставляється в *_from. Верхня межа не передається ні у відповіді, ні у запиті — вона завжди дорівнює поточному дню користувача і задається сервером.

Значення:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Приклад: today

date_fromstringобов’язковий

Приклад: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringможе бути null

Приклад: 2026-08-01 00:00:00

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

date_comparison_toobject (FilterDateTo)
valuestringможе бути null

Приклад: 2026-08-31 23:59:59

typestringобов’язковий

Приклад: date

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Готові періоди фільтра дат без значення за замовчуванням: default завжди дорівнює null.

valuestring (DateRange) може бути null

Готовий період фільтра за датою. Власного параметра запиту не має: нижня межа вже розрахована в option і підставляється в *_from. Верхня межа не передається ні у відповіді, ні у запиті — вона завжди дорівнює поточному дню користувача і задається сервером.

Значення:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Приклад: today

defaultstring (DateRange) може бути null

Готовий період фільтра за датою. Власного параметра запиту не має: нижня межа вже розрахована в option і підставляється в *_from. Верхня межа не передається ні у відповіді, ні у запиті — вона завжди дорівнює поточному дню користувача і задається сервером.

Значення:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Приклад: today

typestringобов’язковий

Приклад: select

optionarray of objectобов’язковий
valuestring (DateRange) обов’язковий

Готовий період фільтра за датою. Власного параметра запиту не має: нижня межа вже розрахована в option і підставляється в *_from. Верхня межа не передається ні у відповіді, ні у запиті — вона завжди дорівнює поточному дню користувача і задається сервером.

Значення:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Приклад: today

date_fromstringобов’язковий

Приклад: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object
valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object
valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

delivery_methodobject (FilterEnum)

Фільтр-перерахування — плоский список значень перерахування

valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of string
modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

payment_statusobject (FilterEnum)

Фільтр-перерахування — плоский список значень перерахування

valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of string
modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

operator_idobject (FilterSelectInteger)
valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object
valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

downloadobject (FilterButtonDownloadCsv)

Кнопка завантаження вибірки: при натисканні передайте download=yes

valuestring

Приклад: Download

typestringобов’язковий

Приклад: button_download_csv

periodsarray of object

Один елемент на період; другий — лише якщо задано період для порівняння

keystringобов’язковий

a — основний період, b — період порівняння

Значення:ab

Приклад: a

date_fromstringобов’язковий

Приклад: 01/08/2026

date_tostringобов’язковий

Приклад: 31/08/2026

totalobject (SalesChannelsTotal) обов’язковий

Підсумки періоду за всіма каналами

orders_countintegerобов’язковий

Приклад: 4120

completed_countintegerобов’язковий

Приклад: 3894

completed_percentnumberобов’язковий

Приклад: 94.51

revenuenumberобов’язковий

Приклад: 4361280

averagenumberобов’язковий

Приклад: 1120

channelsarray of objectобов’язковий

Один елемент для кожного каналу з замовленнями, у фіксованому порядку. Елемента «всі канали» немає: для цього використовується total.

platformstring (OrderPlatform) обов’язковий

Платформа замовлення

Значення:androidapifbiosvksite

orders_countintegerобов’язковий

Приклад: 1810

orders_sharenumberобов’язковий

Частка замовлень за період у відсотках

Приклад: 43.93

completed_countintegerобов’язковий

Приклад: 1702

completed_percentnumberобов’язковий

Приклад: 94.03

revenuenumberобов’язковий

Приклад: 1855180

revenue_sharenumberобов’язковий

Частка виручки за період у відсотках

Приклад: 42.54

averagenumberобов’язковий

Виручка, поділена на кількість виконаних замовлень

Приклад: 1090

deltaobject (SalesChannelsDelta) обов’язковийможе бути null

Порівняння каналу з тим самим каналом у періоді B. null, якщо період B не задано.

revenue_absolutenumberобов’язковий

Приклад: -120400

revenue_percentnumberобов’язковийможе бути null

null, якщо у періоді B канал не мав виручки: відсутній відсотковий приріст від нуля

Приклад: -6.09

bucketsarray of objectобов’язковий

Замовлення, згруповані за годинами; лише непорожні години. Переведіть час у часовий пояс користувача, потім згрупуйте години у точки графіка: лінійний графік — за днями або місяцями, стовпчиковий — за календарними місяцями. Підсумовуйте count, completed_count та revenue; не усереднюйте середні значення.

datetimestringобов’язковий

Час, до якого відносяться замовлення, в UTC

Приклад: 2026-08-01 09:00:00

countintegerобов’язковий

Приклад: 12

completed_countintegerобов’язковий

Приклад: 11

revenuenumberобов’язковий

Приклад: 12100