---
title: "Listar cupons"
method: GET
path: "/{alias}/pricing/promocodes"
tags: ["Promoções - Cupons de desconto"]
---

# Listar cupons

`GET /{alias}/pricing/promocodes`

Retorna uma lista de cupons de desconto de acordo com os filtros especificados

## Path parameters

- `alias` string, required

## Query parameters

- `include` string[]
- `filters` PromocodeCriteria — Mapeia os filtros disponíveis para pesquisa de cupons.
  - `status` boolean — Define se o cupom está ativo ou inativo.
  - `expired` boolean — Filtra cupons expirados (compara end_at com a data atual).
  - `q` string — Busca por prefixo do código do cupom.
  - `rules` string[] — Regras booleanas (ex.: rules[]=accumulate&rules[]=newsletter).
  - `code` union — Filtra por um ou mais códigos exatos. Aceita string ou array (code=A&code=B).
    - string
    - string[]

## Response `200`

Lista de cupons retornada com sucesso

- object
  - `data` object[]
    - `id` integer
    - `code` string
    - `description` string
    - `customer_id` integer
    - `active` boolean
    - `expired` boolean
    - `discount_type` 'p' | 'v'
    - `for_the_price_of` boolean
    - `cart_default` boolean
    - `type_increment_value` string
    - `value` number, float
    - `price_products` number, float
    - `percent_products` number, float
    - `quantity` integer
    - `total_customers_used` integer
    - `product_quantity` integer
    - `product_max_quantity` integer
    - `used` integer
    - `items_count` integer
    - `min_value` number, float
    - `use_percent` number, float
    - `shipment_percent` number, float
    - `accumulate` boolean
    - `once_per_customer` boolean
    - `abandoned_cart` boolean
    - `newsletter` boolean
    - `payments_ids` string
    - `free_shipment` boolean
    - `ignore_promotion_products` boolean
    - `start_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.
    - `end_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.
    - `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.

## Other responses

- `404` — Cupons não encontrados

---

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