Получить список групп модификаторов

GET/api/crm/v2/modifiers_groupsv2

operationId: modifiersGroups.default

Возвращает список групп модификаторов, отсортированный по sort.

Авторизация

api-token + language + role

Параметры запроса

branch_idintegerобязательный

Пример: 1

Ответы

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

listarray of object

idintegerобязательный

Пример: 1

sortintegerобязательный

Пример: 0

publishedbooleanобязательный

Пример: true

nameobject (TranslationField) обязательный

Переводимое поле каталога; одинаковой структуры в ответе и в запросе. При создании каждый язык сети, которого нет в translations, остаётся пустым и ставится в очередь на AI-перевод. При изменении записываются только языки из translations: язык, которого нет в объекте, сохраняет прежнее значение, если оригинал не изменился; пустое значение очищает перевод и ставит его в очередь на AI-перевод. Изменение оригинала очищает переводы, пришедшие без изменений, — они ему больше не соответствуют; перевод, переданный с другим значением, сохраняется как ручная правка. Такая очистка происходит, только пока у сети включён автоматический перевод. Значение на неопубликованном языке отклоняется; значение на языке вне набора языков сети игнорируется.

defaultstring

Код исходного языка сети; в запросе должен совпадать с настройкой сети

Пример: ru

translationsobjectобязательный

Значение по коду языка; нет перевода — нет ключа

Значения словаря

string

typestring (ModifiersGroupsType) обязательный

Тип выбора: любое число модификаторов в любом количестве, любое число модификаторов по одному, один модификатор в любом количестве, один модификатор в одном экземпляре

Значения:all_unlimitedall_oneone_unlimitedone_one

Пример: all_unlimited

minimumintegerобязательный

Пример: 0

maximumintegerобязательный

Пример: 8

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

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/modifiers_groups?branch_id=1", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "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" } }, "list": [ { "id": 1, "sort": 0, "published": true, "name": { "default": "ru", "translations": { "ru": "Пицца", "en": "Pizza" } }, "type": "all_unlimited", "minimum": 0, "maximum": 8 } ] } }