Skip to main content
POST
/
v1
/
app
/
variable
Create Variable
curl --request POST \
  --url https://api.centralcart.com.br/v1/app/variable \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "type": "<string>",
  "required": true,
  "regex": "<string>",
  "checkout_variable": true,
  "applies_to": [
    123
  ],
  "options": [
    {
      "options[].name": "<string>",
      "options[].value": "<string>",
      "options[].price": 123
    }
  ]
}
'
{
  "id": 1,
  "store_id": 1,
  "name": "cor",
  "description": "Escolha a cor do VIP",
  "type": "SELECT",
  "required": true,
  "regex": null,
  "applies_to": null,
  "bracket_display": "{cor}",
  "display": "Cor",
  "created_at": "2024-01-31T16:03:28.000-03:00",
  "updated_at": "2024-01-31T16:03:28.000-03:00",
  "options": [
    {
      "id": 1,
      "name": "Vermelho",
      "value": "red",
      "price": null
    },
    {
      "id": 2,
      "name": "Azul",
      "value": "blue",
      "price": 5
    }
  ]
}
​
name
string
required
Identificador único da variável. Apenas letras, números, - e _
​
description
string
required
Descrição exibida para o cliente no momento do preenchimento
​
type
string
required
Tipo da variável: SELECT, NUMBER, TEXT ou 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
array
Opções disponíveis (obrigatório quando o tipo é SELECT, mínimo 2 opções)
{
  "id": 1,
  "store_id": 1,
  "name": "cor",
  "description": "Escolha a cor do VIP",
  "type": "SELECT",
  "required": true,
  "regex": null,
  "applies_to": null,
  "bracket_display": "{cor}",
  "display": "Cor",
  "created_at": "2024-01-31T16:03:28.000-03:00",
  "updated_at": "2024-01-31T16:03:28.000-03:00",
  "options": [
    {
      "id": 1,
      "name": "Vermelho",
      "value": "red",
      "price": null
    },
    {
      "id": 2,
      "name": "Azul",
      "value": "blue",
      "price": 5
    }
  ]
}