API

Получить динамику заказов

GET/api/crm/v2/order_dynamicsv2
operationId: orderDynamics.default

Возвращает динамику заказов. Значения агрегируются по дням, месяцам или годам в зависимости от длины периода.

Авторизация

api-token + language + role

Параметры запроса

date_creation_fromstring

Пример: 25/04/2024

date_creation_tostring

Пример: 26/04/2024

chain_idinteger

Пример: 7142

branch_idinteger
platformstring (OrderPlatform)

Платформа заказа

Значения:androidapifbiosvksite

operator_idinteger
all_zonesboolean

Пример: true

Ответы

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

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

platformobject (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

all_zonesobject (FilterBooleanCheckbox)
valueboolean

Для true передайте 1 в запросе, для false ничего не передавайте

Пример: false

typestringобязательный

Пример: checkbox

modestring (FilterMode)

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

Значения:force_shownvalue_required

Пример: value_required

listarray of object
namestringобязательный

Значения:confirmedallnotcanceled

Пример: confirmed

valuesarray of object
namestringобязательный

День/месяц (например, 03/07), месяц/год (например, 07/2024) или год (например, 2013)

Пример: 03/07

valueintegerобязательный

Пример: 0

sumnumber

Пример: 0

commission_paidnumber

Только подтверждённые заказы

Пример: 0