Skip to main content
POST
Gerar cupom

Gerar Cupom

Gera um cupom para um cliente da empresa autenticada. O request sempre exige client_id; product_id e points_amount são opcionais.

Comportamento atual

  • a rota aceita X-Idempotency-Key para retry seguro
  • quando product_id é enviado, o produto precisa pertencer à empresa e estar ativo
  • o response model atual retorna uid, status, product_name, valor, expires_at e created_at
  • na resposta imediata de criação, product_name pode vir null; para consultar o nome enriquecido do produto, use a rota de busca do cupom
  • o status atual retornado pelo backend é serializado como ativo
  • no uso esperado, envie points_amount ou product_id

Exemplo de resposta

Exemplo de request com idempotência

Status comuns

  • 201 cupom criado com sucesso
  • 400 falha de geração ou recurso inválido para a empresa
  • 401 API Key inválida ou revogada
  • 403 plano sem api_access
  • 422 header ou body inválidos
  • 429 limite global da API pública excedido

Headers

X-Idempotency-Key
string | null
X-API-Key
string
required

Chave de API

Body

application/json

Gerar cupom para cliente.

client_id
string
required

ID do cliente (usuario_id)

points_amount
integer | null

Quantidade de pontos (cupom de pontos)

Required range: x >= 1
product_id
string | null

ID do produto (cupom de produto)

Response

Successful Response

Dados de um cupom.

status
string
required
uid
string
required
created_at
string<date-time> | null
expires_at
string<date-time> | null
product_name
string | null
valor
number | null