Müşteri adreslerini al

GET/api/crm/v2/clients_addressesv2

operationId: clientsAddresses.default

Yetkilendirme

api-token + language + role

Sorgu parametreleri

chain_idinteger

Örnek: 1

branch_idinteger

phone_format_idinteger

Örnek: 1

phone_numberstring

Örnek: 9999999999

downloadstring

Değerler:yes

Örnek: yes

Yanıtlar

object

statusstringzorunlu

Değerler:successerror

Örnek: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object

valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

phone_format_idobject (FilterSelectInteger)

valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object

valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

phone_numberobject (FilterInput)

valuestring

Örnek: example

typestringzorunlu

Örnek: integer or string

placeholderstring

Örnek: string

modestring (FilterMode)

Değerler:force_shownvalue_required

Örnek: value_required

downloadobject (FilterButtonDownloadCsv)

İndirme düğmesi: tıklandığında download=yes iletin

valuestring

Örnek: Download

typestringzorunlu

Örnek: button_download_csv

listarray of object

idintegerzorunlu

Örnek: 1

address_namestringzorunlu

Örnek: test

typestringzorunlu

Değerler:homeworkparentschildrenfriendscountry_househotelother

Örnek: other

zip_codestring

Örnek: 680045

line_1string

Örnek: 19, Pobedy street, Khabarovsk, 680045, Russia

line_2string

Örnek: example

streetstring

Örnek: Pobedy street

housestring

Örnek: 19

buildingstring

Örnek: 1

entrance_numberstring

Örnek: 1

entrance_codestring

Örnek: 11

floorstring

Örnek: 111

apartmentstring

Örnek: 111

phone_format_idinteger

Örnek: 1

phone_numberstring

Örnek: 9999999999

client_namestring

Örnek: client name

city_namestring

Örnek: Khabarovsk

paginationobject (Pagination)

max_countintegerzorunlu

Sayfadaki öğe sayısı

Örnek: 30

page_numberintegerzorunlu

Geçerli sayfa numarası; offset 1000'ü aşmayacak şekilde sınırlandırılmıştır

Örnek: 1

has_nextbooleanzorunlu

Sonraki sayfa var mı

Örnek: true

has_previousbooleanzorunlu

Önceki sayfa var mı

Örnek: 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' => 'tr', '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": "tr", "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": "tr", "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 } } }