Skip to main content
POST
Criar um cupom
Cria um cupom de desconto que seus clientes aplicam no checkout.

Obrigatórios

code (único na sua loja), discountKind (PERCENTAGE ou FIXED) e discount (valor do desconto).
PERCENTAGE desconta uma porcentagem do total. FIXED desconta um valor fixo em centavos. Exemplo — 10% de desconto ilimitado:
Exemplo — R$ 20,00 fixo, válido 50 vezes:
-1 significa usos ilimitados. Qualquer valor positivo limita o número total de resgates.

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Body

application/json

Os dados do seu cupom.

code
string
required

Identificador único do cupom

Example:

"DEYVIN_20"

discountKind
enum<string>
required

Tipo de desconto aplicado, porcentagem ou fixo

Available options:
PERCENTAGE,
FIXED
discount
number
required

Valor de desconto a ser aplicado

notes
string

Descrição sbre o cupom

Example:

"Cupom de desconto pro meu público"

maxRedeems
number
default:-1

Quantidade de vezes em que o cupom pode ser resgatado. -1 Significa que esse cupom pode ser resgatado sem limites

Example:

10

metadata
object

Objeto chave valor para metadados do cupom

Response

Cupom criado com sucesso.

data
object

Os dados do seu cupom.

error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true