API

Obter a lista de categorias

GET/api/crm/v2/categoriesv2
operationId: categories.default

Autorização

api-token + language + role

Parâmetros de consulta

branch_idinteger

Exemplo: 1

Respostas

OK

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

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
parent_idinteger

Exemplo: 1

discount_enabledboolean

Exemplo: true

minimum_sum_enabledboolean

Exemplo: true

free_delivery_enabledboolean

Exemplo: true

sortintegerobrigatório

Exemplo: 1

publishedboolean

Exemplo: true

hide_for_districts_idsarray of integer
hide_for_pickups_idsarray of integer
date_availablestring (DataTimeFormatSQL)

Exemplo: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Exemplo: 2024-05-02 08:31:16

days_of_weekarray of integer
time_periodsarray of string