Skip to main content
POST
Create Variable

Autorizações

Authorization
string
header
obrigatório

Token de API gerado no painel da CentralCart.

Corpo

application/json
name
string
obrigatório

Identificador único da variável. Apenas letras, números, - e _

description
string
obrigatório

Descrição exibida para o cliente no momento do preenchimento

type
enum<string>
obrigatório

Tipo da variável: SELECT, NUMBER, TEXT ou ROBLOX

Opções disponíveis:
SELECT,
NUMBER,
TEXT,
ROBLOX
required
boolean

Se o preenchimento é obrigatório (padrão: true para variáveis de pacote)

regex
string

Expressão regular para validação do valor informado pelo cliente

checkout_variable
boolean

Se true, a variável será exibida no checkout ao invés de no pacote

applies_to
number[]

IDs dos pacotes aos quais a variável de checkout se aplica (apenas quando checkout_variable é true)

options
object[]

Opções disponíveis (obrigatório quando o tipo é SELECT, mínimo 2 opções)

Resposta

200 - application/json

Variável criada

id
number

ID único da variável

store_id
number

ID da loja

name
string

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

description
string

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

type
enum<string>

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

Opções disponíveis:
SELECT,
NUMBER,
TEXT,
ROBLOX
required
boolean

Se o preenchimento é obrigatório

regex
string | null

Expressão regular para validação do campo

applies_to
number[] | null

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

bracket_display
string

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

display
string

Nome formatado para exibição

options
object[]

Opções disponíveis (quando o tipo é SELECT)