API

Ottenere l'elenco delle operazioni bonus dei clienti

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

Autorizzazione

api-token + language + role

Parametri della richiesta

page_numberinteger

Esempio: 1

date_creation_fromstring

Esempio: 25/04/2024

date_creation_tostring

Esempio: 26/04/2024

chain_idinteger

Esempio: 1

branch_idinteger
phone_format_idinteger

Esempio: 1

phone_numberstring

Esempio: 9999999999

genderstring

Valori:womanman

downloadstring

Valori:yes

Esempio: yes

Risposte

OK

object
statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringpuò essere nullo

Esempio: 2026-08-01 00:00:00

typestringobbligatorio

Esempio: date

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

date_creation_toobject (FilterDateTo)
valuestringpuò essere nullo

Esempio: 2026-08-31 23:59:59

typestringobbligatorio

Esempio: date

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

date_creation_rangeobject (FilterDateRange)

Periodi predefiniti per il filtro data; il limite inferiore è calcolato nel fuso orario dell’utente. value indica il periodo corrispondente agli attuali *_from e *_to; null indica un periodo personalizzato. default è il periodo che il server inserisce nella richiesta senza date: viene applicato al primo caricamento della sezione e al reset. Il limite superiore del periodo corrisponde sempre al giorno attuale dell’utente, quindi option non lo include: non è necessario trasmettere *_to per un periodo predefinito, il server lo imposta automaticamente. Un periodo superiore a un anno viene troncato dal lato più recente.

valuestring (DateRange) può essere nullo

Periodo di filtro data predefinito. Non ha un proprio parametro di richiesta: il limite inferiore viene già calcolato in option e inserito in *_from. Il limite superiore non viene trasmesso né nella risposta né nella richiesta: è sempre uguale al giorno corrente dell’utente e viene impostato dal server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Esempio: today

defaultstring (DateRange) obbligatorio

Periodo di filtro data predefinito. Non ha un proprio parametro di richiesta: il limite inferiore viene già calcolato in option e inserito in *_from. Il limite superiore non viene trasmesso né nella risposta né nella richiesta: è sempre uguale al giorno corrente dell’utente e viene impostato dal server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Esempio: today

typestringobbligatorio

Esempio: select

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

optionarray of objectobbligatorio
valuestring (DateRange) obbligatorio

Periodo di filtro data predefinito. Non ha un proprio parametro di richiesta: il limite inferiore viene già calcolato in option e inserito in *_from. Il limite superiore non viene trasmesso né nella risposta né nella richiesta: è sempre uguale al giorno corrente dell’utente e viene impostato dal server.

Valori:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Esempio: today

date_fromstringobbligatorio

Esempio: 25/08/2026

branch_idobject (FilterSelectInteger)
valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object
valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object
valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

phone_numberobject (FilterInput)
valuestring

Esempio: example

typestringobbligatorio

Esempio: integer or string

placeholderstring

Esempio: string

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

genderobject (FilterEnum)

Filtro enumerazione: elenco piatto di valori enumerati

valuestring

Esempio: example

typestringobbligatorio

Esempio: select

optionarray of string
modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

downloadobject (FilterButtonDownloadCsv)

Pulsante di download della selezione: al clic, passa download=yes

valuestring

Esempio: Download

typestringobbligatorio

Esempio: button_download_csv

system_automationboolean

Esempio: true

listarray of object
idintegerobbligatorio

Esempio: 1

date_creationstring (DataTimeFormatSQL) obbligatorio

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

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

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

date_changestring (DataTimeFormatSQL)

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

typestringobbligatorio

Valori:birthdayfeedbackpromo_coderegistrationinvitationreferral_codereferralordergift

Esempio: gift

descriptionstring

Esempio: bonuses for the registration

sumnumberobbligatorio

Esempio: 135

order_idinteger

Esempio: 0

feedback_idinteger

Esempio: 0

statusstringobbligatorio

Valori:availablenot_available

Esempio: available

branch_idinteger

Esempio: 1

order_numberinteger

Esempio: 1

feedback_datestring (DataTimeFormatSQL)

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

client_namestring

Esempio: client name

client_phone_format_idinteger

Esempio: 1

client_phone_numberstring

Esempio: 9638887321

chain_namestring

Esempio: Green Basket

spent_sumnumberobbligatorio

Esempio: 135

paginationobject (Pagination)
max_countintegerobbligatorio

Numero di elementi per pagina

Esempio: 30

page_numberintegerobbligatorio

Numero della pagina corrente; limitato in modo che l'offset non superi 1000

Esempio: 1

has_nextbooleanobbligatorio

Esiste una pagina successiva

Esempio: true

has_previousbooleanobbligatorio

C'è una pagina precedente

Esempio: false