API

Obter diretórios para promoções

GET/api/crm/v2/special_offers_list.fieldsv2
operationId: specialOffersList.fields

Autorização

api-token + language + role

Parâmetros de consulta

branch_idinteger

Filial no qual a solicitação é executada. Parceiros com múltiplos filiais devem fornecê-lo, caso contrário, a solicitação resultará em erro. Para parceiros com um único filial, o servidor o define automaticamente.

Exemplo: 8778

Respostas

OK

object
statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject
operating_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

hide_for_districts_idsobject (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

hide_for_pickups_idsobject (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

platformobject (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

typeobject (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

actions_itemsobject (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

conditions_itemsobject (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

actions_categoriesobject (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

conditions_categoriesobject (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

delivery_methodobject (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