---
title: "Listar descontos da loja"
method: GET
path: "/{alias}/discounts"
tags: ["Descontos"]
---

# Listar descontos da loja

`GET /{alias}/discounts`

Lista os descontos cadastrados na loja

## Path parameters

- `alias` string, required

## Query parameters

- `q` string
- `discount_type` string[]
- `status` 0 | 1

## Response `200`

Lista de descontos

- object
  - `data` object[] — Detalhes dos descontos
    - `id` integer
    - `store_id` integer
    - `discount_type_id` integer
    - `name` string
    - `entry_condition_type` string
    - `entry_condition_value` number
    - `discount_method` string
    - `discount_value` number
    - `discount_type` string
    - `accumulate` 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.
    - `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)
