---
title: "Listar todos os Brindes de uma loja"
method: GET
path: "/{alias}/pricing/freebies"
tags: ["Marketing - Brindes"]
---

# Listar todos os Brindes de uma loja

`GET /{alias}/pricing/freebies`

Retorna a lista de Brindes cadastrado

## Path parameters

- `alias` string, required

## Query parameters

- `include` string[]
- `filters` FreebieCriteria — Mapeia os filtros disponíveis para pesquisa de regras promocionais.
  - `expired` integer — Indica se a regra está expirada (ativa=1 ou inativa=0).
  - `active` integer — Status da regra (ativa=1 ou inativa=0).
  - `rules` string[] — Tipo de regra aplicada.

## Response `200`

Lista de Brindes retornada com sucesso

- object — Representa uma paginação com meta
  - `data` Freebie[]
    - `id` integer — ID do brinde
    - `active` boolean — Indica se o brinde está ativo
    - `store_id` integer — ID da loja associada
    - `name` string — Nome do brinde
    - `start_at` string, date — Data de início da oferta do brinde
    - `expires_at` string, date, nullable — Data de expiração do brinde (se configurado)
    - `resource_id` integer — ID do produto ou SKU vinculado ao brinde
    - `resource_type` string — Pode ser produto ou SKU
    - `rule` string — Regra aplicada ao brinde
    - `min_quantity` integer — Quantidade mínima de produtos no carrinho para receber o brinde
    - `min_amount` number, float — Valor mínimo no carrinho para receber o brinde
    - `created_at` BaseTimestamp
      - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
      - `timezone_type` integer — Número de representação do timezone.
      - `timezone` string — Fuso horário associado.
    - `updated_at` BaseTimestamp
      - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
      - `timezone_type` integer — Número de representação do timezone.
      - `timezone` string — Fuso horário associado.
  - `meta` object
    - `pagination` object
      - `total` integer
      - `count` integer
      - `per_page` integer
      - `current_page` integer
      - `total_pages` integer
      - `links` object
        - `previous` string
        - `next` string

## Other responses

- `404` — Verifique a URL e tente novamente.

---

[API](https://skmtc.net/yampi/apis/yampi-api.md) · [All operations](https://skmtc.net/yampi/apis/yampi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yampi/yampi-api/revisions/fa16c50bef09/schema)