API

Získat adresy klientů

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

Autorizace

api-token + language + role

Parametry dotazu

chain_idinteger

Příklad: 1

branch_idinteger
phone_format_idinteger

Příklad: 1

phone_numberstring

Příklad: 9999999999

downloadstring

Hodnoty:yes

Příklad: yes

Odpovědi

OK

object
statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object
valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object
valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

phone_numberobject (FilterInput)
valuestring

Příklad: example

typestringpovinné

Příklad: integer or string

placeholderstring

Příklad: string

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

downloadobject (FilterButtonDownloadCsv)

Tlačítko pro stažení výběru: při kliknutí předejte download=yes

valuestring

Příklad: Download

typestringpovinné

Příklad: button_download_csv

listarray of object
idintegerpovinné

Příklad: 1

address_namestringpovinné

Příklad: test

typestringpovinné

Hodnoty:homeworkparentschildrenfriendscountry_househotelother

Příklad: other

zip_codestring

Příklad: 680045

line_1string

Příklad: 19, Pobedy street, Khabarovsk, 680045, Russia

line_2string

Příklad: example

streetstring

Příklad: Pobedy street

housestring

Příklad: 19

buildingstring

Příklad: 1

entrance_numberstring

Příklad: 1

entrance_codestring

Příklad: 11

floorstring

Příklad: 111

apartmentstring

Příklad: 111

phone_format_idinteger

Příklad: 1

phone_numberstring

Příklad: 9999999999

client_namestring

Příklad: client name

city_namestring

Příklad: Khabarovsk

paginationobject (Pagination)
max_countintegerpovinné

Počet položek na stránku

Příklad: 30

page_numberintegerpovinné

Číslo aktuální stránky; omezeno tak, aby posun nepřesáhl 1000

Příklad: 1

has_nextbooleanpovinné

Zda existuje další stránka

Příklad: true

has_previousbooleanpovinné

Zda existuje předchozí stránka

Příklad: false