Отримати довідники для товарів

GET/api/crm/v2/items.fieldsv2

operationId: items.fields

Авторизація

api-token + language + role

Параметри запиту

branch_idintegerобов’язковий

Приклад: 8785

Відповіді

object

statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject

categoriesarray of object

Довідник для вибору категорії: назва рядком мовою оригіналу мережі

idintegerобов’язковий

Приклад: 3389120

namestringобов’язковий

Приклад: Пицца

parent_idinteger

Приклад: 3389120

sortintegerобов’язковий

Приклад: -1714152061

labelsarray of object

Довідник лейблів: назва рядком вихідною мовою мережі

idintegerобов’язковий

Приклад: 7361

namestringобов’язковий

Приклад: Новинка

text_colorstringобов’язковий

Приклад: FFFFFF

background_colorstringобов’язковий

Приклад: C62828

sortintegerобов’язковий

Приклад: -1714152061

chain_main_langstring

Код основної мови мережі або мова зони, якщо у мережі немає мов

Приклад: ru

zone_langstring

Мова зони

Приклад: ru

auto_translations_enabledboolean

Мережа перекладає каталог автоматично: порожні переклади заповнюються за розкладом з вихідної мови

Приклад: true

modifiers_groupsobject (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

districtsobject (FilterSelectInteger)

valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object

valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

pickupsobject (FilterSelectInteger)

valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object

valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

measuresobject (FilterSelectInteger)

valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object

valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

typeobject (FilterEnum)

Фільтр-перерахування — плоский список значень перерахування

valuestring

Приклад: example

typestringобов’язковий

Приклад: select

optionarray of string

modestring (FilterMode)

Значення:force_shownvalue_required

Приклад: value_required

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

const response = await fetch("https://foodsoul.ru/api/crm/v2/items.fields?branch_id=8785", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "uk", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/items.fields?branch_id=8785", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "uk", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "categories": [ { "id": 3389120, "name": "Пицца", "parent_id": 3389120, "sort": -1714152061 } ], "labels": [ { "id": 7361, "name": "Новинка", "text_color": "FFFFFF", "background_color": "C62828", "sort": -1714152061 } ], "chain_main_lang": "ru", "zone_lang": "ru", "auto_translations_enabled": true, "modifiers_groups": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "districts": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "pickups": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "measures": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "type": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" } } }