API

Obter diretórios para filiais

GET/api/crm/v2/branches.fieldsv2
operationId: branches.fields

Retorna diretórios para o formulário de filial. Os parâmetros chain_id e city_id são obrigatórios.

Autorização

api-token + language + role

Parâmetros de consulta

chain_idintegerobrigatório

Exemplo: 7158

city_idintegerobrigatório

Exemplo: 7158

Respostas

OK

object
statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

Para criar — city_id (é necessário o parâmetro city_id), para alterar — city (sem o parâmetro city_id)

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

round_costs_modeobject (FilterEnum)

Filtro de enumeração — lista plana de valores de enum

valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of string
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

service_nameobject (FilterEnum)

Filtro de enumeração — lista plana de valores de enum

valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of string
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