Skip to main content
POST
Criar um produto
Envie name e initial_price. O produto e seu primeiro preço são criados na mesma operação. initial_price usa os campos do preço, sem product. Requer products:write ou write. Use Idempotency-Key ao repetir a mesma operação. Veja campos, relacionamentos e eventos.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Chave única por operação lógica, de 1 a 255 caracteres ASCII imprimíveis, sem espaços. Reutilize-a somente para repetir a mesma operação.

Required string length: 1 - 255

Body

application/json
initial_price
object
required

Preço inicial criado na mesma operação do produto. Obrigatório; usa os parâmetros de preço sem product, pois o vínculo é preenchido automaticamente.

name
string
required

Nome do produto. Obrigatório e não vazio na criação.

Required string length: 1 - 10000
benefit
enum<string> | null

Tipo de conteúdo entregue: files (arquivos), courses (cursos) ou links (links). Pode ser null. Definir o tipo não vincula conteúdos ao produto.

Available options:
files,
courses,
links,
null
Maximum string length: 10000
description
string | null

Descrição do produto; null quando não informada. Envie null para limpar.

Maximum string length: 10000
metadata
object

Objeto JSON livre para referências da integração, limitado a 16 KB. Ao enviar, substitui todo o metadata anterior; use {} para limpar. Não aceita null.

status
enum<string>

Estado do produto: draft (rascunho), published (publicado) ou archived (arquivado).

Available options:
draft,
published,
archived
Maximum string length: 10000

Response

Operação concluída

id
string
required

Identificador público estável. Use o valor retornado pela API nas consultas e relacionamentos; não derive IDs de nomes.

Pattern: ^pro_[a-z0-9]{16}$
benefit
enum<string> | null
required

Tipo de conteúdo entregue: files (arquivos), courses (cursos) ou links (links). Pode ser null. Definir o tipo não vincula conteúdos ao produto.

Available options:
files,
courses,
links,
null
cover_url
string | null
required

URL pública da capa do produto; null quando ausente. Somente leitura, definida no painel.

created_at
string<date-time>
required

Data e hora da criação, em ISO 8601 com fuso horário. Somente leitura.

description
string | null
required

Descrição do produto; null quando não informada. Envie null para limpar.

metadata
object
required

Objeto JSON livre para referências da integração, limitado a 16 KB. Ao enviar, substitui todo o metadata anterior; use {} para limpar. Não aceita null.

name
string
required

Nome do produto. Obrigatório e não vazio na criação.

object
string
required

Tipo do objeto retornado. O valor é fixo para este recurso.

Allowed value: "product"
prices
string[]
required

IDs dos preços vinculados, ordenados por criação e ID. Consulte cada preço em /v1/prices/{id}. Somente leitura.

Pattern: ^prc_[a-z0-9]{16}$
status
enum<string>
required

Estado do produto: draft (rascunho), published (publicado) ou archived (arquivado).

Available options:
draft,
published,
archived
updated_at
string<date-time>
required

Data e hora da última alteração, em ISO 8601 com fuso horário. Somente leitura.