Skip to main content
GET
Visualizar os Brindes de uma loja

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

Query Parameters

include
enum<string>[]

Incluir relacionamentos adicionais

Available options:
resource

Response

Brinde encontrado 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