API

Ստանալ հաճախորդների հասցեները

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

Պատասխաններ

OK

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)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ:force_shownvalue_required

Օրինակ: value_required

phone_numberobject (FilterInput)
valuestring

Օրինակ: example

typestringպարտադիր

Օրինակ: integer or string

placeholderstring

Օրինակ: string

modestring (FilterMode)

Ինչպես է ինտերֆեյսը մշակում ֆիլտրը; սովորական ֆիլտրի համար mode չկա։ force_shown — միշտ ցուցադրվում է, հնարավոր չէ թաքցնել։ value_required — բաժնի մուտքի կետն է. միշտ ցուցադրվում է, չունի դատարկ արժեք (քանի դեռ արժեքը ընտրված չէ, ցուցակը դատարկ է; «բոլորը» տարբերակ չկա), ընդհանուր մաքրելը չի մաքրում այն։.

Արժեքներ: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