> For the complete documentation index, see [llms.txt](https://apidoc.toplojas.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidoc.toplojas.com.br/cupons-de-desconto/visao-geral.md).

# Visão Geral

Através da API de **Cupons de Desconto** você pode consultar e gerenciar os cupons da loja: listar, ver os detalhes, criar novos cupons, editar e excluir.

{% hint style="info" %}
Estas páginas são **guias práticos**. A referência completa de cada campo, tipo e schema está no simulador online:

{% embed url="<https://api.toplojas.com.br/doc/#/CupomDesconto>" %}
{% endhint %}

## 🔄 Fluxo típico

Um fluxo comum de integração de cupons costuma seguir esta ordem:

1. **Listar** os cupons, filtrando por status ou pela chave de busca (código ou observação).
2. **Consultar os detalhes** de um cupom específico.
3. **Criar** um novo cupom de desconto.
4. **Editar** um cupom já existente (valores, vigência, status).
5. **Excluir** um cupom que não será mais utilizado.

## 🧭 Endpoints de Cupons de Desconto

| Ação                    | Método | Rota                        |
| ----------------------- | ------ | --------------------------- |
| Listar e filtrar cupons | GET    | `/cupom-desconto/`          |
| Detalhes de um cupom    | GET    | `/cupom-desconto/{Codigo}/` |
| Criar cupom             | POST   | `/cupom-desconto/`          |
| Editar cupom            | PUT    | `/cupom-desconto/{Codigo}/` |
| Excluir cupom           | DELETE | `/cupom-desconto/{Codigo}/` |