API

Клиенттердің бонус операцияларының тізімін алу

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

Авторизация

api-token + language + role

Сұраныс параметрлері

page_numberinteger

Мысал: 1

date_creation_fromstring

Мысал: 25/04/2024

date_creation_tostring

Мысал: 26/04/2024

chain_idinteger

Мысал: 1

branch_idinteger
phone_format_idinteger

Мысал: 1

phone_numberstring

Мысал: 9999999999

genderstring

Мәндер:womanman

downloadstring

Мәндер:yes

Мысал: yes

Жауаптар

OK

object
statusstringміндетті

Мәндер:successerror

Мысал: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringnull мәнін қабылдай алады

Мысал: 2026-08-01 00:00:00

typestringміндетті

Мысал: date

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

date_creation_toobject (FilterDateTo)
valuestringnull мәнін қабылдай алады

Мысал: 2026-08-31 23:59:59

typestringміндетті

Мысал: date

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

date_creation_rangeobject (FilterDateRange)

Дайын күндер бойынша сүзгілеу кезеңдері; төменгі шегі пайдаланушының уақыт белдеуінде есептеледі. value — ағымдағы *_from және *_to сәйкес келетін кезең; null — еркін кезең. default — сервер күндерсіз сұраныста қолданатын кезең: бұл кезең бөлім алғаш жүктелгенде және қалпына келтіру кезінде қолданылады. Кезеңнің жоғарғы шегі әрқашан пайдаланушының ағымдағы күніне тең, сондықтан option оны қамтымайды: дайын кезең үшін *_to жіберудің қажеті жоқ, сервер оны өзі орнатады. Бір жылдан ұзақ кезең жаңа шегінен қысқартылады.

valuestring (DateRange) null мәнін қабылдай алады

Дайын күн бойынша сүзгі кезеңі. Оның жеке сұраныс параметрі жоқ: төменгі шегі есептелген түрде option ішінде келеді және *_from орнына қойылады. Жоғарғы шегі жауапта да, сұраныста да берілмейді — ол әрқашан пайдаланушының ағымдағы күніне тең және сервер арқылы орнатылады.

Мәндер:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Мысал: today

defaultstring (DateRange) міндетті

Дайын күн бойынша сүзгі кезеңі. Оның жеке сұраныс параметрі жоқ: төменгі шегі есептелген түрде option ішінде келеді және *_from орнына қойылады. Жоғарғы шегі жауапта да, сұраныста да берілмейді — ол әрқашан пайдаланушының ағымдағы күніне тең және сервер арқылы орнатылады.

Мәндер:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Мысал: today

typestringміндетті

Мысал: select

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

optionarray of objectміндетті
valuestring (DateRange) міндетті

Дайын күн бойынша сүзгі кезеңі. Оның жеке сұраныс параметрі жоқ: төменгі шегі есептелген түрде option ішінде келеді және *_from орнына қойылады. Жоғарғы шегі жауапта да, сұраныста да берілмейді — ол әрқашан пайдаланушының ағымдағы күніне тең және сервер арқылы орнатылады.

Мәндер:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Мысал: today

date_fromstringміндетті

Мысал: 25/08/2026

branch_idobject (FilterSelectInteger)
valueinteger

Мысал: 8920

typestringміндетті

Мысал: select

optionarray of object
valueintegerміндетті

Мысал: 8920

namestringміндетті

Мысал: Green Basket | Kaliningrad

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Мысал: 8920

typestringміндетті

Мысал: select

optionarray of object
valueintegerміндетті

Мысал: 8920

namestringміндетті

Мысал: Green Basket | Kaliningrad

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

phone_numberobject (FilterInput)
valuestring

Мысал: example

typestringміндетті

Мысал: integer or string

placeholderstring

Мысал: string

modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

genderobject (FilterEnum)

Фильтр-тізім — enum мәндерінің жазық тізімі

valuestring

Мысал: example

typestringміндетті

Мысал: select

optionarray of string
modestring (FilterMode)

Интерфейс сүзгіні қалай өңдейді; кәдімгі сүзгіде mode жоқ. force_shown — әрқашан көрсетіледі, жасыруға болмайды. value_required — бөлімге кіру нүктесі: әрқашан көрсетіледі, бос мәні болмайды (мән таңдалмағанша, тізім бос; «барлығы» нұсқасы жоқ), жалпы тазарту оны өшірмейді.

Мәндер:force_shownvalue_required

Мысал: value_required

downloadobject (FilterButtonDownloadCsv)

Таңдау жүктеу түймесі: басқанда download=yes жіберіңіз

valuestring

Мысал: Download

typestringміндетті

Мысал: button_download_csv

system_automationboolean

Мысал: true

listarray of object
idintegerміндетті

Мысал: 1

date_creationstring (DataTimeFormatSQL) міндетті

Мысал: 2024-05-02 08:31:16

date_availablestring (DataTimeFormatSQL)

Мысал: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Мысал: 2024-05-02 08:31:16

date_changestring (DataTimeFormatSQL)

Мысал: 2024-05-02 08:31:16

typestringміндетті

Мәндер:birthdayfeedbackpromo_coderegistrationinvitationreferral_codereferralordergift

Мысал: gift

descriptionstring

Мысал: bonuses for the registration

sumnumberміндетті

Мысал: 135

order_idinteger

Мысал: 0

feedback_idinteger

Мысал: 0

statusstringміндетті

Мәндер:availablenot_available

Мысал: available

branch_idinteger

Мысал: 1

order_numberinteger

Мысал: 1

feedback_datestring (DataTimeFormatSQL)

Мысал: 2024-05-02 08:31:16

client_namestring

Мысал: client name

client_phone_format_idinteger

Мысал: 1

client_phone_numberstring

Мысал: 9638887321

chain_namestring

Мысал: Green Basket

spent_sumnumberміндетті

Мысал: 135

paginationobject (Pagination)
max_countintegerміндетті

Беттегі элементтер саны

Мысал: 30

page_numberintegerміндетті

Ағымдағы беттің нөмірі; ығысу 1000-нан аспайтындай шектелген

Мысал: 1

has_nextbooleanміндетті

Келесі бет бар ма

Мысал: true

has_previousbooleanміндетті

Алдыңғы бет бар ма

Мысал: false