Клиенттердің мекенжайларын алу

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

Жауаптар

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)

Мәндер:force_shownvalue_required

Мысал: value_required

phone_numberobject (FilterInput)

valuestring

Мысал: example

typestringміндетті

Мысал: integer or string

placeholderstring

Мысал: string

modestring (FilterMode)

Мәндер: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

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

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/clients_addresses", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "kk", "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 } } }