API

Pobierz listę operacji bonusowych klientów

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

Autoryzacja

api-token + language + role

Parametry zapytania

page_numberinteger

Przykład: 1

date_creation_fromstring

Przykład: 25/04/2024

date_creation_tostring

Przykład: 26/04/2024

chain_idinteger

Przykład: 1

branch_idinteger
phone_format_idinteger

Przykład: 1

phone_numberstring

Przykład: 9999999999

genderstring

Wartości:womanman

downloadstring

Wartości:yes

Przykład: yes

Odpowiedzi

OK

object
statusstringwymagane

Wartości:successerror

Przykład: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringmoże być null

Przykład: 2026-08-01 00:00:00

typestringwymagane

Przykład: date

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

date_creation_toobject (FilterDateTo)
valuestringmoże być null

Przykład: 2026-08-31 23:59:59

typestringwymagane

Przykład: date

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

date_creation_rangeobject (FilterDateRange)

Gotowe okresy filtrowania według daty; dolna granica jest obliczana w strefie czasowej użytkownika. value — okres, któremu odpowiadają bieżące *_from i *_to; null — dowolny okres. default — okres, który serwer ustawia w zapytaniu bez dat: jest stosowany przy pierwszym ładowaniu sekcji oraz po resecie. Górna granica okresu zawsze odpowiada bieżącemu dniu użytkownika, dlatego option jej nie zawiera: nie trzeba przekazywać *_to dla gotowego okresu, serwer ustawia ją samodzielnie. Okres dłuższy niż rok jest obcinany od najnowszej granicy.

valuestring (DateRange) może być null

Gotowy zakres dat do filtrowania. Nie posiada własnego parametru zapytania: dolna granica jest już obliczona i przekazywana w option, a następnie podstawiana do *_from. Górna granica nie jest przekazywana ani w odpowiedzi, ani w zapytaniu — zawsze jest równa bieżącemu dniu użytkownika i ustalana przez serwer.

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

defaultstring (DateRange) wymagane

Gotowy zakres dat do filtrowania. Nie posiada własnego parametru zapytania: dolna granica jest już obliczona i przekazywana w option, a następnie podstawiana do *_from. Górna granica nie jest przekazywana ani w odpowiedzi, ani w zapytaniu — zawsze jest równa bieżącemu dniu użytkownika i ustalana przez serwer.

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

typestringwymagane

Przykład: select

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

optionarray of objectwymagane
valuestring (DateRange) wymagane

Gotowy zakres dat do filtrowania. Nie posiada własnego parametru zapytania: dolna granica jest już obliczona i przekazywana w option, a następnie podstawiana do *_from. Górna granica nie jest przekazywana ani w odpowiedzi, ani w zapytaniu — zawsze jest równa bieżącemu dniu użytkownika i ustalana przez serwer.

Wartości:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Przykład: today

date_fromstringwymagane

Przykład: 25/08/2026

branch_idobject (FilterSelectInteger)
valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object
valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object
valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

phone_numberobject (FilterInput)
valuestring

Przykład: example

typestringwymagane

Przykład: integer or string

placeholderstring

Przykład: string

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

genderobject (FilterEnum)

Filtr-wyliczenie — płaska lista wartości wyliczenia

valuestring

Przykład: example

typestringwymagane

Przykład: select

optionarray of string
modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

downloadobject (FilterButtonDownloadCsv)

Przycisk pobierania wyników: po kliknięciu przekaż download=yes

valuestring

Przykład: Download

typestringwymagane

Przykład: button_download_csv

system_automationboolean

Przykład: true

listarray of object
idintegerwymagane

Przykład: 1

date_creationstring (DataTimeFormatSQL) wymagane

Przykład: 2024-05-02 08:31:16

date_availablestring (DataTimeFormatSQL)

Przykład: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Przykład: 2024-05-02 08:31:16

date_changestring (DataTimeFormatSQL)

Przykład: 2024-05-02 08:31:16

typestringwymagane

Wartości:birthdayfeedbackpromo_coderegistrationinvitationreferral_codereferralordergift

Przykład: gift

descriptionstring

Przykład: bonuses for the registration

sumnumberwymagane

Przykład: 135

order_idinteger

Przykład: 0

feedback_idinteger

Przykład: 0

statusstringwymagane

Wartości:availablenot_available

Przykład: available

branch_idinteger

Przykład: 1

order_numberinteger

Przykład: 1

feedback_datestring (DataTimeFormatSQL)

Przykład: 2024-05-02 08:31:16

client_namestring

Przykład: client name

client_phone_format_idinteger

Przykład: 1

client_phone_numberstring

Przykład: 9638887321

chain_namestring

Przykład: Green Basket

spent_sumnumberwymagane

Przykład: 135

paginationobject (Pagination)
max_countintegerwymagane

Liczba elementów na stronie

Przykład: 30

page_numberintegerwymagane

Numer bieżącej strony; ograniczony tak, aby przesunięcie nie przekraczało 1000

Przykład: 1

has_nextbooleanwymagane

Czy istnieje następna strona

Przykład: true

has_previousbooleanwymagane

Czy istnieje poprzednia strona

Przykład: false