v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB
Marketing - Brindes

Excluir um Brinde

Exclui o Brinde na loja

delete/{alias}/pricing/freebies/{id}

Path parameters

aliasstring required

Alias da loja

idinteger required

ID do brinde

Response

Brinde excluído 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"
  }
}