---
title: "Listar Order Bumps"
method: GET
path: "/{alias}/pricing/order-bumps"
tags: ["Promoções - Order Bump"]
---

# Listar Order Bumps

`GET /{alias}/pricing/order-bumps`

Listar todos os Order Bumps cadastrados

## Path parameters

- `alias` string, required

## Query parameters

- `include` string[]
- `filters` OrderBumpCriteria — Mapeia os filtros disponíveis para pesquisa de Order Bumps.
  - `accepted_payment` string[] — Filtra Order Bumps pelo(s) meio(s) de pagamento aceito(s).
  - `active` integer — Define se o Order Bump está ativo ou inativo (ativa=1 ou inativa=0).

## Response `200`

Lista de Order Bumps

- object — Representa uma paginação com meta
  - `data` OrderBump[]
    - `id` integer
    - `active` boolean
    - `is_ia` boolean
    - `pre_select_variation` boolean
    - `name` string
    - `displayed_quantity` integer
    - `resource_id` integer
    - `resource_type` string
    - `price_sale` string
    - `price_discount` string
    - `params` object
      - `button_text` string
      - `title` string, nullable
      - `message` string, nullable
    - `accepted_payment` string
    - `display_rule` string
    - `amount_rule` string
    - `amount_value` string
    - `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.
    - `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.
    - `display_product_ids` integer[]
  - `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

- `400` — Requisição inválida

---

[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)