Skip to main content
PATCH
Update Discount

Autorizações

Authorization
string
header
obrigatório

Token de API gerado no painel da CentralCart.

Parâmetros de caminho

discount-id
string
obrigatório

O ID do desconto a ser atualizado

Corpo

application/json
coupon
string

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

applies_to
number[]

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

type
enum<string>

O tipo do desconto, podendo ser PRICE ou PERCENTAGE

Opções disponíveis:
PRICE,
PERCENTAGE
value
number

O valor do desconto

max_uses
number

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

expires_in
string<date>

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

min_price
number

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

limit_criteria
enum<string>

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.

Opções disponíveis:
CLIENT_IDENTIFIER,
CLIENT_EMAIL,
CLIENT_DISCORD
restricted_to_criteria
enum<string>

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.

Opções disponíveis:
CLIENT_IDENTIFIER,
CLIENT_EMAIL,
CLIENT_DISCORD
restricted_to
string[]

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

Resposta

200 - application/json

Cupom de desconto atualizado.

id
number
store_id
number
coupon
string
type
enum<string>
Opções disponíveis:
PRICE,
PERCENTAGE
value
number
applies_to
number[]
uses
number
max_uses
number | null
expires_in
string | null
min_price
number | null
limit_criteria
enum<string> | null
Opções disponíveis:
CLIENT_IDENTIFIER,
CLIENT_EMAIL,
CLIENT_DISCORD
restricted_to_criteria
enum<string> | null
Opções disponíveis:
CLIENT_IDENTIFIER,
CLIENT_EMAIL,
CLIENT_DISCORD
restricted_to
string[] | null
created_at
string
updated_at
string