API

Obter a lista de notificações push

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

Autorização

api-token + language + role

Parâmetros de consulta

date_creation_fromstring

Exemplo: 25/04/2024

date_creation_tostring

Exemplo: 26/04/2024

chain_idinteger

Exemplo: 7124

branch_idinteger
page_numberinteger

Exemplo: 1

Respostas

OK

object
statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringpode ser nulo

Exemplo: 2026-08-01 00:00:00

typestringobrigatório

Exemplo: date

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

date_creation_toobject (FilterDateTo)
valuestringpode ser nulo

Exemplo: 2026-08-31 23:59:59

typestringobrigatório

Exemplo: date

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

date_creation_rangeobject (FilterDateRange)

Períodos prontos para filtro de data; o limite inferior é calculado no fuso horário do usuário. value — período correspondente aos atuais *_from e *_to; null — período personalizado. default — período que o servidor insere na requisição sem datas: também é aplicado no primeiro carregamento da seção e ao redefinir o filtro. O limite superior do período é sempre igual ao dia atual do usuário, por isso option não o inclui: não é necessário enviar *_to para um período pronto, o servidor define automaticamente. Períodos com duração superior a um ano são cortados no limite mais recente.

valuestring (DateRange) pode ser nulo

Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

defaultstring (DateRange) obrigatório

Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

typestringobrigatório

Exemplo: select

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

optionarray of objectobrigatório
valuestring (DateRange) obrigatório

Período de filtro de data pré-definido. Não possui parâmetro de consulta próprio: o limite inferior já vem calculado em option e é inserido em *_from. O limite superior não é enviado nem na resposta, nem na solicitação — ele é sempre igual ao dia atual do usuário e é definido pelo servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemplo: today

date_fromstringobrigatório

Exemplo: 25/08/2026

branch_idobject (FilterSelectInteger)
valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object
valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

firms_prices_pushnumber

Exemplo: 0.06

holiday_datesarray of string
listarray of object
idintegerobrigatório

Exemplo: 1

statusstring (StatusPushNotifications) obrigatório

Valores:in_queuerunsuccesserrorend_with_error

Exemplo: in_queue

branch_idintegerobrigatório

Exemplo: 1

titlestring

Exemplo: title

ios_successintegerobrigatório

Exemplo: 0

ios_failureintegerobrigatório

Exemplo: 0

android_successintegerobrigatório

Exemplo: 0

android_failureintegerobrigatório

Exemplo: 0

site_successintegerobrigatório

Exemplo: 0

site_failureintegerobrigatório

Exemplo: 0

price_onenumberobrigatório

Exemplo: 0

messagestringobrigatório

Exemplo: Lorem Ipsum is simply dummy text of the printing and typesetting industry

platformstring (Platform) obrigatório

Valores:androidiosallmobile_appssitesocial_apps

Exemplo: all

genderstring (Gender)

Valores:womanman

Exemplo: man

date_of_birth_fromstring

Exemplo: 09/07

date_of_birth_tostring

Exemplo: 10/07

date_creationstring (DataTimeFormatSQL) obrigatório

Exemplo: 2024-05-02 08:31:16

date_sendingstring (DataTimeFormatSQL) obrigatório

Exemplo: 2024-05-02 08:31:16

date_last_order_fromstring (DataTimeFormatSQL)

Exemplo: 2024-05-02 08:31:16

date_last_order_tostring (DataTimeFormatSQL)

Exemplo: 2024-05-02 08:31:16

namestringobrigatório

Nome da rede

Exemplo: Green Basket

city_namestringobrigatório

Exemplo: Voronezh

sumnumber

Custo da notificação push

Exemplo: 0

paginationobject (Pagination)
max_countintegerobrigatório

Número de itens por página

Exemplo: 30

page_numberintegerobrigatório

Número da página atual; limitado para que o deslocamento não exceda 1000

Exemplo: 1

has_nextbooleanobrigatório

Existe uma próxima página

Exemplo: true

has_previousbooleanobrigatório

Existe uma página anterior

Exemplo: false