API ViaShopModa documentação

cupom/consultar

Consultar cupons

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

Ver como Markdown Baixar coleção Postman 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étodoGET
URLhttps://api.viashopmoda.com.br/via/cupom/consultar/{TOKEN}
CorpoNenhum. Filtros vão na query string (?campo=valor&...).
TokenSubstitua {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âmetroDescrição
codigo_cupomCódigo do cupom.
idId do cupom (texto codificado). Sem filtro: só cupons válidos.

Exemplo #

{
  "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).