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": "A1B2C3D4",
  "status": "ativo",
  "product_name": "Pizza Margherita",
  "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.

​
Consultar Cupom

Retorna o estado atual de um cupom da empresa autenticada.

​
Comportamento atual

  • a resposta retorna uid, status, product_name, valor, expires_at e created_at
  • o backend serializa o status atual como ativo ou usado
  • quando o cupom está vinculado a produto, product_name é enriquecido nesta rota

​
Exemplo de resposta

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

​
Status comuns

  • 200 cupom encontrado
  • 401 API Key inválida ou revogada
  • 403 plano sem api_access
  • 404 cupom inexistente ou fora da empresa autenticada
  • 422 header ou path inválidos
  • 429 limite global da API pública excedido

Headers

​
X-API-Key
string
required

Chave de API

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