API ViaShopModa documentação

Glossário

O que cada termo significa nesta API — vários nomes não são os que um ERP costuma usar.

Ver como Markdown Atualizado em 18/11/2026

Leia antes de integrar o catálogo. Alguns nomes da API não batem com o que o ERP chama de "tipo", "categoria" ou "cor". A tabela abaixo é a referência.

Termo na APIO que éRotaExemplo
produtoO modelo da peça, identificado pelo cod_ref. Tem título, descrição, preços e fotos.produto/*VES001 — Vestido xadrez
variação / SKUUma combinação produto × grade × estampa. É onde ficam o código de barras, a quantidade em estoque e o preço diferenciado (se houver).estoque/*, preco/atualizarVES001 tamanho P na cor Azul
gradeO tamanho da variação.grade/*P, M, G, 38
estampaA cor ou estampa da variação. Pode ter uma imagem (estampa) ou uma cor sólida em hexadecimal (cor).estampa/*AZUL CLARO, FLORAL
corEstampa do tipo cor sólida (hexadecimal), pré-definida pelo sistema. Só consulta.cor/consultarPRETO = #000000
tipo (campo tipo do produto)O tipo de peça. Na API, a rota se chama peso por motivo histórico.peso/*Vestido, Blusas e Camisetas
gênero (campo genero do produto)O público da peça. Na API, a rota se chama categoria.categoria/*FEMININO, INFANTIL
coleçãoAgrupamento de produtos na vitrine (temporada, linha, lançamento). Coleção inativa esconde os produtos.colecao/*INVERNO 2026
SuperVitrineGrupo de produtos que são o mesmo modelo em cores diferentes, cadastrados como produtos separados. A loja mostra as outras cores na página de cada um.produto/associar_supervitrine001 - Preto, 001 - Verde
Compre JuntoProdutos sugeridos junto com outro (relacionados).produto/associar_comprejunto

Não confunda: o campo peso do produto é o peso em gramas. A rota peso/* é o cadastro de tipos de produto.

Códigos #

CódigoDe quem éOnde aparece
id / cod_produto / cod_grade / cod_estampaGerado pela loja (ViaShopModa).Respostas das consultas e do cadastro.
cod_refCódigo de referência do produto, definido pelo ERP. Identifica o produto no cadastro: enviar o mesmo cod_ref de novo atualiza o produto.produto/*
cod_barrasCódigo de barras da variação, definido pelo ERP. Precisa ser único na loja. É a forma mais simples de identificar uma variação.estoque/*, preco/*, imagens/upload, pedido/cadastrar
cod_gtinGTIN/EAN da variação, quando diferente do cod_barras.produto/cadastrar
cod_externoCódigo que o ERP usa para um produto, tipo, grade, estampa ou cliente. Serve para o ERP localizar o registro pelo código dele.cod_externo/associar, cliente/associar_codexterno
numero_pedidoNúmero do pedido na loja: 6 dígitos (ex.: 111111).pedido/*
numero_pedido_externoNúmero do pedido no ERP.pedido/associar_codexterno, pedido/cadastrar
cod_cliente, id de cupom, lead e vendedorIdentificadores codificados (texto como "MTIz"), não números. Use exatamente como recebidos.cliente/*, cupom/*, leads/*, vendedores/*

Clientes #

TermoO que é
tipo_pessoaF pessoa física, J pessoa jurídica, E cliente do exterior.
RevendedorCliente pessoa física que compra no atacado (padrão para F).
LojistaCliente pessoa jurídica (padrão para J e E).
ConsignadoCliente que compra em consignação, com valor máximo de compra (compra_maxima_atacado).
liberado_para_comprarS = pode fazer login e comprar. Qualquer outro valor deixa o cadastro aguardando liberação da loja.
vendedorUsuário da loja responsável pelo cliente (vendedora, representante).
leadContato que ainda não é cliente: deixou nome e e-mail ou WhatsApp na loja.
etiquetaMarcador de CRM aplicado ao cliente.

Vendas #

TermoO que é
atacado / varejoOs dois preços de cada produto (preco_atacado, preco_varejo) e os dois tipos de pedido (A, V).
preço promocional (*_promo)Preço "de" na vitrine: a loja mostra "de X por Y".
subpedidoParte do pedido com tipo de venda, pagamento e rastreio. Não tem rota própria: vai dentro do corpo de pedido/*.
sacolaOs itens de um pedido.
sacola abandonadaItens que um cliente identificado colocou na sacola sem finalizar o pedido.
pedido alteradoA loja cancela o pedido original e cria um novo com outro número. Veja o guia Pedidos.

Integração #

TermoO que é
tokenCredencial da loja para a API. Vai no caminho da URL.
webhookAviso que a ViaShopModa envia ao ERP quando algo acontece (pedido novo, cliente novo…).
automação / assíncronoAlgumas rotas não executam na hora: colocam a ação numa fila e devolvem automacao_id. Acompanhe com automacao/consultar.
loteRotas que recebem uma lista: no máximo 20 itens por requisição.