Skip to main content
Cria um campo que o cliente preenche antes de pagar, por exemplo o Player ID de uma recarga de Free Fire. O campo aparece no checkout da loja e no carrinho do bot do Discord, e o valor fica gravado no pedido. Método: POST /api/v1/stores/me/custom-fields Autenticação: Obrigatória. Inclua o header Authorization: Bearer sk_live_sua_api_key. A chave precisa ter a permissão Tudo (*).
O campo costuma ser criado uma vez só. Se preferir, crie pelo painel, em Configurações › Visão geral, no card Campos extras, e use a API só para listar os campos e enviar os valores no pedido.

​
Parâmetros do corpo

​
string
required
Nome do campo exibido ao cliente, até 60 caracteres. Exemplo: Player ID.
​
string
default:"TEXT"
TEXT, NUMBER, EMAIL ou ROBLOX (nome de usuário do Roblox).
​
boolean
default:"false"
Com true, o pedido não é criado sem o valor do campo.
​
string[]
UUIDs dos produtos em que o campo aparece.
​
string[]
UUIDs das categorias: o campo aparece em todos os produtos delas.
​
boolean
default:"false"
Com true, o campo aparece em todos os produtos da loja.
​
string
Texto de exemplo dentro do campo, até 120 caracteres.
​
number
Mínimo aceito no formulário da loja (tamanho do texto ou valor do número).
​
number
Máximo aceito no formulário da loja. Não pode ser menor que min.
​
number
default:"0"
Ordem do campo no formulário, do menor para o maior.
Informe ao menos um entre products, categories ou allProducts: true. Sem nenhum deles, o campo não aparece em produto nenhum.

​
Exemplo de requisição

Campo Player ID obrigatório em um produto de recarga:

​
Resposta

Status 201 Created.
Guarde o id: é a chave do valor que o cliente informa em Criar Pedido.

​
Enviar o valor no pedido

Em POST /api/v1/orders, envie os valores em customFields, com o id do campo como chave:
Sem um campo obrigatório do produto, a API responde 400 com a mensagem O campo "Player ID" é obrigatório. e o pedido não é criado. O valor fica gravado no pedido e aparece no painel e nos detalhes da venda.

​
Erros comuns