API ViaShopModa documentação

cupom/atualizar

Atualizar cupom

Altera um cupom pelo id — enviando todos os campos, não só os que mudaram.

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

O que faz #

Regrava os dados de um cupom existente.

Requisição #

MétodoPOST
URLhttps://api.viashopmoda.com.br/via/cupom/atualizar/{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 #

id (obrigatório: o id codificado devolvido no cadastro ou em cupom/consultar) mais todos os campos do cadastro:

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.

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.