GET /api/v1/coupons: Listar Todos os Cupons da Loja

Use este endpoint para recuperar todos os cupons de desconto cadastrados na sua loja. A resposta inclui informações completas de cada cupom, como código, tipo de desconto, valor, quantidade de usos já realizados, limite máximo de usos e data de expiração.

Método

GET /api/v1/coupons — Requer autenticação.

Exemplo de Requisição

curl -X GET 'https://api.bukiopay.com/api/v1/coupons' \
  --header 'Authorization: Bearer sk_live_sua_api_key'

Resposta

{
  "coupons": [
    {
      "id": "cpn_123",
      "code": "DESCONTO10",
      "type": "percentage",
      "value": 10,
      "maxUses": 100,
      "usedCount": 25,
      "active": true,
      "expiresAt": "2026-12-31T23:59:59.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Campos da Resposta

array

Lista de cupons de desconto da loja autenticada.

Show Propriedades de cada cupom

string

Identificador único do cupom.

string

Código do cupom que o cliente insere no checkout (ex: DESCONTO10).

string

Tipo do desconto. Os valores possíveis são:

percentage — desconto em porcentagem sobre o valor total do pedido.
fixed — desconto de valor fixo em reais (R$).

number

Valor do desconto. Para percentage, representa a porcentagem (ex: 10 = 10%). Para fixed, representa o valor em reais (ex: 15 = R$ 15,00).

number

Número máximo de vezes que o cupom pode ser utilizado. null indica sem limite.

number

Quantidade de vezes que o cupom já foi utilizado.

boolean

Indica se o cupom está ativo e disponível para uso.

string

Data e hora de expiração do cupom no formato ISO 8601. null indica sem data de expiração.

string

Data e hora de criação do cupom no formato ISO 8601.

O campo type define como o desconto é calculado: percentage aplica uma porcentagem sobre o total do pedido, enquanto fixed subtrai um valor fixo em reais. Use o endpoint de validação de cupom para calcular o desconto real antes de aplicá-lo ao checkout.

Introdução à API

Cobranças PIX

Saques

Webhooks

Pedidos

Produtos

Categorias

Cupons

Loja

GET /api/v1/coupons: Listar Todos os Cupons da Loja

Método

Exemplo de Requisição

Resposta

Campos da Resposta

​Método

​Exemplo de Requisição

​Resposta

​Campos da Resposta

Método

Exemplo de Requisição

Resposta

Campos da Resposta