Skip to main content
POST
Criar um desconto da loja

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

Body

application/json

Dados para criação do desconto

name
string
required

Nome do desconto.

Required string length: 3 - 100
Example:

"Promoção de Outubro"

discount_method
enum<string>
required

Método de desconto.

Available options:
percent,
amount
Maximum string length: 10
Example:

"percent"

discount_value
number<float>
required

Valor do desconto. Se percentual, o máximo é 100.

Required range: x >= 0.01
Example:

20

discount_type
enum<string>
required

Tipo do desconto.

Available options:
buy_x_get_y,
by_payment_method
Example:

"buy_x_get_y"

entry_condition_type
enum<string>
required

Tipo de condição para aplicar o desconto.

Available options:
amount,
quantity
Example:

"amount"

entry_condition_value
required

Valor mínimo (quantidade de produto ou valor do carrinho) necessário para ativar o desconto.

Required range: x >= 1
Example:

1

accumulate
boolean
required

Define se o desconto pode acumular com outras promoções.

Example:

false

start_at
string<date-time>
required

Data e hora de início

Example:

"2025-06-01 00:00:00"

end_at
string<date-time>

Data e hora de término

Example:

"2025-08-10 00:00:00"

restrictions
object

Restrições de aplicação do desconto.

specifications
object

Configurações específicas do tipo de desconto. Os campos obrigatórios variam conforme discount_type.

Response

Detalhes do desconto

Representa os atributos de um Desconto

id
integer
Example:

1520

store_id
integer
Example:

1319250

discount_type_id
integer
Example:

1520

name
string
Example:

"Lucas"

entry_condition_type
string
Example:

"amount"

entry_condition_value
number
Example:

10

discount_method
string
Example:

"percent"

discount_value
number
Example:

100

discount_type
string
Example:

"buy_x_get_y"

accumulate
boolean
Example:

false

start_at
object
end_at
object
created_at
object
updated_at
object