> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yampi.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Visão Geral

> Includes disponíveis para os recursos de promoções em {alias}/pricing/*

## Introdução

Esta página documenta os **includes** disponíveis para os recursos promocionais da API, sob o namespace `/pricing/*`, que abrangem:

* Combos (compre junto)
* Promoções de produtos
* Upsells
* Cupons de desconto

O parâmetro `include` permite expandir a resposta da API com dados relacionados, otimizando o consumo e evitando múltiplas chamadas subsequentes.

***

## Combos [`ver na documentação →`](https://docs.yampi.com.br/api-reference/promo%C3%A7%C3%B5es--combos/listar-combos-de-produtos)

Combos são promoções do tipo "compre junto", onde a compra combinada de produtos gera um benefício ou desconto.

### Includes disponíveis

| Include    | Descrição                         |
| ---------- | --------------------------------- |
| `products` | Produtos que fazem parte do combo |

### Endpoints

```http theme={"system"}
GET /v2/{alias}/pricing/combos
GET /v2/{alias}/pricing/combos/{id}
```

### Exemplo com include

```http theme={"system"}
GET /v2/{alias}/pricing/combos?include=products
```

***

## Promoções de Produtos [`ver na documentação →`](https://docs.yampi.com.br/api-reference/promo%C3%A7%C3%B5es--produtos/listar-promo%C3%A7%C3%B5es)

Promoções criadas para aplicar descontos com base em regras relacionadas a categorias, marcas, coleções ou produtos específicos.

### Includes disponíveis

| Include       | Descrição                         |
| ------------- | --------------------------------- |
| `categories`  | Categorias vinculadas à promoção  |
| `collections` | Coleções aplicáveis               |
| `brands`      | Marcas incluídas na promoção      |
| `products`    | Produtos individuais com desconto |
| `banners`     | Banners promocionais vinculados   |

### Endpoints

```http theme={"system"}
GET /v2/{alias}/pricing/promotions
GET /v2/{alias}/pricing/promotions/{id}
```

### Exemplo com include

```http theme={"system"}
GET /v2/{alias}/pricing/promotions?include=products,categories,banners
```

***

## Upsells [`ver na documentação →`](https://docs.yampi.com.br/api-reference/promo%C3%A7%C3%B5es--upsells/listar-upsells)

Upsells são ofertas sugeridas com base em um produto adquirido, apresentando produtos adicionais com possibilidade de desconto.

### Includes disponíveis

| Include             | Descrição                                  |
| ------------------- | ------------------------------------------ |
| `purchased_product` | Produto que ativa o upsell                 |
| `suggested_product` | Produto sugerido como upsell               |
| `promocode`         | Cupom promocional associado (se aplicável) |

### Endpoint

```http theme={"system"}
GET /v2/{alias}/pricing/upsells
```

### Exemplo com include

```http theme={"system"}
GET /v2/{alias}/pricing/upsells?include=suggested_product,promocode
```

***

## Cupons de Desconto [`ver na documentação →`](https://docs.yampi.com.br/api-reference/promo%C3%A7%C3%B5es--cupons-de-desconto/listar-cupons)

Cupons de desconto são regras promocionais aplicáveis a compras específicas. Podem ter condições ligadas a produtos, coleções, categorias, marcas, formas de pagamento ou até a um cliente individual.

### Includes disponíveis

| Include       | Descrição                                                 |
| ------------- | --------------------------------------------------------- |
| `customer`    | Cliente específico associado ao cupom (quando for o caso) |
| `categories`  | Categorias nas quais o cupom pode ser aplicado            |
| `collections` | Coleções onde o cupom é válido                            |
| `brand`       | Marca específica (campo singular)                         |
| `products`    | Produtos que aceitam o uso do cupom                       |
| `payments`    | Meios de pagamento válidos para o cupom                   |

### Endpoints

```http theme={"system"}
GET /v2/{alias}/pricing/promocodes
GET /v2/{alias}/pricing/promocodes/{id}
```

### Exemplo com include

```http theme={"system"}
GET /v2/{alias}/pricing/promocodes?include=products,categories,brand
```