v1

latestOpenAPI 3.1.02026-07-265314114.3 KB
Variables

List Variables

Retorna a lista de variáveis (campos personalizados) da loja.

get/app/variable

Query parameters

pagenumber

Página para paginação. Se omitido, retorna todas as variáveis sem paginação

include_checkoutboolean

Se true, inclui variáveis de checkout na resposta. Por padrão, retorna apenas variáveis de pacote

Response

Lista de variáveis

idnumber

ID único da variável

store_idnumber

ID da loja

namestring

Identificador da variável (usado em comandos como {nome_variavel})

descriptionstring

Descrição da variável exibida para o cliente

type'SELECT' | 'NUMBER' | 'TEXT' | 'ROBLOX'

Tipo da variável (SELECT, NUMBER, TEXT, ROBLOX)

requiredboolean

Se o preenchimento é obrigatório

regexstring nullable

Expressão regular para validação do campo

applies_tonumber[] nullable

IDs dos pacotes aos quais a variável de checkout se aplica

bracket_displaystring

Nome formatado para uso em comandos (ex: {nickname})

displaystring

Nome formatado para exibição