# Consultar cupons

> Lista os cupons válidos ou busca um cupom pelo código ou id.

Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/cupom/consultar · Atualizado em 18/11/2026


## O que faz

Sem filtro, lista só os cupons **válidos** (dentro da validade e com saldo de usos). Com filtro, devolve o cupom pedido.

## Requisição

| | |
|---|---|
| **Método** | `GET` |
| **URL** | `https://api.viashopmoda.com.br/via/cupom/consultar/{TOKEN}` |
| **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). |
| **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. |


## Parâmetros

Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar.

| Parâmetro | Descrição |
|---|---|
| `codigo_cupom` | Código do cupom. |
| `id` | Id do cupom (texto codificado). Sem filtro: só cupons válidos. |


## Exemplo

```json
{
  "cupom": [
    {
      "id": "OQS5",
      "codigo_cupom": "BOASVINDAS",
      "primeira_compra": "S",
      "nome_parceiro": "Boas-vindas",
      "data_validade": "2026-12-31 23:59:59",
      "tipo_valor": "P",
      "valor": 10,
      "saldo": 100
    }
  ]
}
```

`saldo` = usos restantes.

## Pode reenviar?

Sim (somente leitura).
