API

Müşteri bonus işlemlerinin listesini al

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

Yetkilendirme

api-token + language + role

Sorgu parametreleri

page_numberinteger

Örnek: 1

date_creation_fromstring

Örnek: 25/04/2024

date_creation_tostring

Örnek: 26/04/2024

chain_idinteger

Örnek: 1

branch_idinteger
phone_format_idinteger

Örnek: 1

phone_numberstring

Örnek: 9999999999

genderstring

Değerler:womanman

downloadstring

Değerler:yes

Örnek: yes

Yanıtlar

OK

object
statusstringzorunlu

Değerler:successerror

Örnek: success

dataobject
filtersobject
date_creation_fromobject (FilterDateFrom)
valuestringnull olabilir

Örnek: 2026-08-01 00:00:00

typestringzorunlu

Örnek: date

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

date_creation_toobject (FilterDateTo)
valuestringnull olabilir

Örnek: 2026-08-31 23:59:59

typestringzorunlu

Örnek: date

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

date_creation_rangeobject (FilterDateRange)

Hazır tarih filtre dönemleri; alt sınır, kullanıcının saat diliminde hesaplanır. value — mevcut *_from ve *_to ile eşleşen dönem; null — özel dönem. default — sunucunun tarih belirtilmeyen istekte kullandığı dönemdir: ayrıca bölüm ilk yüklendiğinde ve sıfırlama yapıldığında da uygulanır. Dönemin üst sınırı her zaman kullanıcının bugünkü tarihine eşittir, bu nedenle option bunu içermez: hazır dönem için *_to göndermeye gerek yoktur, sunucu bunu otomatik olarak ayarlar. Bir yıldan uzun dönemler, yeni tarihe yakın taraftan kesilir.

valuestring (DateRange) null olabilir

Hazır tarih aralığı filtresi. Bunun için ayrı bir sorgu parametresi yoktur: alt sınır, önceden hesaplanmış olarak option içinde gelir ve *_from alanına eklenir. Üst sınır ise ne yanıtta ne de istekte iletilir — her zaman kullanıcının bugünkü tarihiyle aynıdır ve sunucu tarafından belirlenir.

Değerler:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Örnek: today

defaultstring (DateRange) zorunlu

Hazır tarih aralığı filtresi. Bunun için ayrı bir sorgu parametresi yoktur: alt sınır, önceden hesaplanmış olarak option içinde gelir ve *_from alanına eklenir. Üst sınır ise ne yanıtta ne de istekte iletilir — her zaman kullanıcının bugünkü tarihiyle aynıdır ve sunucu tarafından belirlenir.

Değerler:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Örnek: today

typestringzorunlu

Örnek: select

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

optionarray of objectzorunlu
valuestring (DateRange) zorunlu

Hazır tarih aralığı filtresi. Bunun için ayrı bir sorgu parametresi yoktur: alt sınır, önceden hesaplanmış olarak option içinde gelir ve *_from alanına eklenir. Üst sınır ise ne yanıtta ne de istekte iletilir — her zaman kullanıcının bugünkü tarihiyle aynıdır ve sunucu tarafından belirlenir.

Değerler:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Örnek: today

date_fromstringzorunlu

Örnek: 25/08/2026

branch_idobject (FilterSelectInteger)
valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object
valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object
valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

phone_numberobject (FilterInput)
valuestring

Örnek: example

typestringzorunlu

Örnek: integer or string

placeholderstring

Örnek: string

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

genderobject (FilterEnum)

Filtre-enum — düz enum değerleri listesi

valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of string
modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

downloadobject (FilterButtonDownloadCsv)

İndirme düğmesi: tıklandığında download=yes iletin

valuestring

Örnek: Download

typestringzorunlu

Örnek: button_download_csv

system_automationboolean

Örnek: true

listarray of object
idintegerzorunlu

Örnek: 1

date_creationstring (DataTimeFormatSQL) zorunlu

Örnek: 2024-05-02 08:31:16

date_availablestring (DataTimeFormatSQL)

Örnek: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Örnek: 2024-05-02 08:31:16

date_changestring (DataTimeFormatSQL)

Örnek: 2024-05-02 08:31:16

typestringzorunlu

Değerler:birthdayfeedbackpromo_coderegistrationinvitationreferral_codereferralordergift

Örnek: gift

descriptionstring

Örnek: bonuses for the registration

sumnumberzorunlu

Örnek: 135

order_idinteger

Örnek: 0

feedback_idinteger

Örnek: 0

statusstringzorunlu

Değerler:availablenot_available

Örnek: available

branch_idinteger

Örnek: 1

order_numberinteger

Örnek: 1

feedback_datestring (DataTimeFormatSQL)

Örnek: 2024-05-02 08:31:16

client_namestring

Örnek: client name

client_phone_format_idinteger

Örnek: 1

client_phone_numberstring

Örnek: 9638887321

chain_namestring

Örnek: Green Basket

spent_sumnumberzorunlu

Örnek: 135

paginationobject (Pagination)
max_countintegerzorunlu

Sayfadaki öğe sayısı

Örnek: 30

page_numberintegerzorunlu

Geçerli sayfa numarası; offset 1000'ü aşmayacak şekilde sınırlandırılmıştır

Örnek: 1

has_nextbooleanzorunlu

Sonraki sayfa var mı

Örnek: true

has_previousbooleanzorunlu

Önceki sayfa var mı

Örnek: false