API

Отримати адреси клієнтів

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

Авторизація

api-token + language + role

Параметри запиту

chain_idinteger

Приклад: 1

branch_idinteger
phone_format_idinteger

Приклад: 1

phone_numberstring

Приклад: 9999999999

downloadstring

Значення:yes

Приклад: yes

Відповіді

OK

object
statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject
filtersobject
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

downloadobject (FilterButtonDownloadCsv)

Кнопка завантаження вибірки: при натисканні передайте download=yes

valuestring

Приклад: Download

typestringобов’язковий

Приклад: button_download_csv

listarray of object
idintegerобов’язковий

Приклад: 1

address_namestringобов’язковий

Приклад: test

typestringобов’язковий

Значення:homeworkparentschildrenfriendscountry_househotelother

Приклад: other

zip_codestring

Приклад: 680045

line_1string

Приклад: 19, Pobedy street, Khabarovsk, 680045, Russia

line_2string

Приклад: example

streetstring

Приклад: Pobedy street

housestring

Приклад: 19

buildingstring

Приклад: 1

entrance_numberstring

Приклад: 1

entrance_codestring

Приклад: 11

floorstring

Приклад: 111

apartmentstring

Приклад: 111

phone_format_idinteger

Приклад: 1

phone_numberstring

Приклад: 9999999999

client_namestring

Приклад: client name

city_namestring

Приклад: Khabarovsk

paginationobject (Pagination)
max_countintegerобов’язковий

Кількість елементів на сторінці

Приклад: 30

page_numberintegerобов’язковий

Номер поточноï сторінки; обмежено так, щоб зсув не перевищував 1000

Приклад: 1

has_nextbooleanобов’язковий

Чи є наступна сторінка

Приклад: true

has_previousbooleanобов’язковий

Чи є попередня сторінка

Приклад: false