Skip to main content
POST
Criar cupom

Authorizations

Authorization
string
header
required

API Key no formato cvx_live_..., criada no painel Corvex. Não use JWT de sessão nem x-api-key.

Headers

X-Store-Id
string<uuid>
required

UUID da loja. A chave precisa ter esta loja autorizada.

Body

application/json
name
string
required
Required string length: 1 - 120
code
string
required

Código que o cliente digita. Não muda depois de criado.

Required string length: 3 - 64
discountType
enum<string>
required
Available options:
CURRENCY,
PERCENT
amount
number
required

Valor em reais (CURRENCY) ou percentual (PERCENT).

Required range: x >= 0
totalAvailable
integer

0 = ilimitado.

Required range: x >= 0
startAt
string<date-time>

Início da vigência (ISO 8601).

endAt
string<date-time> | null

Fim da vigência. null = sem término.

singleUsePerCustomer
boolean
automaticApply
boolean

Aplica sozinho no checkout quando as regras batem.

status
enum<string>
Available options:
ACTIVE,
INACTIVE

Response

Criado.