Получить адреса клиентов

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

Ответы

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)

Значения:force_shownvalue_required

Пример: value_required

phone_numberobject (FilterInput)

valuestring

Пример: example

typestringобязательный

Пример: integer or string

placeholderstring

Пример: string

modestring (FilterMode)

Значения: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