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