API

Получить список push-уведомлений

GET/api/crm/v2/push_notificationsv2
operationId: pushNotifications.default

Авторизация

api-token + language + role

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

date_creation_fromstring

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

date_creation_tostring

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

chain_idinteger

Пример: 7124

branch_idinteger
page_numberinteger

Пример: 1

Ответы

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

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

firms_prices_pushnumber

Пример: 0.06

holiday_datesarray of string
listarray of object
idintegerобязательный

Пример: 1

statusstring (StatusPushNotifications) обязательный

Значения:in_queuerunsuccesserrorend_with_error

Пример: in_queue

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

Пример: 1

titlestring

Пример: title

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

Пример: 0

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

Пример: 0

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

Пример: 0

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

Пример: 0

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

Пример: 0

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

Пример: 0

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

Пример: 0

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

Пример: Lorem Ipsum is simply dummy text of the printing and typesetting industry

platformstring (Platform) обязательный

Значения:androidiosallmobile_appssitesocial_apps

Пример: all

genderstring (Gender)

Значения:womanman

Пример: man

date_of_birth_fromstring

Пример: 09/07

date_of_birth_tostring

Пример: 10/07

date_creationstring (DataTimeFormatSQL) обязательный

Пример: 2024-05-02 08:31:16

date_sendingstring (DataTimeFormatSQL) обязательный

Пример: 2024-05-02 08:31:16

date_last_order_fromstring (DataTimeFormatSQL)

Пример: 2024-05-02 08:31:16

date_last_order_tostring (DataTimeFormatSQL)

Пример: 2024-05-02 08:31:16

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

Название сети

Пример: Green Basket

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

Пример: Voronezh

sumnumber

Стоимость push-уведомления

Пример: 0

paginationobject (Pagination)
max_countintegerобязательный

Количество элементов на странице

Пример: 30

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

Номер текущей страницы; ограничен так, чтобы смещение не превышало 1000

Пример: 1

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

Есть ли следующая страница

Пример: true

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

Есть ли предыдущая страница

Пример: false