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

# Visualizar cupom

`GET /{alias}/pricing/promocodes/{id}`

Obtém detalhes de um cupom de desconto específico

## Path parameters

- `alias` string, required
- `id` integer, required

## Query parameters

- `include` string[]

## Response `200`

Detalhes do cupom

- object — Representa as restrições de inclusão e exclusão para itens específicos
  - `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.
  - `include` object — Itens a serem incluídos
    - `products_ids` integer[]
    - `brands_ids` integer[]
    - `collections_ids` integer[]
    - `categories_ids` integer[]
  - `exclude` object — Itens a serem excluídos
    - `products_ids` integer[]
    - `brands_ids` integer[]
    - `collections_ids` integer[]
    - `categories_ids` integer[]
  - `include_ids` integer[] — Lista de IDs para inclusão
  - `exclude_ids` integer[] — Lista de IDs para exclusão

## Other responses

- `404` — Cupom não encontrado

---

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