v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB
Promoções - Cupons de desconto

Atualizar cupom

Atualiza os detalhes de um cupom de desconto específico

put/{alias}/pricing/promocodes/{id}

Path parameters

aliasstring required

Alias da loja

idinteger required

ID do cupom

Request body

activeboolean

Ativação do cupom

for_the_price_ofboolean

Cupom para o preço de

accumulateboolean

Acumulação do cupom

once_per_customerboolean

Válido apenas uma vez por cliente

abandoned_cartboolean

Cupom para carrinho abandonado

newsletterboolean

Cupom para assinatura de newsletter

free_shipmentboolean

Cupom para frete grátis

ignore_promotion_productsboolean

Ignorar produtos promocionais

discount_type'p' | 'v'

Tipo de desconto

valuenumber float

Valor do desconto

codestring

Código do cupom

quantityinteger

Quantidade disponível do cupom

min_valuenumber float

Valor mínimo para aplicação do cupom

start_atstring date-time

Data e hora de início

end_atstring date-time

Data e hora de término

Example request

{
  "value": 10,
  "code": "10OFF",
  "quantity": 100000,
  "min_value": 99.99,
  "start_at": "2025-06-01 00:00:00",
  "end_at": "2025-08-10 00:00:00"
}

Response

Cupom atualizado com sucesso

idinteger
codestring
descriptionstring
customer_idinteger
activeboolean
expiredboolean
discount_type'p' | 'v'
for_the_price_ofboolean
cart_defaultboolean
type_increment_valuestring
valuenumber float
price_productsnumber float
percent_productsnumber float
quantityinteger
total_customers_usedinteger
product_quantityinteger
product_max_quantityinteger
usedinteger
items_countinteger
min_valuenumber float
use_percentnumber float
shipment_percentnumber float
accumulateboolean
once_per_customerboolean
abandoned_cartboolean
newsletterboolean
payments_idsstring
free_shipmentboolean
ignore_promotion_productsboolean

Example response

{
  "code": "TEST",
  "value": 10,
  "used": 22,
  "min_value": 99.99,
  "use_percent": 0.02,
  "payments_ids": "[1, 2, 3, 4]"
}