Získat seznam skupin modifikátorů

GET/api/crm/v2/modifiers_groupsv2

operationId: modifiersGroups.default

Vrací seznam skupin modifikátorů seřazený podle sort.

Autorizace

api-token + language + role

Parametry dotazu

branch_idintegerpovinné

Příklad: 1

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

listarray of object

idintegerpovinné

Příklad: 1

sortintegerpovinné

Příklad: 0

publishedbooleanpovinné

Příklad: true

nameobject (TranslationField) povinné

Překládané pole katalogu; stejná struktura v odpovědi i v požadavku.
Při vytváření zůstane každý jazyk sítě, který není v translations, prázdný a zařadí se do fronty na AI překlad.
Při úpravě se zapisují pouze jazyky z translations: jazyk, který není v objektu, si ponechá původní hodnotu, pokud se originál nezměnil; prázdná hodnota vymaže překlad a zařadí jej do fronty na AI překlad.
Změna originálu vymaže překlady, které přišly beze změny — již neodpovídají originálu; překlad, který je předán s jinou hodnotou, se uloží jako ruční úprava. Takové vymazání probíhá pouze tehdy, pokud má síť zapnutý automatický překlad.
Hodnota v nepublikovaném jazyce je odmítnuta; hodnota v jazyce mimo sadu jazyků sítě je ignorována.

defaultstring

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

Příklad: ru

translationsobjectpovinné

Hodnota podle kódu jazyka; pokud překlad chybí — klíč není

Hodnoty slovníku

string

typestring (ModifiersGroupsType) povinné

Typ výběru: libovolný počet modifikátorů v libovolném množství, libovolný počet modifikátorů po jednom, jeden modifikátor v libovolném množství, jeden modifikátor v jednom exempláři

Hodnoty:all_unlimitedall_oneone_unlimitedone_one

Příklad: all_unlimited

minimumintegerpovinné

Příklad: 0

maximumintegerpovinné

Příklad: 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' => 'cs', '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": "cs", "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": "cs", "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 } ] } }