v1

latestOpenAPI 3.1.02026-07-265314114.3 KB

Discounts

Create Discount

Cria um cupom de desconto.

post/app/discount

Request body

couponstring required

O cupom que será criado. Aceita apenas letras, números, hífens e underlines.

applies_tonumber[] required

Lista de ID dos produtos em que o cupom poderá ser aplicado. Use [-1] para aplicar a todos os produtos.

type'PRICE' | 'PERCENTAGE' required

O tipo do desconto, podendo ser PRICE ou PERCENTAGE

valuenumber required

O valor do desconto. Para PERCENTAGE, o valor é em porcentagem (ex: 50 = 50%). Para PRICE, o valor é em centavos da moeda.

max_usesnumber

A quantidade máxima de usos que o desconto pode ter

expires_instring date

A data de expiração do desconto

min_pricenumber

Valor mínimo do pedido para que o cupom possa ser aplicado. Intervalo: 0 a 999999.

limit_criteria'CLIENT_IDENTIFIER' | 'CLIENT_EMAIL' | 'CLIENT_DISCORD'

Critério de limitação de uso por cliente. Quando definido, cada cliente só poderá usar o cupom uma vez com base no critério escolhido. Valores possíveis: CLIENT_IDENTIFIER, CLIENT_EMAIL, CLIENT_DISCORD

restricted_to_criteria'CLIENT_IDENTIFIER' | 'CLIENT_EMAIL' | 'CLIENT_DISCORD'

Tipo de restrição para limitar o cupom a clientes específicos. Deve ser usado junto com restricted_to. Valores possíveis: CLIENT_IDENTIFIER, CLIENT_EMAIL, CLIENT_DISCORD

restricted_tostring[]

Lista de identificadores dos clientes que poderão usar o cupom. Requer que restricted_to_criteria esteja definido. Ex: lista de e-mails, IDs Discord ou identificadores.

Response

Cupom de desconto criado.

idnumber

store_idnumber

couponstring

type'PRICE' | 'PERCENTAGE'

valuenumber

applies_tonumber[]

usesnumber

max_usesnumber nullable

expires_instring nullable

min_pricenumber nullable

limit_criteria'CLIENT_IDENTIFIER' | 'CLIENT_EMAIL' | 'CLIENT_DISCORD' nullable

restricted_to_criteria'CLIENT_IDENTIFIER' | 'CLIENT_EMAIL' | 'CLIENT_DISCORD' nullable

restricted_tostring[] nullable

created_atstring

updated_atstring