Skip to main content
POST
/
api
/
v1
/
public
/
coupons
/
generate
Gerar cupom
curl --request POST \
  --url https://api.indiqai.com/api/v1/public/coupons/generate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "client_id": "<string>",
  "points_amount": 2,
  "product_id": "<string>"
}
'
{
  "uid": "A1B2C3D4",
  "status": "ativo",
  "product_name": null,
  "valor": 200,
  "expires_at": "2026-04-20T08:15:00Z",
  "created_at": "2026-03-20T08:15:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.indiqai.com/llms.txt

Use this file to discover all available pages before exploring further.

​
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

curl -X POST "https://api.indiqai.com/api/v1/public/coupons/generate" \
  -H "X-API-Key: indiqai_sua_chave_aqui" \
  -H "X-Idempotency-Key: coupon-erp-2026-05-12-001" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "550e8400-e29b-41d4-a716-446655440000",
    "points_amount": 200
  }'

{
  "uid": "A1B2C3D4",
  "status": "ativo",
  "product_name": null,
  "valor": 200,
  "expires_at": "2026-04-20T08:15:00Z",
  "created_at": "2026-03-20T08:15:00Z"
}

​
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