API

Liste der Bonusvorgänge der Kunden abrufen

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

Autorisierung

api-token + language + role

Abfrageparameter

page_numberinteger

Beispiel: 1

date_creation_fromstring

Beispiel: 25/04/2024

date_creation_tostring

Beispiel: 26/04/2024

chain_idinteger

Beispiel: 1

branch_idinteger
phone_format_idinteger

Beispiel: 1

phone_numberstring

Beispiel: 9999999999

genderstring

Werte:womanman

downloadstring

Werte:yes

Beispiel: yes

Antworten

OK

object
statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringkann null sein

Beispiel: 2026-08-01 00:00:00

typestringerforderlich

Beispiel: date

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

date_creation_toobject (FilterDateTo)
valuestringkann null sein

Beispiel: 2026-08-31 23:59:59

typestringerforderlich

Beispiel: date

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

date_creation_rangeobject (FilterDateRange)

Vordefinierte Datumsfilterzeiträume; die Untergrenze wird in der Zeitzone des Benutzers berechnet. value — der Zeitraum, dem die aktuellen *_from und *_to entsprechen; null — benutzerdefinierter Zeitraum. default — der Zeitraum, den der Server bei Anfragen ohne Datumsangaben verwendet: Er wird auch beim ersten Laden des Bereichs angewendet und bei Zurücksetzen wiederhergestellt. Das obere Ende des Zeitraums entspricht immer dem aktuellen Tag des Benutzers, daher enthält option dieses nicht: Für vordefinierte Zeiträume muss *_to nicht übergeben werden, der Server setzt es automatisch. Zeiträume, die länger als ein Jahr sind, werden an der aktuellen Grenze abgeschnitten.

valuestring (DateRange) kann null sein

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

defaultstring (DateRange) erforderlich

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

typestringerforderlich

Beispiel: select

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

optionarray of objecterforderlich
valuestring (DateRange) erforderlich

Vordefinierter Datumsbereichsfilter. Er hat keinen eigenen Anfrageparameter: Der untere Grenzwert wird bereits berechnet in option übergeben und in *_from eingesetzt. Der obere Grenzwert wird weder in der Antwort noch in der Anfrage übermittelt – er entspricht immer dem aktuellen Tag des Benutzers und wird vom Server festgelegt.

Werte:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Beispiel: today

date_fromstringerforderlich

Beispiel: 25/08/2026

branch_idobject (FilterSelectInteger)
valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object
valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object
valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

phone_numberobject (FilterInput)
valuestring

Beispiel: example

typestringerforderlich

Beispiel: integer or string

placeholderstring

Beispiel: string

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

genderobject (FilterEnum)

Filter-Enum — flache Liste von Enumerationswerten

valuestring

Beispiel: example

typestringerforderlich

Beispiel: select

optionarray of string
modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

downloadobject (FilterButtonDownloadCsv)

Download-Button für die Auswahl: Beim Klicken übergeben Sie download=yes

valuestring

Beispiel: Download

typestringerforderlich

Beispiel: button_download_csv

system_automationboolean

Beispiel: true

listarray of object
idintegererforderlich

Beispiel: 1

date_creationstring (DataTimeFormatSQL) erforderlich

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

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

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

date_changestring (DataTimeFormatSQL)

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

typestringerforderlich

Werte:birthdayfeedbackpromo_coderegistrationinvitationreferral_codereferralordergift

Beispiel: gift

descriptionstring

Beispiel: bonuses for the registration

sumnumbererforderlich

Beispiel: 135

order_idinteger

Beispiel: 0

feedback_idinteger

Beispiel: 0

statusstringerforderlich

Werte:availablenot_available

Beispiel: available

branch_idinteger

Beispiel: 1

order_numberinteger

Beispiel: 1

feedback_datestring (DataTimeFormatSQL)

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

client_namestring

Beispiel: client name

client_phone_format_idinteger

Beispiel: 1

client_phone_numberstring

Beispiel: 9638887321

chain_namestring

Beispiel: Green Basket

spent_sumnumbererforderlich

Beispiel: 135

paginationobject (Pagination)
max_countintegererforderlich

Anzahl der Elemente pro Seite

Beispiel: 30

page_numberintegererforderlich

Nummer der aktuellen Seite; begrenzt, sodass der Offset 1000 nicht überschreitet

Beispiel: 1

has_nextbooleanerforderlich

Gibt es eine nächste Seite

Beispiel: true

has_previousbooleanerforderlich

Gibt es eine vorherige Seite

Beispiel: false