API

Gauti klientų adresus

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

Autorizacija

api-token + language + role

Užklausos parametrai

chain_idinteger

Pavyzdys: 1

branch_idinteger
phone_format_idinteger

Pavyzdys: 1

phone_numberstring

Pavyzdys: 9999999999

downloadstring

Reikšmės:yes

Pavyzdys: yes

Atsakymai

OK

object
statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object
valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object
valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

phone_numberobject (FilterInput)
valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: integer or string

placeholderstring

Pavyzdys: string

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

downloadobject (FilterButtonDownloadCsv)

Atsisiuntimo mygtukas: paspaudus perduokite download=yes

valuestring

Pavyzdys: Download

typestringprivalomas

Pavyzdys: button_download_csv

listarray of object
idintegerprivalomas

Pavyzdys: 1

address_namestringprivalomas

Pavyzdys: test

typestringprivalomas

Reikšmės:homeworkparentschildrenfriendscountry_househotelother

Pavyzdys: other

zip_codestring

Pavyzdys: 680045

line_1string

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

line_2string

Pavyzdys: example

streetstring

Pavyzdys: Pobedy street

housestring

Pavyzdys: 19

buildingstring

Pavyzdys: 1

entrance_numberstring

Pavyzdys: 1

entrance_codestring

Pavyzdys: 11

floorstring

Pavyzdys: 111

apartmentstring

Pavyzdys: 111

phone_format_idinteger

Pavyzdys: 1

phone_numberstring

Pavyzdys: 9999999999

client_namestring

Pavyzdys: client name

city_namestring

Pavyzdys: Khabarovsk

paginationobject (Pagination)
max_countintegerprivalomas

Elementų skaičius puslapyje

Pavyzdys: 30

page_numberintegerprivalomas

Dabartinio puslapio numeris; apribotas taip, kad poslinkis neviršytų 1000

Pavyzdys: 1

has_nextbooleanprivalomas

Ar yra kitas puslapis

Pavyzdys: true

has_previousbooleanprivalomas

Ar yra ankstesnis puslapis

Pavyzdys: false