Skip to main content
PUT
Atualizar um Brinde

Authorizations

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

Path Parameters

alias
string
required

Alias da loja

id
integer
required

ID do brinde

Body

application/json

Request para criação/atualização de brindes.

name
string
required

Deve ser único por loja. O valor é sanitizado e normalizado automaticamente.

Maximum string length: 190
Example:

"Brinde Natal"

active
boolean
required

Mostra se a regra está ativa.

Example:

true

start_at
string<date-time>
required

Data e hora de início

Example:

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

resource_type
enum<string>
required

Tipo do item no Brinde, Você pode escolher entre produto ou SKU.

Available options:
sku,
product
Example:

"product"

resource_id
integer
required

ID do item ofertado no Brinde.

Example:

9791068

rule
enum<string>
required

Regra que diz em qual condição o Comprador ganha um brinde. Se será sempre (always), baseado na quantidade de produtos no carrinho (products_quantity) ou no valor total dos prdutos (products_amount).

Available options:
always,
products_amount,
products_quantity
Example:

"products_amount"

end_at
string<date-time>

Data e hora de término

Example:

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

min_quantity
number<integer>

Se escolher a regra para ofertar o brinde pela quantidade de produtos no carrinho, deverá definir a quantidade mínima aqui.

Required range: x >= 1
Example:

2

min_amount
number<float>

Se escolher a regra para ofertar o brinde pelo valor do carrinho, deverá definir a um valor mínimo aqui.

Required range: x >= 0.01
Example:

100

Response

Brinde atualizado com sucesso

Atributos do brinde

id
integer

ID do brinde

Example:

3976

active
boolean

Indica se o brinde está ativo

Example:

true

store_id
integer

ID da loja associada

Example:

176851

name
string

Nome do brinde

Example:

"Teste docs"

start_at
string<date>

Data de início da oferta do brinde

Example:

"2025-09-16"

expires_at
string<date> | null

Data de expiração do brinde (se configurado)

Example:

"2025-09-16"

resource_id
integer

ID do produto ou SKU vinculado ao brinde

Example:

9791068

resource_type
string

Pode ser produto ou SKU

Example:

"product"

rule
string

Regra aplicada ao brinde

Example:

"always"

min_quantity
integer

Quantidade mínima de produtos no carrinho para receber o brinde

Example:

0

min_amount
number<float>

Valor mínimo no carrinho para receber o brinde

Example:

0

created_at
object
updated_at
object