API

Obțineți adresele clienților

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

Autorizare

api-token + language + role

Parametri de interogare

chain_idinteger

Exemplu: 1

branch_idinteger
phone_format_idinteger

Exemplu: 1

phone_numberstring

Exemplu: 9999999999

downloadstring

Valori:yes

Exemplu: yes

Răspunsuri

OK

object
statusstringobligatoriu

Valori:successerror

Exemplu: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object
valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object
valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

phone_numberobject (FilterInput)
valuestring

Exemplu: example

typestringobligatoriu

Exemplu: integer or string

placeholderstring

Exemplu: string

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

downloadobject (FilterButtonDownloadCsv)

Buton de descărcare a selecției: la apăsare, transmiteți download=yes

valuestring

Exemplu: Download

typestringobligatoriu

Exemplu: button_download_csv

listarray of object
idintegerobligatoriu

Exemplu: 1

address_namestringobligatoriu

Exemplu: test

typestringobligatoriu

Valori:homeworkparentschildrenfriendscountry_househotelother

Exemplu: other

zip_codestring

Exemplu: 680045

line_1string

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

line_2string

Exemplu: example

streetstring

Exemplu: Pobedy street

housestring

Exemplu: 19

buildingstring

Exemplu: 1

entrance_numberstring

Exemplu: 1

entrance_codestring

Exemplu: 11

floorstring

Exemplu: 111

apartmentstring

Exemplu: 111

phone_format_idinteger

Exemplu: 1

phone_numberstring

Exemplu: 9999999999

client_namestring

Exemplu: client name

city_namestring

Exemplu: Khabarovsk

paginationobject (Pagination)
max_countintegerobligatoriu

Numărul de elemente pe pagină

Exemplu: 30

page_numberintegerobligatoriu

Numărul paginii curente; limitat astfel încât offset-ul să nu depășească 1000

Exemplu: 1

has_nextbooleanobligatoriu

Există o pagină următoare

Exemplu: true

has_previousbooleanobligatoriu

Există o pagină anterioară

Exemplu: false