API ViaShopModa documentação

Vendas e marketing

Cupons, sacola abandonada, formas de pagamento, status personalizados, vendedores e dados da loja.

Ver como Markdown Atualizado em 18/11/2026

Cupons de desconto #

  • Criar: cupom/cadastrar. Alterar: cupom/atualizar (envie todos os campos, não só o que mudou).
  • tipo_valor: P = percentual, V = valor em reais.
  • quantidade: quantas vezes o cupom pode ser usado (até 999). O consumo é controlado pela loja.
  • Consulta sem filtro traz só cupons válidos (dentro da validade e com saldo).

Sacola abandonada #

Quando um cliente identificado coloca itens na sacola e não finaliza, a loja envia um webhook com a sessão. Com ela, sacola_abandonada/consultar traz cliente, itens com foto e valor total — útil para mensagens de recuperação.

Formas de pagamento #

formas_pagamento/consultar lista as formas da loja com tipo (online = gateway; offline = combinado com a loja). Use o nome exato ao informar forma_pagamento em pedido/atualizar.

Status com nomes do ERP #

A loja tem nomes fixos de status de pedido (veja o guia Pedidos). Se o ERP usa outros nomes, status_pedido/associar grava o "de/para" e status_pedido/consultar mostra a relação. A consulta de pedido passa a trazer também status_pedido_externo (o nome do ERP).

Em pedido/atualizar continue enviando o nome da loja (ex.: Pedido em transporte).

Vendedores #

vendedores/consultar lista vendedores e representantes. Use o id, email ou whatsapp para vincular clientes a um vendedor no cadastro.

Dados da loja #

loja/consultar traz nome, CNPJ, cidade, margem sugerida de varejo e banners.