API

Müştəri hesablarının siyahısını əldə et

GET/api/crm/v2/clients_accountsv2
operationId: clientsAccounts.default

Avtorizasiya

api-token + language + role

Sorğu parametrləri

page_numberinteger

Nümunə: 1

date_fromstring

Nümunə: 25/04/2024

date_tostring

Nümunə: 26/04/2024

date_first_order_fromstring

Nümunə: 26/04/2024

date_first_order_tostring

Nümunə: 26/04/2024

date_last_order_fromstring

Nümunə: 26/04/2024

date_last_order_tostring

Nümunə: 26/04/2024

chain_idinteger

Nümunə: 1

phone_format_idinteger

Nümunə: 1

phone_numberstring

Nümunə: 9999999999

count_ordersinteger

Nümunə: 2

genderstring

Dəyərlər:womanman

client_branch_profile_idinteger
client_account_idinteger
downloadstring

yes göndərin ki, seçimi CSV faylı kimi yükləyəsiniz

Dəyərlər:yes

Nümunə: yes

Cavablar

OK

object
statusstringmütləq

Dəyərlər:successerror

Nümunə: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringnull ola bilər

Nümunə: 2026-08-01 00:00:00

typestringmütləq

Nümunə: date

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

date_toobject (FilterDateTo)
valuestringnull ola bilər

Nümunə: 2026-08-31 23:59:59

typestringmütləq

Nümunə: date

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

date_first_order_fromobject (FilterDateTo)
valuestringnull ola bilər

Nümunə: 2026-08-31 23:59:59

typestringmütləq

Nümunə: date

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

date_first_order_toobject (FilterDateTo)
valuestringnull ola bilər

Nümunə: 2026-08-31 23:59:59

typestringmütləq

Nümunə: date

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

date_last_order_fromobject (FilterDateTo)
valuestringnull ola bilər

Nümunə: 2026-08-31 23:59:59

typestringmütləq

Nümunə: date

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

date_last_order_toobject (FilterDateTo)
valuestringnull ola bilər

Nümunə: 2026-08-31 23:59:59

typestringmütləq

Nümunə: date

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

date_of_birth_fromobject (FilterDateFrom)
valuestringnull ola bilər

Nümunə: 2026-08-01 00:00:00

typestringmütləq

Nümunə: date

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

date_of_birth_toobject (FilterDateTo)
valuestringnull ola bilər

Nümunə: 2026-08-31 23:59:59

typestringmütləq

Nümunə: date

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object
valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

phone_numberobject (FilterInput)
valuestring

Nümunə: example

typestringmütləq

Nümunə: integer or string

placeholderstring

Nümunə: string

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

count_ordersobject (FilterInput)
valuestring

Nümunə: example

typestringmütləq

Nümunə: integer or string

placeholderstring

Nümunə: string

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

genderobject (FilterEnum)

Filtr-siyahı — düz siyahı enum dəyərləri

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of string
modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

client_branch_profile_idobject (FilterId)
valueany

Nümunə: 0

typestringmütləq

Nümunə: integer

placeholderstring

Nümunə: integer

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

client_account_idobject (FilterId)
valueany

Nümunə: 0

typestringmütləq

Nümunə: integer

placeholderstring

Nümunə: integer

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

downloadobject (FilterButtonDownloadCsv)

Seçimi yükləmə düyməsi: basıldıqda download=yes göndərin

valuestring

Nümunə: Download

typestringmütləq

Nümunə: button_download_csv

system_automationboolean

Nümunə: true

listarray of object
idintegermütləq

Nümunə: 1

datestring (DataTimeFormatSQL) mütləq

Nümunə: 2024-05-02 08:31:16

client_account_idintegermütləq

Nümunə: 1

namestringmütləq

Nümunə: client name

phone_format_idinteger (PhoneFormatId)

Ölkə kodu: 1-🇷🇺(+7|8), 2-🇦🇿(+994|0), 3-🇧🇾(+375|80), 4-🇰🇿(+7|8), 6-🇷🇸(+381|0), 7-🇹🇷(+90|0), 8-🇺🇦(+380|0), 9-🇵🇹(+351|0), 10-🇰🇬(+996|0), 11-🇺🇸(+1), 12-🇫🇷(+33|0), 13-🇲🇩(+373|0), 15-🇪🇪(+372), 18-🇬🇪(+995), 19-🇺🇿(+998), 22-🇵🇱(+48|0), 23-🇹🇯(+992|8), 25-🇷🇴(+40|0), 44-🇨🇭(+41|0)

Nümunə: 1

phone_numberstring

Nümunə: 9999999999

genderstring

Dəyərlər:womanman

Nümunə: man

date_of_birthstring

Nümunə: 1982-01-03

date_change_date_of_birthstring

Nümunə: 2024-07-05

referral_codestring

Nümunə: example

chain_idinteger

Nümunə: 1

bonusesinteger

Nümunə: 1

count_ordersinteger

Nümunə: 3

sum_ordersnumber

Nümunə: 1000

date_last_orderstring (DataTimeFormatSQL)

Nümunə: 2024-05-02 08:31:16

date_first_orderstring (DataTimeFormatSQL)

Nümunə: 2024-05-02 08:31:16

special_offersarray of object
datestring (DataTimeFormatSQL) mütləq

Nümunə: 2024-05-02 08:31:16

special_offer_idintegermütləq

Nümunə: 1

special_offer_namestringmütləq

Nümunə: -10% on pickup

special_offer_promo_code_idinteger

Nümunə: 1

promo_codestring

Nümunə: FREE10

paginationobject (Pagination)
max_countintegermütləq

Səhifədəki elementlərin sayı

Nümunə: 30

page_numberintegermütləq

Cari səhifənin nömrəsi; offset 1000-dən çox olmamaqla məhdudlaşdırılıb

Nümunə: 1

has_nextbooleanmütləq

Növbəti səhifə varmı

Nümunə: true

has_previousbooleanmütləq

Əvvəlki səhifə mövcuddurmu

Nümunə: false