API

Získat seznam bonusových operací klientů

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

Autorizace

api-token + language + role

Parametry dotazu

page_numberinteger

Příklad: 1

date_creation_fromstring

Příklad: 25/04/2024

date_creation_tostring

Příklad: 26/04/2024

chain_idinteger

Příklad: 1

branch_idinteger
phone_format_idinteger

Příklad: 1

phone_numberstring

Příklad: 9999999999

genderstring

Hodnoty:womanman

downloadstring

Hodnoty:yes

Příklad: yes

Odpovědi

OK

object
statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringmůže být null

Příklad: 2026-08-01 00:00:00

typestringpovinné

Příklad: date

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

date_creation_toobject (FilterDateTo)
valuestringmůže být null

Příklad: 2026-08-31 23:59:59

typestringpovinné

Příklad: date

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

date_creation_rangeobject (FilterDateRange)

Přednastavená období filtru podle data; dolní hranice je vypočítána v časovém pásmu uživatele. value — období, kterému odpovídají aktuální *_from a *_to; null — vlastní období. default — období, které server nastaví v požadavku bez dat: použije se také při prvním načtení sekce a při resetování. Horní hranice období je vždy rovna aktuálnímu dni uživatele, proto ji option neobsahuje: pro přednastavené období není třeba předávat *_to, server ji nastaví sám. Období delší než jeden rok je zkráceno na straně novější hranice.

valuestring (DateRange) může být null

Předdefinované období filtru podle data. Nemá vlastní parametr dotazu: dolní hranice je již vypočítána v option a je použita v *_from. Horní hranice není vrácena v odpovědi ani odeslána v dotazu — vždy odpovídá aktuálnímu dni uživatele a je nastavena serverem.

Hodnoty:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Příklad: today

defaultstring (DateRange) povinné

Předdefinované období filtru podle data. Nemá vlastní parametr dotazu: dolní hranice je již vypočítána v option a je použita v *_from. Horní hranice není vrácena v odpovědi ani odeslána v dotazu — vždy odpovídá aktuálnímu dni uživatele a je nastavena serverem.

Hodnoty:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Příklad: today

typestringpovinné

Příklad: select

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

optionarray of objectpovinné
valuestring (DateRange) povinné

Předdefinované období filtru podle data. Nemá vlastní parametr dotazu: dolní hranice je již vypočítána v option a je použita v *_from. Horní hranice není vrácena v odpovědi ani odeslána v dotazu — vždy odpovídá aktuálnímu dni uživatele a je nastavena serverem.

Hodnoty:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Příklad: today

date_fromstringpovinné

Příklad: 25/08/2026

branch_idobject (FilterSelectInteger)
valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object
valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object
valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

phone_numberobject (FilterInput)
valuestring

Příklad: example

typestringpovinné

Příklad: integer or string

placeholderstring

Příklad: string

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

genderobject (FilterEnum)

Filtr-enum — plochý seznam hodnot výčtu

valuestring

Příklad: example

typestringpovinné

Příklad: select

optionarray of string
modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

downloadobject (FilterButtonDownloadCsv)

Tlačítko pro stažení výběru: při kliknutí předejte download=yes

valuestring

Příklad: Download

typestringpovinné

Příklad: button_download_csv

system_automationboolean

Příklad: true

listarray of object
idintegerpovinné

Příklad: 1

date_creationstring (DataTimeFormatSQL) povinné

Příklad: 2024-05-02 08:31:16

date_availablestring (DataTimeFormatSQL)

Příklad: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Příklad: 2024-05-02 08:31:16

date_changestring (DataTimeFormatSQL)

Příklad: 2024-05-02 08:31:16

typestringpovinné

Hodnoty:birthdayfeedbackpromo_coderegistrationinvitationreferral_codereferralordergift

Příklad: gift

descriptionstring

Příklad: bonuses for the registration

sumnumberpovinné

Příklad: 135

order_idinteger

Příklad: 0

feedback_idinteger

Příklad: 0

statusstringpovinné

Hodnoty:availablenot_available

Příklad: available

branch_idinteger

Příklad: 1

order_numberinteger

Příklad: 1

feedback_datestring (DataTimeFormatSQL)

Příklad: 2024-05-02 08:31:16

client_namestring

Příklad: client name

client_phone_format_idinteger

Příklad: 1

client_phone_numberstring

Příklad: 9638887321

chain_namestring

Příklad: Green Basket

spent_sumnumberpovinné

Příklad: 135

paginationobject (Pagination)
max_countintegerpovinné

Počet položek na stránku

Příklad: 30

page_numberintegerpovinné

Číslo aktuální stránky; omezeno tak, aby posun nepřesáhl 1000

Příklad: 1

has_nextbooleanpovinné

Zda existuje další stránka

Příklad: true

has_previousbooleanpovinné

Zda existuje předchozí stránka

Příklad: false