API

Gauti push pranešimų sąrašą

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

Autorizacija

api-token + language + role

Užklausos parametrai

date_creation_fromstring

Pavyzdys: 25/04/2024

date_creation_tostring

Pavyzdys: 26/04/2024

chain_idinteger

Pavyzdys: 7124

branch_idinteger
page_numberinteger

Pavyzdys: 1

Atsakymai

OK

object
statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringgali būti null

Pavyzdys: 2026-08-01 00:00:00

typestringprivalomas

Pavyzdys: date

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

date_creation_toobject (FilterDateTo)
valuestringgali būti null

Pavyzdys: 2026-08-31 23:59:59

typestringprivalomas

Pavyzdys: date

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

date_creation_rangeobject (FilterDateRange)

Paruošti datos filtro laikotarpiai; apatinė riba apskaičiuojama pagal naudotojo laiko juostą. value — laikotarpis, kuriam atitinka dabartiniai *_from ir *_to; null — pasirinktinis laikotarpis. default — laikotarpis, kurį serveris naudoja užklausoje be datų: jis taip pat taikomas pirmą kartą įkėlus skyrių ir grąžinamas atstatant nustatymus. Viršutinė laikotarpio riba visada lygi dabartinei naudotojo dienai, todėl option jos neturi: perduoti *_to paruoštam laikotarpiui nereikia, serveris ją nustato automatiškai. Laikotarpis, ilgesnis nei metai, nukerpamas nuo naujesnės ribos.

valuestring (DateRange) gali būti null

Paruoštas datos filtro laikotarpis. Neturi atskiro užklausos parametro: apatinė riba jau apskaičiuota ir perduodama per option, įrašoma į *_from. Viršutinė riba neperduodama nei atsakyme, nei užklausoje — ji visada lygi dabartinei naudotojo dienai ir nustatoma serverio.

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

defaultstring (DateRange) privalomas

Paruoštas datos filtro laikotarpis. Neturi atskiro užklausos parametro: apatinė riba jau apskaičiuota ir perduodama per option, įrašoma į *_from. Viršutinė riba neperduodama nei atsakyme, nei užklausoje — ji visada lygi dabartinei naudotojo dienai ir nustatoma serverio.

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

typestringprivalomas

Pavyzdys: select

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

optionarray of objectprivalomas
valuestring (DateRange) privalomas

Paruoštas datos filtro laikotarpis. Neturi atskiro užklausos parametro: apatinė riba jau apskaičiuota ir perduodama per option, įrašoma į *_from. Viršutinė riba neperduodama nei atsakyme, nei užklausoje — ji visada lygi dabartinei naudotojo dienai ir nustatoma serverio.

Reikšmės:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Pavyzdys: today

date_fromstringprivalomas

Pavyzdys: 25/08/2026

branch_idobject (FilterSelectInteger)
valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object
valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

firms_prices_pushnumber

Pavyzdys: 0.06

holiday_datesarray of string
listarray of object
idintegerprivalomas

Pavyzdys: 1

statusstring (StatusPushNotifications) privalomas

Reikšmės:in_queuerunsuccesserrorend_with_error

Pavyzdys: in_queue

branch_idintegerprivalomas

Pavyzdys: 1

titlestring

Pavyzdys: title

ios_successintegerprivalomas

Pavyzdys: 0

ios_failureintegerprivalomas

Pavyzdys: 0

android_successintegerprivalomas

Pavyzdys: 0

android_failureintegerprivalomas

Pavyzdys: 0

site_successintegerprivalomas

Pavyzdys: 0

site_failureintegerprivalomas

Pavyzdys: 0

price_onenumberprivalomas

Pavyzdys: 0

messagestringprivalomas

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

platformstring (Platform) privalomas

Reikšmės:androidiosallmobile_appssitesocial_apps

Pavyzdys: all

genderstring (Gender)

Reikšmės:womanman

Pavyzdys: man

date_of_birth_fromstring

Pavyzdys: 09/07

date_of_birth_tostring

Pavyzdys: 10/07

date_creationstring (DataTimeFormatSQL) privalomas

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

date_sendingstring (DataTimeFormatSQL) privalomas

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

date_last_order_fromstring (DataTimeFormatSQL)

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

date_last_order_tostring (DataTimeFormatSQL)

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

namestringprivalomas

Tinklo pavadinimas

Pavyzdys: Green Basket

city_namestringprivalomas

Pavyzdys: Voronezh

sumnumber

Pranešimo kainа

Pavyzdys: 0

paginationobject (Pagination)
max_countintegerprivalomas

Elementų skaičius puslapyje

Pavyzdys: 30

page_numberintegerprivalomas

Dabartinio puslapio numeris; apribotas taip, kad poslinkis neviršytų 1000

Pavyzdys: 1

has_nextbooleanprivalomas

Ar yra kitas puslapis

Pavyzdys: true

has_previousbooleanprivalomas

Ar yra ankstesnis puslapis

Pavyzdys: false