Skip to main content
GET
/
api
/
v1
/
public
/
coupons
/
{uid}
Buscar cupom
curl --request GET \
  --url https://api.indiqai.com/api/v1/public/coupons/{uid} \
  --header 'X-API-Key: <x-api-key>'
{
  "uid": "CPN-A1B2C3D4",
  "client_id": "550e8400-e29b-41d4-a716-446655440000",
  "client_nome": "João Silva",
  "product_id": "prd_001",
  "product_name": "Pizza Margherita",
  "points_amount": 200,
  "status": "valid",
  "used_at": null,
  "expires_at": "2026-04-20T08:15:00Z",
  "created_at": "2026-03-20T08:15:00Z"
}

​
Consultar Cupom

Retorna os detalhes de um cupom específico, incluindo status atual e dados do cliente.

​
Path Parameters

​
uid
string
required
Código único do cupom (ex: CPN-A1B2C3D4)

​
Request

curl -X GET "https://api.indiqai.com/api/v1/public/coupons/CPN-A1B2C3D4" \
  -H "X-API-Key: indiqai_sua_chave_aqui"

​
Response

{
  "uid": "CPN-A1B2C3D4",
  "client_id": "550e8400-e29b-41d4-a716-446655440000",
  "client_nome": "João Silva",
  "product_id": "prd_001",
  "product_name": "Pizza Margherita",
  "points_amount": 200,
  "status": "valid",
  "used_at": null,
  "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
​
client_nome
string
Nome do cliente
​
product_id
string
ID do produto vinculado (pode ser null)
​
product_name
string
Nome do produto (pode ser null)
​
points_amount
integer
Pontos usados no cupom
​
status
string
Status do cupom: valid, used, expired
​
used_at
string
Data de uso (ISO 8601, null se não usado)
​
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

Path Parameters

​
uid
string
required

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