API ViaShopModa documentação

Introdução

O que é a API, como chamar, como ler as respostas e por onde começar a integração.

Ver como Markdown Atualizado em 18/11/2026

O que você vai encontrar aqui #

A documentação tem duas partes:

  • Guias de processo — explicam como esperamos que a integração funcione: a ordem das chamadas, quem faz cada passo (ERP ou ViaShopModa) e o que acontece com estoque, status e números de pedido. Comece por eles.
  • Referência — uma página por endpoint, sempre com as mesmas seções: o que faz, requisição, campos, exemplos, respostas, regras, se pode reenviar e erros comuns.

Usando uma IA para integrar? Entregue a ela o arquivo llms-full.txt: é a documentação inteira em texto puro, com regras para a IA não inventar campos. Em cada página há também o botão Copiar página para IA.

Como chamar a API #

Toda chamada segue o formato:

https://api.viashopmoda.com.br/via/{recurso}/{operacao}/{TOKEN}
ParteO que éExemplo
{recurso}O assunto da chamadapedido, produto, estoque
{operacao}A açãoconsultar, cadastrar, atualizar
{TOKEN}Token de acesso da loja, fornecido pela ViaShopModaerp_TKBVID...
  • consultar e outras leituras: GET, filtros na query string (?pedido=111111).
  • cadastrar, atualizar e outras gravações: POST, corpo em JSON, cabeçalho Content-Type: application/json.

Exemplo:

curl "https://api.viashopmoda.com.br/via/pedido/consultar/SEU_TOKEN?pedido=111111"

Testar no Postman #

Todas as rotas estão numa coleção pronta para o Postman, uma pasta por recurso, com o exemplo de cada página já no corpo dos POST.

  1. No Postman, clique em Import e cole o link https://api.viashopmoda.com.br/docs-api/postman.json (ou baixe o arquivo e arraste para lá).
  2. Abra a coleção, aba Variables, e troque SEU_TOKEN pelo token da loja em token.
  3. Nas consultas (GET), os filtros vêm desligados: marque na aba Params os que quiser usar.

A coleção é gerada a partir desta documentação. Importe pelo link de novo para pegar rotas e exemplos atualizados.

Como ler as respostas #

HTTPQuando aconteceO que fazer
200A requisição foi processada.Confira o campo retorno: true deu certo; false não deu, e o motivo vem em msg_erro.
400A requisição foi recusada (campo faltando, valor inválido, registro não encontrado).Leia msg_erro, corrija o envio. Não reenvie igual.
401Token inválido ou ainda não ativo.Confira o token com a loja.
429Limite de requisições excedido (por segundo ou do dia).Espere e reduza a frequência. Veja os limites abaixo.

Toda resposta é JSON e traz status com o código HTTP. Pode vir também msg_alerta, avisando que a chamada pode ser otimizada.

Limites #

  • 1 requisição por segundo.
  • 2.500 requisições por dia por loja. O limite é compartilhado entre todos os tokens da mesma loja.
  • 20 registros por página nas consultas.
  • 20 itens por requisição nas operações em lote.

Precisa de mais? Fale com api@viashopmoda.com.br antes de colocar a integração em produção.

Paginação #

Quando uma consulta tem mais de 20 resultados, a resposta traz cabecalho.paginacao. Para as próximas páginas, acrescente pagina=2, pagina=3… na query string até ultima_pagina ser true.

{
  "cabecalho": {
    "paginacao": {
      "total_registros": 52,
      "limite_paginas": 20,
      "total_paginas": 3,
      "pagina_atual": 1,
      "ultima_pagina": false
    }
  },
  "pedidos": [ ... ]
}

Todas as rotas #

RotaMétodoO que faz
automacao/consultarGETAcompanhar uma ação assíncrona
categoria/atualizarPOSTAtualizar gênero (categoria)
categoria/cadastrarPOSTCadastrar gênero (categoria)
categoria/consultarGETConsultar gêneros (categorias)
cliente/associar_codexternoPOSTAssociar código do cliente no ERP
cliente/atualizarPOSTAtualizar cliente
cliente/atualizar_consignadoPOSTDefinir limite de cliente consignado
cliente/cadastrarPOSTCadastrar cliente
cliente/consultarGETConsultar clientes
cliente/etiquetasPOSTAdicionar/remover etiquetas do cliente
cod_barras/atualizarPOSTTrocar código de barras
cod_barras/verificarPOSTVerificar códigos de barras
cod_externo/associarPOSTAssociar código do ERP a produto, tipo, grade ou estampa
colecao/atualizarPOSTAtualizar coleção
colecao/cadastrarPOSTCadastrar coleção
colecao/consultarGETConsultar coleções
cor/consultarGETConsultar cores
cupom/atualizarPOSTAtualizar cupom
cupom/cadastrarPOSTCadastrar cupom
cupom/consultarGETConsultar cupons
estampa/atualizarPOSTAtualizar estampa
estampa/cadastrarPOSTCadastrar estampas (cores/variações)
estampa/consultarGETConsultar estampas (cores/variações)
estoque/atualizarPOSTAtualizar estoque
estoque/callbackPOSTAtualizar estoque (callback)
estoque/consultarGETConsultar estoque
etiquetas/consultarGETConsultar etiquetas de CRM
formas_pagamento/consultarGETConsultar formas de pagamento
fotos/consultarGETConsultar fotos
grade/atualizarPOSTAtualizar grade (tamanho)
grade/cadastrarPOSTCadastrar grades (tamanhos)
grade/consultarGETConsultar grades (tamanhos)
imagens/novo_tokenGETRenovar o link de uma imagem
imagens/removerPOSTRemover fotos de um produto
imagens/uploadPOSTEnviar foto de produto ou de estampa
leads/cadastrarPOSTCadastrar lead
leads/consultarGETConsultar leads
limites_api/consultarGETConsultar saldo de requisições do dia
limites_api/solicitarPOSTSolicitar aumento de limite (desativada)
loja/consultarGETConsultar dados da loja
pedido/associar_codexternoPOSTAssociar número do pedido no ERP
pedido/atualizarPOSTAtualizar status do pedido
pedido/atualizar_notafiscalPOSTInformar nota fiscal do pedido
pedido/cadastrarPOSTCadastrar pedido criado fora da loja
pedido/consultarGETConsultar pedidos
peso/atualizarPOSTAtualizar tipo de produto (peso)
peso/cadastrarPOSTCadastrar tipos de produto (pesos)
peso/consultarGETConsultar tipos de produto (pesos)
preco/atualizarPOSTAtualizar preço de variações
produto/alterar_colecaoPOSTMover produtos de coleção
produto/alterar_precosPOSTAlterar preços de produtos
produto/associar_comprejuntoPOSTDefinir produtos do Compre Junto
produto/associar_supervitrinePOSTAgrupar produtos na SuperVitrine
produto/atualizar_textosPOSTAtualizar textos e SEO do produto
produto/cadastrarPOSTCadastrar ou atualizar produto
produto/camposGETListar campos do cadastro de produto
produto/consultarGETConsultar produtos
produto/desativarPOSTDesativar produto
produto/ocorrenciasGETVer por que um produto não aparece à venda
produto/verificarPOSTVerificar se produtos existem
sacola/consultarGETConsultar itens de um pedido
sacola_abandonada/consultarGETConsultar sacola abandonada
status_pedido/associarPOSTAssociar nomes de status do ERP
status_pedido/consultarGETConsultar status de pedido da loja
vendedores/consultarGETConsultar vendedores

Suporte #

Dúvidas: api@viashopmoda.com.br.