Skip to main content
POST
Criar cupom

Authorizations

API-Key
string
header
required

Chave de API obtida através do endpoint /api/credentials. Também aceita formato Bearer Token: Authorization: Bearer <api_key>

Body

application/json
code
string
required
Required string length: 3 - 50
discountType
enum<string>
required
Available options:
PERCENTAGE,
FIXED
discountValue
number
required
Required range: x >= 0
description
string
Maximum string length: 500
minPurchaseCents
integer
Required range: x >= 0
maxDiscountCents
integer
Required range: x >= 0
usageLimit
integer
Required range: x >= 1
perUserLimit
integer
Required range: x >= 1
validFrom
string<date-time>
validUntil
string<date-time>
productIds
string<uuid>[]
status
enum<string>
default:ACTIVE
Available options:
ACTIVE,
INACTIVE

Response

Cupom criado com sucesso

message
string
coupon
object