API ViaShopModa documentação

cupom/cadastrar

Cadastrar cupom

Cria um cupom de desconto percentual ou em reais, com validade e quantidade de usos.

Ver como Markdown Baixar coleção Postman Atualizado em 18/11/2026

O que faz #

Cria um cupom. Se o código já existir, não cria outro e avisa em msg_alerta.

Requisição #

MétodoPOST
URLhttps://api.viashopmoda.com.br/via/cupom/cadastrar/{TOKEN}
CorpoObjeto JSON { ... }, cabeçalho Content-Type: application/json
TokenSubstitua {TOKEN} pelo token da loja. Ele vai no caminho da URL, não em cabeçalho.

Campos #

CampoTipoObrigatórioLimitesDescrição
codigo_cupomstringsimmáx. 20Código a ser usado na compra.
primeira_comprastringsimmáx. 1'S' ou 'N'
nome_parceirostringsimmáx. 100Nome do parceiro relacionado ao cupom.
data_validadedatetimesimmáx. 19Data de validade. Padrão DATETIME 'aaaa-mm-dd hh:mm:ss'
tipo_valorstringsimmáx. 1'P' para valores percentuais e 'V' para valores em reais.
valornumericsimmáx. 11Valor a ser dado de desconto. Campo relacionado com 'tipo_valor'
quantidadenumericsimmáx. 3Quantidade de cupons disponíveis
tipo_lojastringnãomáx. 1'A' para Atacado e 'V' para Varejo. Opcional: no cadastro, se não enviado, assume 'A'; na atualização, se não enviado, mantém o valor atual.

Regras #

  • tipo_valor: P (percentual) ou V (valor em reais). Outro valor é recusado.
  • quantidade: número de usos, até 999.
  • data_validade: aaaa-mm-dd hh:mm:ss.
  • primeira_compra: S = só vale na primeira compra do cliente.

Exemplo #

{
  "codigo_cupom": "CANALINSTAGRAM",
  "tipo_valor": "P",
  "valor": 15,
  "primeira_compra": "S",
  "nome_parceiro": "Canal Instagram",
  "data_validade": "2026-12-31 23:59:59",
  "quantidade": 100
}
{ "retorno": true, "id": "OQS5", "msg": "Cupom 'CANALINSTAGRAM' cadastrado com sucesso." }

Já existe: {"retorno": false, "msg_alerta": "Código 'CANALINSTAGRAM' já existe", "id": "OQS5"}.

Erros: Parâmetro 'codigo_cupom' não encontrado, Parâmetro 'tipo_valor' precisa ser 'P' ou 'V'.

Pode reenviar? #

Sim: o reenvio avisa que o código já existe e devolve o id.