# Introdução

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

Fonte: https://api.viashopmoda.com.br/docs-api/?p=inicio · 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](https://api.viashopmoda.com.br/docs-api/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:

```text
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...` |

- `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:

```bash
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](https://api.viashopmoda.com.br/docs-api/postman.json?baixar=1) 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

| 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`.

```json
{
  "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`](https://api.viashopmoda.com.br/docs-api/?p=recursos/automacao/consultar&formato=md) | GET | Acompanhar uma ação assíncrona |
| [`categoria/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/categoria/atualizar&formato=md) | POST | Atualizar gênero (categoria) |
| [`categoria/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/categoria/cadastrar&formato=md) | POST | Cadastrar gênero (categoria) |
| [`categoria/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/categoria/consultar&formato=md) | GET | Consultar gêneros (categorias) |
| [`cliente/associar_codexterno`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/associar_codexterno&formato=md) | POST | Associar código do cliente no ERP |
| [`cliente/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/atualizar&formato=md) | POST | Atualizar cliente |
| [`cliente/atualizar_consignado`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/atualizar_consignado&formato=md) | POST | Definir limite de cliente consignado |
| [`cliente/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/cadastrar&formato=md) | POST | Cadastrar cliente |
| [`cliente/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/consultar&formato=md) | GET | Consultar clientes |
| [`cliente/etiquetas`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/etiquetas&formato=md) | POST | Adicionar/remover etiquetas do cliente |
| [`cod_barras/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cod_barras/atualizar&formato=md) | POST | Trocar código de barras |
| [`cod_barras/verificar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cod_barras/verificar&formato=md) | POST | Verificar códigos de barras |
| [`cod_externo/associar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cod_externo/associar&formato=md) | POST | Associar código do ERP a produto, tipo, grade ou estampa |
| [`colecao/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/colecao/atualizar&formato=md) | POST | Atualizar coleção |
| [`colecao/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/colecao/cadastrar&formato=md) | POST | Cadastrar coleção |
| [`colecao/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/colecao/consultar&formato=md) | GET | Consultar coleções |
| [`cor/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cor/consultar&formato=md) | GET | Consultar cores |
| [`cupom/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cupom/atualizar&formato=md) | POST | Atualizar cupom |
| [`cupom/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cupom/cadastrar&formato=md) | POST | Cadastrar cupom |
| [`cupom/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cupom/consultar&formato=md) | GET | Consultar cupons |
| [`estampa/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/estampa/atualizar&formato=md) | POST | Atualizar estampa |
| [`estampa/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/estampa/cadastrar&formato=md) | POST | Cadastrar estampas (cores/variações) |
| [`estampa/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/estampa/consultar&formato=md) | GET | Consultar estampas (cores/variações) |
| [`estoque/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/estoque/atualizar&formato=md) | POST | Atualizar estoque |
| [`estoque/callback`](https://api.viashopmoda.com.br/docs-api/?p=recursos/estoque/callback&formato=md) | POST | Atualizar estoque (callback) |
| [`estoque/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/estoque/consultar&formato=md) | GET | Consultar estoque |
| [`etiquetas/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/etiquetas/consultar&formato=md) | GET | Consultar etiquetas de CRM |
| [`formas_pagamento/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/formas_pagamento/consultar&formato=md) | GET | Consultar formas de pagamento |
| [`fotos/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/fotos/consultar&formato=md) | GET | Consultar fotos |
| [`grade/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/grade/atualizar&formato=md) | POST | Atualizar grade (tamanho) |
| [`grade/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/grade/cadastrar&formato=md) | POST | Cadastrar grades (tamanhos) |
| [`grade/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/grade/consultar&formato=md) | GET | Consultar grades (tamanhos) |
| [`imagens/novo_token`](https://api.viashopmoda.com.br/docs-api/?p=recursos/imagens/novo_token&formato=md) | GET | Renovar o link de uma imagem |
| [`imagens/remover`](https://api.viashopmoda.com.br/docs-api/?p=recursos/imagens/remover&formato=md) | POST | Remover fotos de um produto |
| [`imagens/upload`](https://api.viashopmoda.com.br/docs-api/?p=recursos/imagens/upload&formato=md) | POST | Enviar foto de produto ou de estampa |
| [`leads/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/leads/cadastrar&formato=md) | POST | Cadastrar lead |
| [`leads/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/leads/consultar&formato=md) | GET | Consultar leads |
| [`limites_api/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/limites_api/consultar&formato=md) | GET | Consultar saldo de requisições do dia |
| [`limites_api/solicitar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/limites_api/solicitar&formato=md) | POST | Solicitar aumento de limite (desativada) |
| [`loja/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/loja/consultar&formato=md) | GET | Consultar dados da loja |
| [`pedido/associar_codexterno`](https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/associar_codexterno&formato=md) | POST | Associar número do pedido no ERP |
| [`pedido/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/atualizar&formato=md) | POST | Atualizar status do pedido |
| [`pedido/atualizar_notafiscal`](https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/atualizar_notafiscal&formato=md) | POST | Informar nota fiscal do pedido |
| [`pedido/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/cadastrar&formato=md) | POST | Cadastrar pedido criado fora da loja |
| [`pedido/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/consultar&formato=md) | GET | Consultar pedidos |
| [`peso/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/peso/atualizar&formato=md) | POST | Atualizar tipo de produto (peso) |
| [`peso/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/peso/cadastrar&formato=md) | POST | Cadastrar tipos de produto (pesos) |
| [`peso/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/peso/consultar&formato=md) | GET | Consultar tipos de produto (pesos) |
| [`preco/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/preco/atualizar&formato=md) | POST | Atualizar preço de variações |
| [`produto/alterar_colecao`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/alterar_colecao&formato=md) | POST | Mover produtos de coleção |
| [`produto/alterar_precos`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/alterar_precos&formato=md) | POST | Alterar preços de produtos |
| [`produto/associar_comprejunto`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/associar_comprejunto&formato=md) | POST | Definir produtos do Compre Junto |
| [`produto/associar_supervitrine`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/associar_supervitrine&formato=md) | POST | Agrupar produtos na SuperVitrine |
| [`produto/atualizar_textos`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/atualizar_textos&formato=md) | POST | Atualizar textos e SEO do produto |
| [`produto/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/cadastrar&formato=md) | POST | Cadastrar ou atualizar produto |
| [`produto/campos`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/campos&formato=md) | GET | Listar campos do cadastro de produto |
| [`produto/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/consultar&formato=md) | GET | Consultar produtos |
| [`produto/desativar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/desativar&formato=md) | POST | Desativar produto |
| [`produto/ocorrencias`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/ocorrencias&formato=md) | GET | Ver por que um produto não aparece à venda |
| [`produto/verificar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/verificar&formato=md) | POST | Verificar se produtos existem |
| [`sacola/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/sacola/consultar&formato=md) | GET | Consultar itens de um pedido |
| [`sacola_abandonada/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/sacola_abandonada/consultar&formato=md) | GET | Consultar sacola abandonada |
| [`status_pedido/associar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/status_pedido/associar&formato=md) | POST | Associar nomes de status do ERP |
| [`status_pedido/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/status_pedido/consultar&formato=md) | GET | Consultar status de pedido da loja |
| [`vendedores/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/vendedores/consultar&formato=md) | GET | Consultar vendedores |


## Suporte

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