API

Gauti klientų premijų operacijų sąrašą

GET/api/crm/v2/clients_bonusesv2
operationId: clientsBonuses.default

Autorizacija

api-token + language + role

Užklausos parametrai

page_numberinteger

Pavyzdys: 1

date_creation_fromstring

Pavyzdys: 25/04/2024

date_creation_tostring

Pavyzdys: 26/04/2024

chain_idinteger

Pavyzdys: 1

branch_idinteger
phone_format_idinteger

Pavyzdys: 1

phone_numberstring

Pavyzdys: 9999999999

genderstring

Reikšmės:womanman

downloadstring

Reikšmės:yes

Pavyzdys: yes

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

phone_format_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

phone_numberobject (FilterInput)
valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: integer or string

placeholderstring

Pavyzdys: string

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

genderobject (FilterEnum)

Filtras-enumeracija — plokščias enumeracijos reikšmių sąrašas

valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: select

optionarray of string
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

downloadobject (FilterButtonDownloadCsv)

Atsisiuntimo mygtukas: paspaudus perduokite download=yes

valuestring

Pavyzdys: Download

typestringprivalomas

Pavyzdys: button_download_csv

system_automationboolean

Pavyzdys: true

listarray of object
idintegerprivalomas

Pavyzdys: 1

date_creationstring (DataTimeFormatSQL) privalomas

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

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

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

date_changestring (DataTimeFormatSQL)

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

typestringprivalomas

Reikšmės:birthdayfeedbackpromo_coderegistrationinvitationreferral_codereferralordergift

Pavyzdys: gift

descriptionstring

Pavyzdys: bonuses for the registration

sumnumberprivalomas

Pavyzdys: 135

order_idinteger

Pavyzdys: 0

feedback_idinteger

Pavyzdys: 0

statusstringprivalomas

Reikšmės:availablenot_available

Pavyzdys: available

branch_idinteger

Pavyzdys: 1

order_numberinteger

Pavyzdys: 1

feedback_datestring (DataTimeFormatSQL)

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

client_namestring

Pavyzdys: client name

client_phone_format_idinteger

Pavyzdys: 1

client_phone_numberstring

Pavyzdys: 9638887321

chain_namestring

Pavyzdys: Green Basket

spent_sumnumberprivalomas

Pavyzdys: 135

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