Pular para o conteúdo principal
POST
Criar um produto

Autorizações

Authorization
string
header
obrigatório

Chave de API sk_vl_... criada no painel em Desenvolvedores → Chaves de API.

Corpo

application/json
name
string
obrigatório

Nome (até 120).

Maximum string length: 120
price
obrigatório

Preço. Em reais, com até 2 casas e ponto decimal (ex.: "149.90"). Mínimo 0.01.

Pattern: ^\d{1,9}(\.\d{1,2})?$
Exemplo:

"149.90"

description
string

Descrição (até 2000).

Maximum string length: 2000
type
enum<string>
padrão:physical

Tipo.

Opções disponíveis:
physical,
digital,
service
status
enum<string>
padrão:active

Status.

Opções disponíveis:
draft,
active,
archived
images
string<uri>[]

Até 8 URLs HTTPS.

Maximum array length: 8
external_reference
string

O seu identificador (SKU). Único por negócio.

Maximum string length: 100
statement_description
string

Texto que o pagador vê no Pix (até 140).

Maximum string length: 140
metadata
object

Até 20 pares chave/valor em texto (chave até 40, valor até 500 caracteres). Volta igual nas respostas e nos webhooks.

Exemplo:

Resposta

Produto criado.

id
string

Id do produto.

Pattern: ^prod_[A-Za-z0-9_-]{16}$
Exemplo:

"prod_Xk2v9QeR7tLmN3bA"

object
enum<string>

Sempre product.

Opções disponíveis:
product
name
string

Nome.

description
string | null

Descrição.

type
enum<string>

Tipo.

Opções disponíveis:
physical,
digital,
service
status
enum<string>

Status.

Opções disponíveis:
draft,
active,
archived
images
string<uri>[]

URLs das imagens.

price
object
external_reference
string | null

O seu identificador (SKU).

statement_description
string | null

Texto que o pagador vê no Pix.

metadata
object

Até 20 pares chave/valor em texto (chave até 40, valor até 500 caracteres). Volta igual nas respostas e nos webhooks.

Exemplo:
created_at
string<date-time>

Criação.

updated_at
string<date-time>

Última alteração.

archived_at
string<date-time> | null

Quando foi arquivado.