O que faz #
Cria um cupom. Se o código já existir, não cria outro e avisa em msg_alerta.
Requisição #
| Método | POST |
| URL | https://api.viashopmoda.com.br/via/cupom/cadastrar/{TOKEN} |
| Corpo | Objeto JSON { ... }, cabeçalho Content-Type: application/json |
| Token | Substitua {TOKEN} pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. |
Campos #
| Campo | Tipo | Obrigatório | Limites | Descrição |
|---|---|---|---|---|
codigo_cupom | string | sim | máx. 20 | Código a ser usado na compra. |
primeira_compra | string | sim | máx. 1 | 'S' ou 'N' |
nome_parceiro | string | sim | máx. 100 | Nome do parceiro relacionado ao cupom. |
data_validade | datetime | sim | máx. 19 | Data de validade. Padrão DATETIME 'aaaa-mm-dd hh:mm:ss' |
tipo_valor | string | sim | máx. 1 | 'P' para valores percentuais e 'V' para valores em reais. |
valor | numeric | sim | máx. 11 | Valor a ser dado de desconto. Campo relacionado com 'tipo_valor' |
quantidade | numeric | sim | máx. 3 | Quantidade de cupons disponíveis |
tipo_loja | string | não | má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) ouV(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.