Sign in

v1

latestOpenAPI 3.1.02026-07-265314114.3 KB
Discounts

Update Discount

Atualiza um cupom de desconto.

patch/app/discount/{discount-id}

Path parameters

discount-idstring required

O ID do desconto a ser atualizado

Request body

couponstring

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

applies_tonumber[]

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

type'PRICE' | 'PERCENTAGE'

O tipo do desconto, podendo ser PRICE ou PERCENTAGE

valuenumber

O valor do desconto

max_usesnumber

A quantidade máxima de usos que o desconto pode ter. Envie null para remover o limite.

expires_instring date

A data de expiração do desconto. Envie null para remover a expiração.

min_pricenumber

Valor mínimo do pedido para que o cupom possa ser aplicado. Envie null para remover. 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. Envie null para remover.

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. Envie null para remover.

restricted_tostring[]

Lista de identificadores dos clientes que poderão usar o cupom. Requer que restricted_to_criteria esteja definido. Envie null para remover.

Response

Cupom de desconto atualizado.

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