v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB

Marketing - Brindes

Criar novo Brinde

Cadastra um novo Brinde na loja

post/{alias}/pricing/freebies

Path parameters

aliasstring required

Alias da loja

Request body

namestring required

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

activeboolean required

Mostra se a regra está ativa.

start_atstring date-time required

Data e hora de início

end_atstring date-time

Data e hora de término

resource_type'sku' | 'product' required

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

resource_idinteger required

ID do item ofertado no Brinde.

rule'always' | 'products_amount' | 'products_quantity' 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).

min_quantitynumber

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

min_amountnumber float

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

Example request

{
  "name": "Brinde Natal",
  "active": true,
  "start_at": "2025-06-01 00:00:00",
  "end_at": "2025-08-10 00:00:00",
  "resource_type": "product",
  "resource_id": 9791068,
  "rule": "products_amount",
  "min_quantity": 2,
  "min_amount": 100
}

Response

Brinde criado com sucesso

idinteger

ID do brinde

activeboolean

Indica se o brinde está ativo

store_idinteger

ID da loja associada

namestring

Nome do brinde

start_atstring date

Data de início da oferta do brinde

expires_atstring date nullable

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

resource_idinteger

ID do produto ou SKU vinculado ao brinde

resource_typestring

Pode ser produto ou SKU

rulestring

Regra aplicada ao brinde

min_quantityinteger

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

min_amountnumber float

Valor mínimo no carrinho para receber o brinde

Example response

{
  "id": 3976,
  "active": true,
  "store_id": 176851,
  "name": "Teste docs",
  "start_at": "2025-09-16",
  "expires_at": "2025-09-16",
  "resource_id": 9791068,
  "resource_type": "product",
  "rule": "always",
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  }
}