Referência da API

Listar cupons

Retorna lista paginada de cupons da sua conta, ordenados por `status ASC, createdAt DESC` (ativos primeiro, depois pausados/arquivados; dentro de cada grupo, mais recentes primeiro). Cada item inclui um `_count` com o número de Offers na whitelist (`allowedOffers`) e o número de redemptions.

GET/v2/coupons

Paginação 0-indexed

page Mesmo padrão de Customers: `page=0` é a primeira página. Não `page=1`.

Autenticação

HTTP Basic Auth. Envie sua secret key no header:

Authorization: Basic {base64(secret:SUA_SECRET_KEY)}

Parâmetros

status'ACTIVE' | 'PAUSED' | 'ARCHIVED' (query)opcional

Filtra por status específico. Sem esse parâmetro, retorna todos os status (exceto deletados — veja `includeDeleted`).

Exemplo: ACTIVE

searchstring (query)opcional

Busca textual case-insensitive em `code` e `description`. O termo é convertido pra UPPERCASE antes de buscar no code.

Exemplo: verao

pagenumber (query, 0-indexed)opcional

Página, começando em 0. Padrão: 0.

Exemplo: 0

limitnumber (query)opcional

Quantidade por página. Padrão: 20. Máximo: 100.

Exemplo: 20

includeDeletedboolean (query, string)opcional

Passe `true` para incluir cupons arquivados (`deletedAt != null`).

Exemplo: false

Respostas

200

Lista paginada. Cada item tem _count com a contagem de Offers na whitelist e redemptions feitas.

JSON

{
  "result": [
    {
      "id": "cpn_a8f3d2e1-9b4c-4e5f-8a7d-2e5f6c1d4b9a",
      "code": "VERAO2026",
      "description": "Promoção de verão — 15% off",
      "discountType": "PERCENTAGE",
      "discountValue": 1500,
      "status": "ACTIVE",
      "maxUses": 500,
      "currentUses": 47,
      "validFrom": "2026-06-01T00:00:00.000Z",
      "validUntil": "2026-12-31T23:59:59.000Z",
      "minPurchaseAmount": 5000,
      "createdAt": "2026-05-26T14:32:01.923Z",
      "updatedAt": "2026-05-26T14:32:01.923Z",
      "_count": {
        "allowedOffers": 2,
        "redemptions": 47
      }
    }
  ],
  "totalCount": 12
}

Exemplos

cURL

# Lista cupons ativos
curl -X GET "https://api.pagnovo.com/v2/coupons?status=ACTIVE" \
  -H "Authorization: Basic $(echo -n 'secret:SUA_SECRET_KEY' | base64)"
 
# Busca textual
curl -X GET "https://api.pagnovo.com/v2/coupons?search=verao" \
  -H "Authorization: Basic $(echo -n 'secret:SUA_SECRET_KEY' | base64)"