Obter a lista de grupos de modificadores

GET/api/crm/v2/modifiers_groupsv2

operationId: modifiersGroups.default

Retorna uma lista de grupos de modificadores, ordenada por sort.

Autorização

api-token + language + role

Parâmetros de consulta

branch_idintegerobrigatório

Exemplo: 1

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

listarray of object

idintegerobrigatório

Exemplo: 1

sortintegerobrigatório

Exemplo: 0

publishedbooleanobrigatório

Exemplo: true

nameobject (TranslationField) obrigatório

Campo traduzível do catálogo; mesma estrutura na resposta e na solicitação.
Ao criar, cada idioma da rede que não estiver em translations permanece vazio e é colocado na fila para tradução por IA.
Ao atualizar, apenas os idiomas presentes em translations são gravados: um idioma ausente no objeto mantém o valor anterior, se o original não foi alterado; um valor vazio limpa a tradução e a coloca na fila para tradução por IA.
Alterar o original limpa as traduções que não foram modificadas — elas não correspondem mais ao original; uma tradução enviada com outro valor é salva como edição manual. Essa limpeza ocorre apenas enquanto a tradução automática estiver ativada na rede.
Um valor em um idioma não publicado é rejeitado; um valor em um idioma fora do conjunto de idiomas da rede é ignorado.

defaultstring

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

Exemplo: ru

translationsobjectobrigatório

Valor pelo código do idioma; sem tradução — sem chave

Valores do dicionário

string

typestring (ModifiersGroupsType) obrigatório

Tipo de seleção: qualquer número de modificadores em qualquer quantidade, qualquer número de modificadores em uma unidade cada, um modificador em qualquer quantidade, um modificador em uma unidade

Valores:all_unlimitedall_oneone_unlimitedone_one

Exemplo: all_unlimited

minimumintegerobrigatório

Exemplo: 0

maximumintegerobrigatório

Exemplo: 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' => 'pt', '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": "pt", "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": "pt", "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 } ] } }