API

Obtener la lista de operaciones de bonificación de los clientes

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

Autorización

api-token + language + role

Parámetros de consulta

page_numberinteger

Ejemplo: 1

date_creation_fromstring

Ejemplo: 25/04/2024

date_creation_tostring

Ejemplo: 26/04/2024

chain_idinteger

Ejemplo: 1

branch_idinteger
phone_format_idinteger

Ejemplo: 1

phone_numberstring

Ejemplo: 9999999999

genderstring

Valores:womanman

downloadstring

Valores:yes

Ejemplo: yes

Respuestas

OK

object
statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringpuede ser nulo

Ejemplo: 2026-08-01 00:00:00

typestringobligatorio

Ejemplo: date

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

date_creation_toobject (FilterDateTo)
valuestringpuede ser nulo

Ejemplo: 2026-08-31 23:59:59

typestringobligatorio

Ejemplo: date

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

date_creation_rangeobject (FilterDateRange)

Períodos predefinidos para el filtro de fecha; el límite inferior se calcula según la zona horaria del usuario. value — período correspondiente a los valores actuales de *_from y *_to; null — período personalizado. default — período que el servidor utiliza en la solicitud si no se especifican fechas: también se aplica al cargar la sección por primera vez y al restablecer el filtro. El límite superior del período siempre corresponde al día actual del usuario, por lo que option no lo incluye: no es necesario enviar *_to para un período predefinido, el servidor lo establece automáticamente. Si el período es mayor a un año, se recorta por el límite más reciente.

valuestring (DateRange) puede ser nulo

Período de filtro de fecha predefinido. No tiene su propio parámetro de consulta: el límite inferior ya viene calculado en option y se utiliza en *_from. El límite superior no se envía ni en la respuesta ni en la solicitud: siempre corresponde al día actual del usuario y lo define el servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

defaultstring (DateRange) obligatorio

Período de filtro de fecha predefinido. No tiene su propio parámetro de consulta: el límite inferior ya viene calculado en option y se utiliza en *_from. El límite superior no se envía ni en la respuesta ni en la solicitud: siempre corresponde al día actual del usuario y lo define el servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

typestringobligatorio

Ejemplo: select

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

optionarray of objectobligatorio
valuestring (DateRange) obligatorio

Período de filtro de fecha predefinido. No tiene su propio parámetro de consulta: el límite inferior ya viene calculado en option y se utiliza en *_from. El límite superior no se envía ni en la respuesta ni en la solicitud: siempre corresponde al día actual del usuario y lo define el servidor.

Valores:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Ejemplo: today

date_fromstringobligatorio

Ejemplo: 25/08/2026

branch_idobject (FilterSelectInteger)
valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object
valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object
valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

phone_numberobject (FilterInput)
valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: integer or string

placeholderstring

Ejemplo: string

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

genderobject (FilterEnum)

Filtro-enumeración: una lista plana de valores de enumeración

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: select

optionarray of string
modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

downloadobject (FilterButtonDownloadCsv)

Botón para descargar la selección: al hacer clic, envíe download=yes

valuestring

Ejemplo: Download

typestringobligatorio

Ejemplo: button_download_csv

system_automationboolean

Ejemplo: true

listarray of object
idintegerobligatorio

Ejemplo: 1

date_creationstring (DataTimeFormatSQL) obligatorio

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

date_availablestring (DataTimeFormatSQL)

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

date_expirationstring (DataTimeFormatSQL)

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

date_changestring (DataTimeFormatSQL)

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

typestringobligatorio

Valores:birthdayfeedbackpromo_coderegistrationinvitationreferral_codereferralordergift

Ejemplo: gift

descriptionstring

Ejemplo: bonuses for the registration

sumnumberobligatorio

Ejemplo: 135

order_idinteger

Ejemplo: 0

feedback_idinteger

Ejemplo: 0

statusstringobligatorio

Valores:availablenot_available

Ejemplo: available

branch_idinteger

Ejemplo: 1

order_numberinteger

Ejemplo: 1

feedback_datestring (DataTimeFormatSQL)

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

client_namestring

Ejemplo: client name

client_phone_format_idinteger

Ejemplo: 1

client_phone_numberstring

Ejemplo: 9638887321

chain_namestring

Ejemplo: Green Basket

spent_sumnumberobligatorio

Ejemplo: 135

paginationobject (Pagination)
max_countintegerobligatorio

Cantidad de elementos por página

Ejemplo: 30

page_numberintegerobligatorio

Número de la página actual; limitado para que el desplazamiento no supere 1000

Ejemplo: 1

has_nextbooleanobligatorio

¿Hay una página siguiente?

Ejemplo: true

has_previousbooleanobligatorio

¿Hay una página anterior?

Ejemplo: false