API

Pobierz adresy klientów

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

Autoryzacja

api-token + language + role

Parametry zapytania

chain_idinteger

Przykład: 1

branch_idinteger
phone_format_idinteger

Przykład: 1

phone_numberstring

Przykład: 9999999999

downloadstring

Wartości:yes

Przykład: yes

Odpowiedzi

OK

object
statusstringwymagane

Wartości:successerror

Przykład: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object
valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object
valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

phone_numberobject (FilterInput)
valuestring

Przykład: example

typestringwymagane

Przykład: integer or string

placeholderstring

Przykład: string

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

downloadobject (FilterButtonDownloadCsv)

Przycisk pobierania wyników: po kliknięciu przekaż download=yes

valuestring

Przykład: Download

typestringwymagane

Przykład: button_download_csv

listarray of object
idintegerwymagane

Przykład: 1

address_namestringwymagane

Przykład: test

typestringwymagane

Wartości:homeworkparentschildrenfriendscountry_househotelother

Przykład: other

zip_codestring

Przykład: 680045

line_1string

Przykład: 19, Pobedy street, Khabarovsk, 680045, Russia

line_2string

Przykład: example

streetstring

Przykład: Pobedy street

housestring

Przykład: 19

buildingstring

Przykład: 1

entrance_numberstring

Przykład: 1

entrance_codestring

Przykład: 11

floorstring

Przykład: 111

apartmentstring

Przykład: 111

phone_format_idinteger

Przykład: 1

phone_numberstring

Przykład: 9999999999

client_namestring

Przykład: client name

city_namestring

Przykład: Khabarovsk

paginationobject (Pagination)
max_countintegerwymagane

Liczba elementów na stronie

Przykład: 30

page_numberintegerwymagane

Numer bieżącej strony; ograniczony tak, aby przesunięcie nie przekraczało 1000

Przykład: 1

has_nextbooleanwymagane

Czy istnieje następna strona

Przykład: true

has_previousbooleanwymagane

Czy istnieje poprzednia strona

Przykład: false