Lista os cupons

GET/v1/coupons

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros de consulta

limitinteger
Tamanho da página (itens por página).
offsetinteger
Posição do primeiro item (a partir de 0).
sortstring
Expressão de ordenação, ex.: "-createdAt"
daterangeum de
Criados neste dia (YYYY-MM-DD) ou neste instante.
daterangegtstring (date-time)
Criados depois deste instante (exclusivo).
daterangegtestring (date-time)
Criados a partir deste instante (inclusivo).
daterangeltstring (date-time)
Criados antes deste instante (exclusivo).
daterangeltestring (date-time)
Criados até este instante (inclusivo).
idstring
Só este cupom.
namestring
Cupons cujo nome contém este texto.
codestring
Só o cupom com este código.
typestring
Só cupons deste tipo.
Valores:flatpercentage
statusstring
active (ligado) ou inactive (desligado).
Valores:activeinactive
dirstring
Ordem pela data de criação.
Valores:ascendingdescending

Respostas

200Sucesso

dataobject[]obrigatório
Os itens desta página.
+23 campos de data
- idstringobrigatório
  Identificador público (dis_/coup_…)
- codestringobrigatóriopode ser nulo
  O código que o comprador digita.
- namestringobrigatóriopode ser nulo
  Nome do cupom.
- typestringobrigatório
  flat (um valor fixo) ou percentage.
  Valores:flatpercentage
- scopestringobrigatório
  Numa assinatura: firstCharge (só a primeira cobrança) ou recurring (todo ciclo, até recurringCycles).
  Valores:firstChargerecurring
- valuenumberobrigatório
  Em percentage, o percentual (0–100); em flat, o valor em reais (decimal).
- enabledbooleanobrigatório
  Se o cupom pode ser usado.
- endDatestringobrigatóriopode ser nulo
  Até quando o cupom vale; null = sem fim.
- initDatestringobrigatóriopode ser nulo
  A partir de quando o cupom vale; null = sem início.
- createdAtstringobrigatório
  Quando o recurso foi criado (ISO 8601, UTC).
- updatedAtstringobrigatório
  Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).
- usageLimitintegerobrigatóriopode ser nulo
  Número total de usos permitidos; null ou 0 = ilimitado.
- isCumulativebooleanobrigatório
  Se pode ser combinado com outros cupons.
- maxCartItemsintegerobrigatóriopode ser nulo
  Número máximo de itens; null = sem limite.
- minCartItemsintegerobrigatóriopode ser nulo
  Número mínimo de itens; null = sem mínimo.
- maxCartAmountintegerobrigatóriopode ser nulo
  Valor máximo do carrinho (centavos); null = sem limite.
- minCartAmountintegerobrigatóriopode ser nulo
  Valor mínimo do carrinho (centavos); null = sem mínimo.
- usageQuantityintegerobrigatóriopode ser nulo
  Usos permitidos por cliente; null ou 0 = ilimitado.
- allowedItemIdsany[]obrigatóriopode ser nulo
  Ids das variantes a que o cupom se restringe; null = qualquer item.
- recurringCyclesintegerobrigatóriopode ser nulo
  Com scope=recurring: quantos ciclos ganham o desconto; null = todos os ciclos.
- redemptionsCountintegerobrigatório
  Quantas vezes o cupom foi usado (reservas e confirmados). Esgota quando usageLimit > 0 e isto chega lá.
- allowedCustomerIdsany[]obrigatóriopode ser nulo
  Ids dos clientes a que o cupom se restringe; null = qualquer cliente.
- limitOneUsePerCustomerbooleanobrigatório
  Cada cliente pode usar o cupom uma vez.
pageobjectobrigatório
Cursores de paginação da lista.
+3 campos de page
- totalintegerobrigatório
  Número total de páginas.
- offsetobjectobrigatório
  O offset para pedir a primeira, a anterior, a próxima e a última página.
  +4 campos de offset
  - lastintegerobrigatório
    Posição da última página.
  - nextintegerobrigatório
    Posição da próxima página (fica nesta quando ela é a última).
  - previntegerobrigatório
    Posição da página anterior (0 na primeira).
  - firstintegerobrigatório
    Posição da primeira página.
- currentintegerobrigatório
  Número da página atual (a primeira é 1).
limitintegerobrigatório
Tamanho da página, como pedido.
totalintegerobrigatório
Número total de itens que atendem aos filtros.
offsetintegerobrigatório
Posição do primeiro item desta página, como pedido.
hasMorebooleanobrigatório
true quando há mais itens depois desta página.

401Não autenticado (credencial ausente ou inválida)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

403Sem permissão

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

500Erro interno do servidor

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

AnteriorEmite a credencial de telemetria da sessão para o front-end do checkout PróximaCria um cupom

{ "data": [ { "id": "dis_0a1b2c3d4e5f60718293", "code": "string", "name": "Acme Ltda", "type": "flat", "scope": "firstCharge", "value": 5000, "enabled": true, "endDate": "string", "initDate": "string", "createdAt": "string", "updatedAt": "string", "usageLimit": 0, "isCumulative": true, "maxCartItems": 0, "minCartItems": 0, "maxCartAmount": 5000, "minCartAmount": 5000, "usageQuantity": 0, "allowedItemIds": [], "recurringCycles": 0, "redemptionsCount": 0, "allowedCustomerIds": [], "limitOneUsePerCustomer": true } ], "page": { "total": 5000, "offset": { "last": 0, "next": 0, "prev": 0, "first": 0 }, "current": 0 }, "limit": 0, "total": 5000, "offset": 0, "hasMore": true }