Müştəri ünvanlarını əldə et

GET/api/crm/v2/clients_addressesv2

operationId: clientsAddresses.default

Avtorizasiya

api-token + language + role

Sorğu parametrləri

chain_idinteger

Nümunə: 1

branch_idinteger

phone_format_idinteger

Nümunə: 1

phone_numberstring

Nümunə: 9999999999

downloadstring

Dəyərlər:yes

Nümunə: yes

Cavablar

object

statusstringmütləq

Dəyərlər:successerror

Nümunə: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object

valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

phone_format_idobject (FilterSelectInteger)

valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object

valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

phone_numberobject (FilterInput)

valuestring

Nümunə: example

typestringmütləq

Nümunə: integer or string

placeholderstring

Nümunə: string

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

downloadobject (FilterButtonDownloadCsv)

Seçimi yükləmə düyməsi: basıldıqda download=yes göndərin

valuestring

Nümunə: Download

typestringmütləq

Nümunə: button_download_csv

listarray of object

idintegermütləq

Nümunə: 1

address_namestringmütləq

Nümunə: test

typestringmütləq

Dəyərlər:homeworkparentschildrenfriendscountry_househotelother

Nümunə: other

zip_codestring

Nümunə: 680045

line_1string

Nümunə: 19, Pobedy street, Khabarovsk, 680045, Russia

line_2string

Nümunə: example

streetstring

Nümunə: Pobedy street

housestring

Nümunə: 19

buildingstring

Nümunə: 1

entrance_numberstring

Nümunə: 1

entrance_codestring

Nümunə: 11

floorstring

Nümunə: 111

apartmentstring

Nümunə: 111

phone_format_idinteger

Nümunə: 1

phone_numberstring

Nümunə: 9999999999

client_namestring

Nümunə: client name

city_namestring

Nümunə: Khabarovsk

paginationobject (Pagination)

max_countintegermütləq

Səhifədəki elementlərin sayı

Nümunə: 30

page_numberintegermütləq

Cari səhifənin nömrəsi; offset 1000-dən çox olmamaqla məhdudlaşdırılıb

Nümunə: 1

has_nextbooleanmütləq

Növbəti səhifə varmı

Nümunə: true

has_previousbooleanmütləq

Əvvəlki səhifə mövcuddurmu

Nümunə: false

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/clients_addresses', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'az', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/clients_addresses", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "az", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/clients_addresses", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "az", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "phone_format_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "phone_number": { "value": "example", "type": "integer or string", "placeholder": "string", "mode": "value_required" }, "download": { "value": "Download", "type": "button_download_csv" } }, "list": [ { "id": 1, "address_name": "test", "type": "other", "zip_code": "680045", "line_1": "19, Pobedy street, Khabarovsk, 680045, Russia", "line_2": "example", "street": "Pobedy street", "house": "19", "building": "1", "entrance_number": "1", "entrance_code": "11", "floor": "111", "apartment": "111", "phone_format_id": 1, "phone_number": "9999999999", "client_name": "client name", "city_name": "Khabarovsk" } ], "pagination": { "max_count": 30, "page_number": 1, "has_next": true, "has_previous": false } } }