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": "CPN-A1B2C3D4",
  "client_id": "550e8400-e29b-41d4-a716-446655440000",
  "product_id": "prd_001",
  "points_amount": 200,
  "status": "valid",
  "expires_at": "2026-04-20T08:15:00Z",
  "created_at": "2026-03-20T08:15:00Z"
}

​
Gerar Cupom

Gera um novo cupom de resgate para um cliente. Opcionalmente vinculado a um produto específico ou valor em pontos.

​
Body Parameters

​
client_id
string
required
ID do cliente que receberá o cupom (UUID)
​
product_id
string
ID do produto vinculado ao cupom (UUID). Se omitido, gera cupom genérico.
​
points_amount
integer
Quantidade de pontos a descontar. Se omitido, usa o custo padrão do produto.

​
Request

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

​
Response

{
  "uid": "CPN-A1B2C3D4",
  "client_id": "550e8400-e29b-41d4-a716-446655440000",
  "product_id": "prd_001",
  "points_amount": 200,
  "status": "valid",
  "expires_at": "2026-04-20T08:15:00Z",
  "created_at": "2026-03-20T08:15:00Z"
}

​
Campos da Resposta

​
uid
string
Código único do cupom
​
client_id
string
ID do cliente vinculado
​
product_id
string
ID do produto vinculado (pode ser null)
​
points_amount
integer
Pontos descontados do cliente
​
status
string
Status do cupom: valid, used, expired
​
expires_at
string
Data de expiração (ISO 8601)
​
created_at
string
Data de criação (ISO 8601)

Headers

​
X-API-Key
string
required

Chave de API da empresa

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