O que faz #
Regrava os dados de um cupom existente.
Requisição #
| Método | POST |
| URL | https://api.viashopmoda.com.br/via/cupom/atualizar/{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 #
id (obrigatório: o id codificado devolvido no cadastro ou em cupom/consultar) mais todos os campos do cadastro:
| 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. |
A validação é a mesma do cadastro: todos os campos obrigatórios precisam vir, mesmo os que não mudaram.
Exemplo #
{
"id": "OQS5",
"codigo_cupom": "CANALINSTAGRAM",
"tipo_valor": "P",
"valor": 20,
"primeira_compra": "S",
"nome_parceiro": "Canal Instagram",
"data_validade": "2027-01-31 23:59:59",
"quantidade": 100
}Sucesso: {"retorno": true, "msg": "Cupom código 'OQS5' alterado com sucesso."}.
Não encontrado: msg_alerta "Cupom código 'X' não encontrado.". Erros: Parâmetro 'id' não encontrado, Parâmetro 'tipo_valor' precisa ser 'P' ou 'V'.
Pode reenviar? #
Sim.