API

Mendapatkan alamat klien

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

Otorisasi

api-token + language + role

Parameter permintaan

chain_idinteger

Contoh: 1

branch_idinteger
phone_format_idinteger

Contoh: 1

phone_numberstring

Contoh: 9999999999

downloadstring

Nilai:yes

Contoh: yes

Tanggapan

OK

object
statusstringwajib

Nilai:successerror

Contoh: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object
valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object
valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

phone_numberobject (FilterInput)
valuestring

Contoh: example

typestringwajib

Contoh: integer or string

placeholderstring

Contoh: string

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

downloadobject (FilterButtonDownloadCsv)

Tombol unduh hasil filter: saat ditekan, kirimkan download=yes

valuestring

Contoh: Download

typestringwajib

Contoh: button_download_csv

listarray of object
idintegerwajib

Contoh: 1

address_namestringwajib

Contoh: test

typestringwajib

Nilai:homeworkparentschildrenfriendscountry_househotelother

Contoh: other

zip_codestring

Contoh: 680045

line_1string

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

line_2string

Contoh: example

streetstring

Contoh: Pobedy street

housestring

Contoh: 19

buildingstring

Contoh: 1

entrance_numberstring

Contoh: 1

entrance_codestring

Contoh: 11

floorstring

Contoh: 111

apartmentstring

Contoh: 111

phone_format_idinteger

Contoh: 1

phone_numberstring

Contoh: 9999999999

client_namestring

Contoh: client name

city_namestring

Contoh: Khabarovsk

paginationobject (Pagination)
max_countintegerwajib

Jumlah item per halaman

Contoh: 30

page_numberintegerwajib

Nomor halaman saat ini; dibatasi agar offset tidak melebihi 1000

Contoh: 1

has_nextbooleanwajib

Apakah ada halaman berikutnya

Contoh: true

has_previousbooleanwajib

Apakah ada halaman sebelumnya

Contoh: false