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}| Parte | O que é | Exemplo |
|---|---|---|
{recurso} | O assunto da chamada | pedido, produto, estoque |
{operacao} | A ação | consultar, cadastrar, atualizar |
{TOKEN} | Token de acesso da loja, fornecido pela ViaShopModa | erp_TKBVID... |
consultare outras leituras: GET, filtros na query string (?pedido=111111).cadastrar,atualizare outras gravações: POST, corpo em JSON, cabeçalhoContent-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.
- 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á). - Abra a coleção, aba Variables, e troque
SEU_TOKENpelo token da loja emtoken. - 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 #
| HTTP | Quando acontece | O que fazer |
|---|---|---|
200 | A requisição foi processada. | Confira o campo retorno: true deu certo; false não deu, e o motivo vem em msg_erro. |
400 | A requisição foi recusada (campo faltando, valor inválido, registro não encontrado). | Leia msg_erro, corrija o envio. Não reenvie igual. |
401 | Token inválido ou ainda não ativo. | Confira o token com a loja. |
429 | Limite 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 #
| Rota | Método | O que faz |
|---|---|---|
automacao/consultar | GET | Acompanhar uma ação assíncrona |
categoria/atualizar | POST | Atualizar gênero (categoria) |
categoria/cadastrar | POST | Cadastrar gênero (categoria) |
categoria/consultar | GET | Consultar gêneros (categorias) |
cliente/associar_codexterno | POST | Associar código do cliente no ERP |
cliente/atualizar | POST | Atualizar cliente |
cliente/atualizar_consignado | POST | Definir limite de cliente consignado |
cliente/cadastrar | POST | Cadastrar cliente |
cliente/consultar | GET | Consultar clientes |
cliente/etiquetas | POST | Adicionar/remover etiquetas do cliente |
cod_barras/atualizar | POST | Trocar código de barras |
cod_barras/verificar | POST | Verificar códigos de barras |
cod_externo/associar | POST | Associar código do ERP a produto, tipo, grade ou estampa |
colecao/atualizar | POST | Atualizar coleção |
colecao/cadastrar | POST | Cadastrar coleção |
colecao/consultar | GET | Consultar coleções |
cor/consultar | GET | Consultar cores |
cupom/atualizar | POST | Atualizar cupom |
cupom/cadastrar | POST | Cadastrar cupom |
cupom/consultar | GET | Consultar cupons |
estampa/atualizar | POST | Atualizar estampa |
estampa/cadastrar | POST | Cadastrar estampas (cores/variações) |
estampa/consultar | GET | Consultar estampas (cores/variações) |
estoque/atualizar | POST | Atualizar estoque |
estoque/callback | POST | Atualizar estoque (callback) |
estoque/consultar | GET | Consultar estoque |
etiquetas/consultar | GET | Consultar etiquetas de CRM |
formas_pagamento/consultar | GET | Consultar formas de pagamento |
fotos/consultar | GET | Consultar fotos |
grade/atualizar | POST | Atualizar grade (tamanho) |
grade/cadastrar | POST | Cadastrar grades (tamanhos) |
grade/consultar | GET | Consultar grades (tamanhos) |
imagens/novo_token | GET | Renovar o link de uma imagem |
imagens/remover | POST | Remover fotos de um produto |
imagens/upload | POST | Enviar foto de produto ou de estampa |
leads/cadastrar | POST | Cadastrar lead |
leads/consultar | GET | Consultar leads |
limites_api/consultar | GET | Consultar saldo de requisições do dia |
limites_api/solicitar | POST | Solicitar aumento de limite (desativada) |
loja/consultar | GET | Consultar dados da loja |
pedido/associar_codexterno | POST | Associar número do pedido no ERP |
pedido/atualizar | POST | Atualizar status do pedido |
pedido/atualizar_notafiscal | POST | Informar nota fiscal do pedido |
pedido/cadastrar | POST | Cadastrar pedido criado fora da loja |
pedido/consultar | GET | Consultar pedidos |
peso/atualizar | POST | Atualizar tipo de produto (peso) |
peso/cadastrar | POST | Cadastrar tipos de produto (pesos) |
peso/consultar | GET | Consultar tipos de produto (pesos) |
preco/atualizar | POST | Atualizar preço de variações |
produto/alterar_colecao | POST | Mover produtos de coleção |
produto/alterar_precos | POST | Alterar preços de produtos |
produto/associar_comprejunto | POST | Definir produtos do Compre Junto |
produto/associar_supervitrine | POST | Agrupar produtos na SuperVitrine |
produto/atualizar_textos | POST | Atualizar textos e SEO do produto |
produto/cadastrar | POST | Cadastrar ou atualizar produto |
produto/campos | GET | Listar campos do cadastro de produto |
produto/consultar | GET | Consultar produtos |
produto/desativar | POST | Desativar produto |
produto/ocorrencias | GET | Ver por que um produto não aparece à venda |
produto/verificar | POST | Verificar se produtos existem |
sacola/consultar | GET | Consultar itens de um pedido |
sacola_abandonada/consultar | GET | Consultar sacola abandonada |
status_pedido/associar | POST | Associar nomes de status do ERP |
status_pedido/consultar | GET | Consultar status de pedido da loja |
vendedores/consultar | GET | Consultar vendedores |
Suporte #
Dúvidas: api@viashopmoda.com.br.