Cupom
Referência
Crie cupons de desconto para seus clientes usarem uma ou várias vezes
Os cupons de desconto permitem que você ofereça reduções de preço aos seus clientes de forma controlada e estratégica. Você pode criar cupons com desconto percentual ou valor fixo, definir limites de uso e acompanhar quantas vezes foram utilizados.
Código único do cupom que seus clientes irão utilizar para aplicar o desconto
Descrição interna do cupom para sua organização e controle
Limite de vezes que o cupom pode ser utilizado. Use
Contador de quantas vezes o cupom já foi utilizado pelos clientes
Tipo de desconto aplicado pelo cupom
Valor do desconto. Para
Status atual do cupom
Indica se o cupom foi criado em ambiente de desenvolvimento (
Objeto para armazenar informações adicionais sobre o cupom, como campanha, categoria ou outros dados relevantes para sua organização
Data e hora de criação do cupom
Data e hora da última atualização do cupom
Estrutura
Um cupom é representado em nossa API pela seguinte estrutura:Atributos:
id:
id:
id : string. Código único do cupom que seus clientes irão utilizar para aplicar o desconto
notes:
notes:
notes : string. Descrição interna do cupom para sua organização e controle
maxRedeems:
maxRedeems:
maxRedeems : number. Limite de vezes que o cupom pode ser utilizado. Use
-1 para cupons ilimitados ou um número específico para limitar o usoredeemsCount:
redeemsCount:
redeemsCount : number. Contador de quantas vezes o cupom já foi utilizado pelos clientes
discountKind:
discountKind:
discountKind : string. Tipo de desconto aplicado pelo cupom
| Tipo | Descrição |
|---|---|
PERCENTAGE | Desconto percentual (ex: 10% de desconto) |
FIXED | Valor fixo (ex: R$ 5,00 de desconto) |
discount:
discount:
discount : number. Valor do desconto. Para
PERCENTAGE use números de 1-100 (ex: 10 = 10%). Para FIXED use o valor em centavos (ex: 500 = R$ 5,00)status:
status:
status : string. Status atual do cupom
| Status | Descrição |
|---|---|
ACTIVE | O cupom está ativo e pode ser utilizado pelos clientes |
DELETED | O cupom foi removido e não pode mais ser usado |
DISABLED | O cupom foi desabilitado ou atingiu o limite máximo de usos |
devMode:
devMode:
devMode : boolean. Indica se o cupom foi criado em ambiente de desenvolvimento (
true) ou produção (false)metadata:
metadata:
metadata : object. Objeto para armazenar informações adicionais sobre o cupom, como campanha, categoria ou outros dados relevantes para sua organização
createdAt:
createdAt:
createdAt : date-time. Data e hora de criação do cupom
updatedAt:
updatedAt:
updatedAt : date-time. Data e hora da última atualização do cupom