Filiallar üçün istinad kitabçalarını əldə et

GET/api/crm/v2/branches.fieldsv2

operationId: branches.fields

Filial forması üçün məlumat kitabçalarını qaytarır. chain_id və city_id parametrləri mütləqdir.

Avtorizasiya

api-token + language + role

Sorğu parametrləri

chain_idintegermütləq

Nümunə: 7158

city_idintegermütləq

Nümunə: 7158

Cavablar

object

statusstringmütləq

Dəyərlər:successerror

Nümunə: success

dataobject

Yaratmaq üçün — city_id (city_id parametri tələb olunur), dəyişdirmək üçün — city (city_id parametri olmadan)

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

round_costs_modeobject (FilterEnum)

Filtr-siyahı — düz siyahı enum dəyərləri

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of string

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

service_nameobject (FilterEnum)

Filtr-siyahı — düz siyahı enum dəyərləri

valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of string

modestring (FilterMode)

Dəyərlər:force_shownvalue_required

Nümunə: value_required

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/branches.fields?chain_id=7158&city_id=7158", { 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.pro/api/crm/v2/branches.fields?chain_id=7158&city_id=7158", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "az", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "round_costs_mode": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" }, "service_name": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" } } }