Skip to main content
GET
/
{alias}
/
pricing
/
freebies
/
{id}
Visualizar os Brindes de uma loja
curl --request GET \
  --url https://api.dooki.com.br/v2/{alias}/pricing/freebies/{id} \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>'
{
  "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",
  "min_quantity": 0,
  "min_amount": 0,
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.yampi.com.br/llms.txt

Use this file to discover all available pages before exploring further.

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