API

Mijozlarning manzillarini olish

GET/api/crm/v2/clients_addressesv2
operationId: clientsAddresses.default

Avtorizatsiya

api-token + language + role

So‘rov parametrlari

chain_idinteger

Misol: 1

branch_idinteger
phone_format_idinteger

Misol: 1

phone_numberstring

Misol: 9999999999

downloadstring

Qiymatlar:yes

Misol: yes

Javoblar

OK

object
statusstringmajburiy

Qiymatlar:successerror

Misol: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Misol: 8920

typestringmajburiy

Misol: select

optionarray of object
valueintegermajburiy

Misol: 8920

namestringmajburiy

Misol: Green Basket | Kaliningrad

modestring (FilterMode)

Interfeys filtrni qanday ishlashini belgilaydi; oddiy filtrda mode mavjud emas. force_shown — doim ko‘rsatiladi, yashirib bo‘lmaydi. value_required — bo‘limga kirish nuqtasi: doim ko‘rsatiladi, bo‘sh qiymatga ega emas (qiymat tanlanmaguncha ro‘yxat bo‘sh; “barchasi” varianti yo‘q), umumiy tozalash uni tozalamaydi.

Qiymatlar:force_shownvalue_required

Misol: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Misol: 8920

typestringmajburiy

Misol: select

optionarray of object
valueintegermajburiy

Misol: 8920

namestringmajburiy

Misol: Green Basket | Kaliningrad

modestring (FilterMode)

Interfeys filtrni qanday ishlashini belgilaydi; oddiy filtrda mode mavjud emas. force_shown — doim ko‘rsatiladi, yashirib bo‘lmaydi. value_required — bo‘limga kirish nuqtasi: doim ko‘rsatiladi, bo‘sh qiymatga ega emas (qiymat tanlanmaguncha ro‘yxat bo‘sh; “barchasi” varianti yo‘q), umumiy tozalash uni tozalamaydi.

Qiymatlar:force_shownvalue_required

Misol: value_required

phone_numberobject (FilterInput)
valuestring

Misol: example

typestringmajburiy

Misol: integer or string

placeholderstring

Misol: string

modestring (FilterMode)

Interfeys filtrni qanday ishlashini belgilaydi; oddiy filtrda mode mavjud emas. force_shown — doim ko‘rsatiladi, yashirib bo‘lmaydi. value_required — bo‘limga kirish nuqtasi: doim ko‘rsatiladi, bo‘sh qiymatga ega emas (qiymat tanlanmaguncha ro‘yxat bo‘sh; “barchasi” varianti yo‘q), umumiy tozalash uni tozalamaydi.

Qiymatlar:force_shownvalue_required

Misol: value_required

downloadobject (FilterButtonDownloadCsv)

Tanlab olingan ma'lumotlarni yuklab olish tugmasi: bosilganda download=yes ni yuboring

valuestring

Misol: Download

typestringmajburiy

Misol: button_download_csv

listarray of object
idintegermajburiy

Misol: 1

address_namestringmajburiy

Misol: test

typestringmajburiy

Qiymatlar:homeworkparentschildrenfriendscountry_househotelother

Misol: other

zip_codestring

Misol: 680045

line_1string

Misol: 19, Pobedy street, Khabarovsk, 680045, Russia

line_2string

Misol: example

streetstring

Misol: Pobedy street

housestring

Misol: 19

buildingstring

Misol: 1

entrance_numberstring

Misol: 1

entrance_codestring

Misol: 11

floorstring

Misol: 111

apartmentstring

Misol: 111

phone_format_idinteger

Misol: 1

phone_numberstring

Misol: 9999999999

client_namestring

Misol: client name

city_namestring

Misol: Khabarovsk

paginationobject (Pagination)
max_countintegermajburiy

Sahifadagi elementlar soni

Misol: 30

page_numberintegermajburiy

Joriy sahifa raqami; siljish 1000 dan oshmasligi uchun cheklangan

Misol: 1

has_nextbooleanmajburiy

Keyingi sahifa mavjudmi

Misol: true

has_previousbooleanmajburiy

Oldingi sahifa mavjudmi

Misol: false