# Documentação da API ViaShopModa > API REST da plataforma de e-commerce ViaShopModa (moda, atacado e varejo). Usada por ERPs e integradores para manter produtos, estoque, preços, clientes e pedidos sincronizados com a loja virtual. Toda chamada tem o formato https://api.viashopmoda.com.br/via/{recurso}/{operacao}/{TOKEN}; consultas usam GET com filtros na query string e gravações usam POST com corpo JSON. Este arquivo reúne toda a documentação (regras para IA, guias de processo e referência de cada endpoint). Gerado em 19/11/2026 03:16. Versão navegável: https://api.viashopmoda.com.br/docs-api/ --- # Regras para quem está lendo (pessoa ou IA) Este texto é a documentação oficial da API ViaShopModa. Se você é uma IA ajudando um desenvolvedor, siga estas regras: 1. **Fonte única.** Responda só com o que está escrito aqui. Não complete lacunas com o que "costuma ser" em outras APIs de e-commerce. 2. **Nomes exatos.** Use rotas, nomes de campos e valores exatamente como estão escritos, inclusive maiúsculas, acentos e espaços. Exemplo: o status `"Aguardando Pagamento"` tem "P" maiúsculo e `"Aguardando pagamento"` é recusado. 3. **Não invente campos.** Se um campo não aparece na tabela de campos do endpoint, ele não existe para aquele endpoint. 4. **Quando não estiver documentado**, diga claramente "isto não está documentado" e indique o suporte: api@viashopmoda.com.br. Não suponha. 5. **Processos têm ordem.** Os guias de processo dizem a ordem das chamadas e quem é responsável por cada passo (ERP ou ViaShopModa). Siga essa ordem nas respostas. 6. **Regras do texto valem mais que a tabela.** Quando a seção "Regras" ou "Atenção" de uma página contradiz a descrição de um campo na tabela, vale a regra do texto (ela foi conferida com o código da API). 7. **Formato de toda chamada:** `https://api.viashopmoda.com.br/via/{recurso}/{operacao}/{TOKEN}`. O token vai no caminho da URL (não em cabeçalho). Consultas são `GET` com filtros na query string; gravações são `POST` com corpo JSON e `Content-Type: application/json`. 8. **Webhooks antes de polling.** Para saber de pedidos, clientes e estoque novos, a integração deve receber webhooks. Consultas repetidas em intervalos curtos consomem o limite diário compartilhado da loja. 9. **Limites:** 1 requisição por segundo, 2.500 por dia por loja (somando todos os tokens da loja), 20 registros por página nas consultas e 20 itens por lote. --- ## 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. --- ## Glossário > O que cada termo significa nesta API — vários nomes não são os que um ERP costuma usar. Fonte: https://api.viashopmoda.com.br/docs-api/?p=glossario · 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. ### Catálogo | Termo na API | O que é | Rota | Exemplo | |---|---|---|---| | **produto** | O modelo da peça, identificado pelo `cod_ref`. Tem título, descrição, preços e fotos. | `produto/*` | `VES001` — Vestido xadrez | | **variação** / **SKU** | Uma 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/atualizar` | `VES001` tamanho P na cor Azul | | **grade** | O **tamanho** da variação. | `grade/*` | `P`, `M`, `G`, `38` | | **estampa** | A **cor ou estampa** da variação. Pode ter uma imagem (estampa) ou uma cor sólida em hexadecimal (cor). | `estampa/*` | `AZUL CLARO`, `FLORAL` | | **cor** | Estampa do tipo cor sólida (hexadecimal), pré-definida pelo sistema. Só consulta. | `cor/consultar` | `PRETO` = `#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ção** | Agrupamento de produtos na vitrine (temporada, linha, lançamento). Coleção inativa esconde os produtos. | `colecao/*` | `INVERNO 2026` | | **SuperVitrine** | Grupo 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_supervitrine` | `001 - Preto`, `001 - Verde` | | **Compre Junto** | Produtos 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ódigo | De quem é | Onde aparece | |---|---|---| | `id` / `cod_produto` / `cod_grade` / `cod_estampa` | Gerado pela loja (ViaShopModa). | Respostas das consultas e do cadastro. | | `cod_ref` | Có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_barras` | Có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_gtin` | GTIN/EAN da variação, quando diferente do `cod_barras`. | `produto/cadastrar` | | `cod_externo` | Có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_pedido` | Número do pedido na loja: **6 dígitos** (ex.: `111111`). | `pedido/*` | | `numero_pedido_externo` | Número do pedido no **ERP**. | `pedido/associar_codexterno`, `pedido/cadastrar` | | `cod_cliente`, `id` de cupom, lead e vendedor | Identificadores **codificados** (texto como `"MTIz"`), não números. Use exatamente como recebidos. | `cliente/*`, `cupom/*`, `leads/*`, `vendedores/*` | ### Clientes | Termo | O que é | |---|---| | `tipo_pessoa` | `F` pessoa física, `J` pessoa jurídica, `E` cliente do exterior. | | **Revendedor** | Cliente pessoa física que compra no atacado (padrão para `F`). | | **Lojista** | Cliente pessoa jurídica (padrão para `J` e `E`). | | **Consignado** | Cliente que compra em consignação, com valor máximo de compra (`compra_maxima_atacado`). | | `liberado_para_comprar` | `S` = pode fazer login e comprar. Qualquer outro valor deixa o cadastro aguardando liberação da loja. | | **vendedor** | Usuário da loja responsável pelo cliente (vendedora, representante). | | **lead** | Contato que ainda não é cliente: deixou nome e e-mail ou WhatsApp na loja. | | **etiqueta** | Marcador de CRM aplicado ao cliente. | ### Vendas | Termo | O que é | |---|---| | **atacado** / **varejo** | Os 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". | | **subpedido** | Parte do pedido com tipo de venda, pagamento e rastreio. Não tem rota própria: vai dentro do corpo de `pedido/*`. | | **sacola** | Os itens de um pedido. | | **sacola abandonada** | Itens que um cliente identificado colocou na sacola sem finalizar o pedido. | | **pedido alterado** | A loja cancela o pedido original e cria um novo com outro número. Veja o guia [Pedidos](https://api.viashopmoda.com.br/docs-api/?p=guias/pedidos&formato=md). | ### Integração | Termo | O que é | |---|---| | **token** | Credencial da loja para a API. Vai no caminho da URL. | | **webhook** | Aviso que a ViaShopModa envia ao ERP quando algo acontece (pedido novo, cliente novo…). | | **automação** / **assíncrono** | Algumas rotas não executam na hora: colocam a ação numa fila e devolvem `automacao_id`. Acompanhe com `automacao/consultar`. | | **lote** | Rotas que recebem uma lista: no máximo **20 itens** por requisição. | --- ## Integração ERP — visão geral > O que o ERP envia para a loja, o que a loja avisa ao ERP e a ordem de implementação recomendada. Fonte: https://api.viashopmoda.com.br/docs-api/?p=guias/integracao-erp · Atualizado em 18/11/2026 ### O que a integração faz A integração mantém a loja virtual e o ERP com os mesmos dados. Cada lado é dono de uma parte: | Dado | Dono (quem cria e altera) | Direção | |---|---|---| | Produtos, variações, fotos | ERP | ERP → loja, pela API | | Estoque | ERP | ERP → loja, pela API | | Preços | ERP | ERP → loja, pela API | | Clientes | Os dois (o cliente pode se cadastrar na loja) | Loja → ERP por webhook; ERP → loja pela API | | Pedidos feitos na loja | Loja | Loja → ERP por webhook | | Status, rastreio e nota fiscal do pedido | ERP | ERP → loja, pela API | | Pedidos feitos fora da loja (opcional) | ERP | ERP → loja, pela API | ```text API (o ERP chama) ┌────────────────────────────┐ │ produtos, estoque, preços, │ │ clientes, status, NF │ ERP ───┘ └──▶ Loja (ViaShopModa) ◀──┐ ┌─── │ pedido novo / cancelado, │ │ cliente novo, lead, ... │ └────────────────────────────┘ Webhooks (a loja avisa) ``` ### Ordem de implementação recomendada 1. **Leia** a [Introdução](https://api.viashopmoda.com.br/docs-api/?p=inicio&formato=md) e o [Glossário](https://api.viashopmoda.com.br/docs-api/?p=glossario&formato=md). 2. **Catálogo** — carga inicial de produtos com estoque. Guia [Catálogo: carga inicial](https://api.viashopmoda.com.br/docs-api/?p=guias/catalogo-carga-inicial&formato=md). 3. **Estoque e preço contínuos** — enviar só o que mudou. Guia [Estoque e preço](https://api.viashopmoda.com.br/docs-api/?p=guias/estoque-e-preco&formato=md). 4. **Pedidos** — receber por webhook, reservar estoque, devolver número, status e nota. Guia [Pedidos](https://api.viashopmoda.com.br/docs-api/?p=guias/pedidos&formato=md). 5. **Clientes** — receber os cadastros da loja e, se for o caso, enviar os do ERP. Guia [Clientes](https://api.viashopmoda.com.br/docs-api/?p=guias/clientes&formato=md). 6. **Webhooks** — configurar as URLs e tratar reenvios. Guia [Webhooks](https://api.viashopmoda.com.br/docs-api/?p=guias/webhooks&formato=md). 7. **Antes de produção** — [Checklist](https://api.viashopmoda.com.br/docs-api/?p=guias/checklist-producao&formato=md). ### Responsabilidades do ERP - Receber os webhooks e responder rápido; processar em segundo plano se precisar. - Processar **todos** os pedidos desde a criação, pagos ou não, e reservar o estoque. - Processar cancelamentos e liberar a reserva — inclusive o cancelamento que acontece quando um pedido é alterado. - Informar o número do pedido no ERP (`pedido/associar_codexterno`) depois de criar cada pedido. - Enviar ao estoque da loja **só as variações que mudaram**, logo depois de cada movimentação. - Tratar erros: ler `msg_erro`, corrigir e não reenviar a mesma requisição em loop. - Respeitar os limites: 1 requisição por segundo, 2.500 por dia (compartilhado entre todos os tokens da loja), 20 itens por lote. - Não fazer consultas repetidas para "descobrir novidades" que chegam por webhook. ### Responsabilidades da ViaShopModa - Baixar o estoque da loja no momento em que o pedido é criado. - Avisar o ERP por webhook sobre pedidos, clientes, leads e sacolas abandonadas. - Em alteração de pedido: cancelar o original, esperar 4 minutos e criar o novo. - Validar cada requisição e responder com o motivo quando recusar. ### Por que webhooks e não consultas periódicas Consultar a API a cada poucos segundos para ver se há pedido novo consome o limite diário da loja inteira (2.500 requisições, compartilhadas entre todos os tokens). Os webhooks avisam no momento em que algo acontece, sem custo de requisição para o ERP. Uma **conferência periódica** com folga (por exemplo, de hora em hora, pedidos alterados no período) é bem-vinda para recuperar webhooks perdidos. O que não deve existir é polling em intervalos curtos. Se a integração precisar de mais requisições do que o limite, fale com api@viashopmoda.com.br antes de ir para produção: ampliar o limite pode gerar custo adicional de infraestrutura para a loja. --- ## Catálogo — carga inicial e manutenção de produtos > Como enviar os produtos do ERP para a loja — o que é criado automaticamente, a ordem das chamadas e o que acontece ao reenviar um produto. Fonte: https://api.viashopmoda.com.br/docs-api/?p=guias/catalogo-carga-inicial · Atualizado em 18/11/2026 ### Resumo em 30 segundos 1. Para cada produto, faça **um** `POST produto/cadastrar` com o produto e **todas** as variações (tamanho × cor) em `estoque`, já com quantidade. 2. Tipo, gênero, coleção, grades e estampas são **criados automaticamente pelo nome** se ainda não existirem. Não é preciso cadastrá-los antes. 3. Envie as fotos com `imagens/upload` (uma requisição por foto, identificando a variação pelo `cod_barras`). 4. Depois da carga, mantenha estoque e preço com as rotas de lote (guia [Estoque e preço](https://api.viashopmoda.com.br/docs-api/?p=guias/estoque-e-preco&formato=md)). ### Como o catálogo é organizado ```text produto (cod_ref "VES001", título, descrição, preços, tipo, gênero, coleção) ├── variação: grade "P" × estampa "AZUL" → cod_barras, quantidade, preço diferenciado (opcional) ├── variação: grade "M" × estampa "AZUL" → ... └── variação: grade "P" × estampa "FLORAL" → ... ``` Veja os nomes no [Glossário](https://api.viashopmoda.com.br/docs-api/?p=glossario&formato=md). Atenção: o **tipo** do produto é a rota `peso`, e o **gênero** é a rota `categoria`. ### Passo a passo da carga inicial #### 1. (Opcional) Conferir os cadastros auxiliares Se o ERP precisa usar os ids da loja, consulte o que já existe: - tipos: `GET peso/consultar` - gêneros: `GET categoria/consultar` - coleções: `GET colecao/consultar` - grades: `GET grade/consultar` - estampas: `GET estampa/consultar` Não é obrigatório: `produto/cadastrar` aceita **nomes** e cria o que faltar. #### 2. Cadastrar cada produto com as variações ```json { "cod_ref": "VES001", "titulo": "VESTIDO XADREZ FLANELA", "descricao": "Vestido em flanela leve.
Modelagem: reta", "tipo": "Vestido", "genero": "Feminino", "colecao": "Inverno 2026", "preco_atacado": 49.99, "preco_varejo": 99.99, "peso": 350, "estoque": [ { "grade": { "nome": "P" }, "estampa": { "nome": "AZUL CLARO" }, "cod_barras": "7890000000101", "quantidade": 5 }, { "grade": { "nome": "M" }, "estampa": { "nome": "AZUL CLARO" }, "cod_barras": "7890000000102", "quantidade": 8 }, { "grade": { "nome": "G" }, "estampa": { "nome": "AZUL CLARO" }, "cod_barras": "7890000000103", "quantidade": 3 } ] } ``` Detalhes e todas as regras: [`produto/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/cadastrar&formato=md). #### 3. Enviar as fotos Uma requisição por foto. A foto fica ligada ao produto e à estampa da variação do `cod_barras` informado. ```json { "produto": { "cod_barras": "7890000000101", "arquivo": "https://seu-servidor.com.br/fotos/VES001-azul-1.jpg" } } ``` O upload é **assíncrono**: a resposta confirma que entrou na fila. Detalhes: [`imagens/upload`](https://api.viashopmoda.com.br/docs-api/?p=recursos/imagens/upload&formato=md). #### 4. Conferir se o produto está à venda `GET produto/ocorrencias?id={id}` lista o que impede o produto de aparecer na loja: preço zerado, sem foto, sem estoque, coleção inativa etc. ### Reenviar um produto (atualização) `produto/cadastrar` é também a rota de **atualização**: o produto é localizado pelo `cod_ref`. > **Importante:** ao reenviar, as variações do produto são **substituídas** pelas enviadas. Uma variação que não estiver no `estoque` enviado **deixa de existir**. Sempre envie o produto completo, com todas as variações e as quantidades atuais. Ao reenviar, a loja **mantém** as fotos, os produtos relacionados e a SuperVitrine, e **reativa** o produto se ele estava desativado. Para mudar só o estoque ou só o preço, **não** reenvie o produto: use `estoque/atualizar`, `preco/atualizar` ou `produto/alterar_precos`. Para mudar só título, descrição, SEO ou vídeos, use [`produto/atualizar_textos`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/atualizar_textos&formato=md): ele não mexe em preço nem em estoque. ### Desativar um produto `POST produto/desativar` com `{"id": 123}` tira o produto da loja e **apaga as variações**. Para voltar a vender, envie o produto completo de novo com `produto/cadastrar`. ### Organizar a vitrine | Para | Use | |---|---| | Mover vários produtos de coleção | [`produto/alterar_colecao`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/alterar_colecao&formato=md) | | Mostrar as outras cores de um modelo cadastrado em vários produtos | [`produto/associar_supervitrine`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/associar_supervitrine&formato=md) | | Sugerir produtos relacionados | [`produto/associar_comprejunto`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/associar_comprejunto&formato=md) | | Guardar o código do ERP em produto, tipo, grade ou estampa | [`cod_externo/associar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cod_externo/associar&formato=md) | ### Erros comuns de integração - Cadastrar tipo, gênero, grade e estampa um por um antes do produto, gastando requisições. → Não é preciso: o cadastro do produto cria pelo nome. - Reenviar o produto com só a variação que mudou. → As outras variações são apagadas. - Repetir a mesma combinação grade × estampa no `estoque`. → O cadastro é recusado. - Usar `cod_barras` repetido entre variações ou produtos. → Estoque, preço e foto não conseguem achar a variação certa. - Mandar o produto inteiro para mudar o estoque. → Use `estoque/atualizar`, que é mais leve e não recria as variações. --- ## Estoque e preço — atualização contínua > Como manter estoque e preços em dia depois da carga inicial, sem estourar os limites. Fonte: https://api.viashopmoda.com.br/docs-api/?p=guias/estoque-e-preco · Atualizado em 18/11/2026 ### Resumo em 30 segundos - A cada movimentação no ERP (entrada, saída, ajuste, reserva de pedido), envie **só as variações que mudaram** com [`estoque/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/estoque/atualizar&formato=md): lista de até 20 itens com `cod_barras` e a **quantidade disponível final**. - Para mudar o preço de **todas as variações** de um produto: [`produto/alterar_precos`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/alterar_precos&formato=md). - Para dar um preço diferente a **uma variação**: [`preco/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/preco/atualizar&formato=md). ### Estoque #### O que enviar `quantidade` é o **saldo disponível para venda** — não é a quantidade a somar ou subtrair. ```json [ { "cod_barras": "7890000000101", "quantidade": 4 }, { "cod_barras": "7890000000102", "quantidade": 0 } ] ``` A variação pode ser identificada por **um** destes: 1. `cod_barras` (recomendado); 2. `cod_externo` da variação; 3. `cod_produto` + `cod_grade` + `cod_estampa`. #### Como o estoque da loja se comporta - Quando um pedido é criado na loja, a ViaShopModa **já baixa** o estoque. O ERP precisa reservar o pedido (guia [Pedidos](https://api.viashopmoda.com.br/docs-api/?p=guias/pedidos&formato=md)) para que o saldo que ele envia depois já desconte essa venda. - Saldo negativo vira **0**. - A loja pode ter configurado uma **margem de segurança** de estoque (ex.: sempre mostrar 2 a menos). Ela é aplicada automaticamente sobre a quantidade enviada; a resposta informa a margem em `gordura`. #### Quando enviar | Evento no ERP | Enviar | |---|---| | Entrada de mercadoria, ajuste de inventário | As variações afetadas | | Venda em outro canal (loja física, marketplace) | As variações vendidas | | Pedido da loja reservado no ERP | Nada (a loja já baixou) — a menos que o saldo do ERP fique diferente | | Cancelamento processado no ERP | As variações liberadas | > **Não** envie o estoque inteiro em intervalos fixos. Com 2.500 requisições por dia e 20 itens por requisição, isso esgota o limite e atrasa as atualizações que importam. #### Conferência Para comparar saldos, use `GET estoque/consultar` (sem filtro lista 100 variações por página) — de preferência fora do horário de pico e no máximo uma vez por dia. ### Preço Cada produto tem quatro preços: `preco_atacado`, `preco_varejo`, `preco_atacado_promo`, `preco_varejo_promo`. | Situação | Rota | Observação | |---|---|---| | Mudar o preço do produto (vale para todas as variações) | `produto/alterar_precos` | Até 20 produtos por requisição, por `cod_produto` ou `cod_ref`. | | Uma variação com preço diferente (ex.: tamanho GG mais caro) | `preco/atualizar` | Até 20 variações. `null` volta a usar o preço do produto. | | Reenvio completo do produto | `produto/cadastrar` | Também grava os preços, mas recria as variações. | #### Promoção ("de / por") Ao **enviar**: `preco_*` = preço normal; `preco_*_promo` = preço promocional, **menor** que o normal. A loja passa a vender pelo promocional e mostra o normal riscado ("de R$ 129,90 por R$ 99,90"). ```json { "preco_varejo": 129.90, "preco_varejo_promo": 99.90 } ``` - Em `produto/cadastrar`, um promocional **maior ou igual** ao preço normal é ignorado (sem promoção). - Para encerrar a promoção, envie de novo sem o campo `*_promo` (ou com `0`). > **Atenção ao consultar:** a loja grava invertido. Em `produto/consultar`, `preco_*` é o preço **de venda** (o promocional, se houver) e `preco_*_promo` é o preço **"de"** (o normal). Sem promoção, `preco_*_promo` vem `0.00`. #### Varejo vazio - Em `produto/cadastrar`: varejo não enviado = igual ao atacado. - Em `produto/alterar_precos`: varejo `0` = atacado + a margem sugerida configurada na loja. ### Erros comuns de integração - Enviar a quantidade movimentada (`-2`) em vez do saldo final. - Mandar mais de 20 itens: em `produto/alterar_precos` o excedente é **descartado** com um aviso em `msg_alerta`; nas outras rotas a requisição é recusada. - Atualizar o preço de cada variação quando o preço é o mesmo do produto. Use o preço do produto e deixe a variação com `null`. --- ## Clientes > Como os cadastros de clientes circulam entre a loja e o ERP — cadastro, atualização, duplicidade, consignado, vendedor e etiquetas. Fonte: https://api.viashopmoda.com.br/docs-api/?p=guias/clientes · Atualizado em 18/11/2026 ### Resumo em 30 segundos - Clientes podem nascer **na loja** (o próprio cliente se cadastra) ou **no ERP**. - Cliente novo na loja → a ViaShopModa avisa o ERP por **webhook**. O ERP cria o cliente e informa o código dele com [`cliente/associar_codexterno`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/associar_codexterno&formato=md). - Cliente novo no ERP → [`cliente/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/cadastrar&formato=md). Se o CPF, CNPJ ou e-mail já existir, a loja **não cadastra de novo** e devolve o `cod_cliente` existente (HTTP 409). - Alterações → [`cliente/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/atualizar&formato=md), enviando só os campos que mudaram. ### Fluxo: cliente se cadastra na loja ```text Cliente Loja (ViaShopModa) ERP | cadastra-se | | |-------------------->| | | |-- webhook: cliente novo ----------->| cria o cliente | |<-- POST cliente/associar_codexterno-| {"email":"...", "cod_externo":"C-1020"} ``` ### Fluxo: cliente nasce no ERP ```text ERP Loja (ViaShopModa) |-- POST cliente/cadastrar ------------------>| |<-- 200 {cod_cliente:"MTIz", cadastro:true} -| cliente novo |<-- 409 {cod_cliente:"MTIz", cadastro:false}-| já existia (mesmo CPF/CNPJ ou e-mail) ``` Nos dois casos, guarde o `cod_cliente` devolvido. ### Regras importantes - **Identidade:** o cliente é único por **CPF/CNPJ** e por **e-mail**. - **Tipo de pessoa:** `F` exige CPF e dados pessoais; `J` exige CNPJ e dados da empresa; `E` (exterior) dispensa documento e endereço brasileiro. - **Liberação:** `liberado_para_comprar: "S"` libera o login. Sem isso, o cadastro fica aguardando a loja liberar. Em cidades ou estados com cliente exclusivo, o `S` pode ser trocado por "aguardando", com aviso. - **Vendedor:** envie `vendedor` com `id`, `email` ou `whatsapp` de um vendedor (veja [`vendedores/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/vendedores/consultar&formato=md)), ou `"sortear"` para a loja escolher em rodízio. - **O que a atualização não muda:** tipo de pessoa, nome, empresa, responsável, IE, CPF, CNPJ, condição diferenciada, compra mínima, origem e moeda. Esses só mudam pelo painel da loja. - **Consignado:** [`cliente/atualizar_consignado`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/atualizar_consignado&formato=md) define o valor máximo de compra. - **Etiquetas de CRM:** [`cliente/etiquetas`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/etiquetas&formato=md), com os ids de [`etiquetas/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/etiquetas/consultar&formato=md). ### Leads Lead é quem deixou nome e e-mail ou WhatsApp, mas ainda não tem cadastro. A loja avisa por webhook; também é possível consultar com [`leads/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/leads/consultar&formato=md) e cadastrar com [`leads/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/leads/cadastrar&formato=md) (ex.: formulário de landing page). ### Erros comuns de integração - Tratar o `409` de `cliente/cadastrar` como falha. É o aviso de que o cliente já existe — use o `cod_cliente` da resposta. - Usar `cliente/cadastrar` para atualizar. Use `cliente/atualizar`. - Converter `cod_cliente` para número. É um texto codificado; use como recebido. - Enviar telefone de cliente do exterior sem o código do país (`+1...`). --- ## Pedidos > Ciclo de vida completo de um pedido entre a loja e o ERP — criação, reserva de estoque, número no ERP, status, nota fiscal, cancelamento e alteração. Fonte: https://api.viashopmoda.com.br/docs-api/?p=guias/pedidos · Atualizado em 18/11/2026 ### Resumo em 30 segundos 1. O cliente fecha o pedido na loja. A ViaShopModa **já baixa o estoque** dos itens nesse momento. 2. A ViaShopModa envia um **webhook** ao ERP com o pedido — **em qualquer status**, inclusive não pago. 3. O ERP cria o pedido no sistema dele e **reserva o estoque**. 4. O ERP informa à ViaShopModa o número que o pedido ganhou no ERP: [`pedido/associar_codexterno`](#3-o-erp-informa-o-numero-do-pedido-no-erp). 5. Conforme o pedido anda no ERP, o ERP atualiza o status na loja: [`pedido/atualizar`](#4-o-erp-atualiza-o-status). 6. Ao faturar, o ERP envia a nota fiscal: [`pedido/atualizar_notafiscal`](#5-nota-fiscal). Quando a vendedora **altera** um pedido, a ViaShopModa **cancela o pedido original e cria um novo** — veja [Alteração de pedido](#alteracao-de-pedido-cancelamento-4-minutos-novo-pedido). ### Quem faz o quê | Passo | Responsável | Como | |---|---|---| | Baixar estoque ao criar o pedido | ViaShopModa | Automático | | Avisar o ERP de pedido novo, cancelado ou alterado | ViaShopModa | Webhook | | Criar o pedido no ERP e reservar o estoque | ERP | No sistema do ERP | | Informar o número do pedido no ERP | ERP | `POST pedido/associar_codexterno` | | Atualizar status (pago, em transporte, entregue, cancelado) | ERP | `POST pedido/atualizar` | | Informar a nota fiscal | ERP | `POST pedido/atualizar_notafiscal` | | Cancelar o pedido e liberar a reserva quando receber o webhook de cancelamento | ERP | No sistema do ERP | | Enviar à loja o estoque atualizado depois de qualquer movimentação | ERP | `POST estoque/atualizar` | ### Fluxo de um pedido novo ```text Cliente Loja (ViaShopModa) ERP | fecha pedido | | |------------------>| | | | baixa o estoque dos itens | | |-- webhook: pedido 111111 ---------->| | | | cria o pedido e reserva o estoque | |<-- POST pedido/associar_codexterno -| {"numero_pedido":"111111","numero_pedido_externo":"ERP-98765"} | | | | |<-- POST pedido/atualizar -----------| status "Pagamento autorizado, aguardando envio" | |<-- POST pedido/atualizar_notafiscal-| URL da nota | |<-- POST pedido/atualizar -----------| status "Pedido em transporte" + rastreio | |<-- POST pedido/atualizar -----------| status "Pedido entregue" ``` #### 1. O pedido é criado na loja A ViaShopModa baixa o estoque assim que o pedido é criado, **antes do pagamento**. Por isso o ERP também precisa receber e reservar o pedido desde a criação. > **Não espere o pedido ser pago para levá-lo ao ERP.** Se o ERP só importar pedidos pagos, durante esse intervalo ele vai considerar disponíveis peças que a loja já vendeu, e os saldos dos dois sistemas vão divergir. #### 2. O ERP recebe o webhook O formato do webhook de pedido está na [documentação de webhooks](https://documenter.getpostman.com/view/9868245/2sBXcHhyfT). Se precisar dos dados completos do pedido (cliente, itens, pagamento, vendedor), consulte: ```bash curl "https://api.viashopmoda.com.br/via/pedido/consultar/SEU_TOKEN?pedido=111111" ``` O número do pedido na ViaShopModa tem sempre **6 dígitos** (ex.: `111111`). #### 3. O ERP informa o número do pedido no ERP Depois de criar o pedido, o ERP envia o número que o pedido ganhou no sistema dele. É isso que liga os dois registros. | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/pedido/associar_codexterno/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | | **Processamento** | **Assíncrono.** A resposta confirma que a ação entrou na fila (`automacao_id`). Acompanhe com [`automacao/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/automacao/consultar&formato=md). | ```json { "numero_pedido": "111111", "numero_pedido_externo": "ERP-98765" } ``` | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `numero_pedido` | string | **sim** | Número do pedido na ViaShopModa (6 dígitos). | | `numero_pedido_externo` | string | **sim** | Número do pedido no ERP. | A resposta de sucesso confirma que a associação **entrou na fila** e será gravada em seguida: ```json { "retorno": true, "msg": "A automação 'pedido.cadastrar_codexterno' foi cadastrada e será processada.", "automacao_id": "123456", "consultar_automacao": "via/automacao/consultar/{TOKEN}?id=123456" } ``` Para confirmar que foi gravada, use [`automacao/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/automacao/consultar&formato=md) ou consulte o pedido por `?numero_pedido_externo=`. Respostas de erro (`msg_erro`) — estas são verificadas na hora, antes de entrar na fila: | Mensagem | Significado | |---|---| | `numero_pedido e numero_pedido_externo são obrigatórios.` | Faltou um dos dois campos. | | `associação já realizada.` | Esse par já estava associado. Pode tratar como sucesso. | | `numero_pedido_externo já associado ao pedido NNNNNN.` | O número do ERP já está ligado a **outro** pedido. Verifique o ERP. | | `pedido não encontrado.` | O `numero_pedido` não existe na loja. | | `pedido já associado ao numero_pedido_externo:XXXX.` | O pedido já tem outro número de ERP. Um pedido só aceita uma associação. | #### 4. O ERP atualiza o status | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/pedido/atualizar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ```json { "pedido": { "numero_pedido": "111111", "status_pedido": "Pedido em transporte", "rastreio_frete": "BR123456789BR" } } ``` `status_pedido` precisa ser **exatamente** um destes textos (com as mesmas maiúsculas e acentos): | Status | Conta como pago? | |---|---| | `Pedido em análise` | não | | `Aguardando Pagamento` | não | | `Falha na tentativa de pagamento` | não | | `Pagamento efetuado, aguardando captura` | sim | | `Pagamento autorizado, aguardando envio` | sim | | `Pedido em transporte` | sim | | `Pedido entregue` | sim | | `Pedido cancelado` | — | > **Atenção:** `Aguardando Pagamento` tem o "P" maiúsculo. `Aguardando pagamento` é recusado. Outros campos aceitos em `pedido/atualizar`: `forma_pagamento`, `url_notafiscal` e, dentro de `subpedido` (ou do próprio `pedido`), `parcelas_pagamento`, `numero_comprovante` e `rastreio_frete`. **Cancelar pela API devolve o estoque.** Quando o ERP envia `Pedido cancelado`, a ViaShopModa devolve ao estoque da loja os itens que tinham sido baixados. Um pedido cancelado pode voltar para outro status; a loja registra isso nas observações do pedido. #### 5. Nota fiscal | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/pedido/atualizar_notafiscal/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ```json { "pedido": { "numero_pedido": "111111", "url_notafiscal": "https://seu-erp.com.br/nfe/35260000000000000000550010000012341000012345.xml" } } ``` Resposta de sucesso: `{"retorno": true, "msg": "Url da nota fiscal cadastrada com sucesso."}`. A URL também pode ir no campo `url_notafiscal` de `pedido/atualizar`. ### Alteração de pedido (cancelamento + 4 minutos + novo pedido) No atacado é comum a vendedora incluir ou tirar itens depois que o pedido foi feito. A ViaShopModa **não edita** o pedido original: ela **cancela** o original e **cria um pedido novo**, com outro número. ```text Loja (ViaShopModa) ERP | cancela o pedido 111111 | |-- webhook: pedido 111111 cancelado ------------>| cancela no ERP e LIBERA a reserva de estoque | | | ... espera 4 minutos ... | | | | cria o pedido 111112 (com os itens novos) | |-- webhook: pedido 111112 ---------------------->| cria o pedido e reserva o estoque |<-- POST pedido/associar_codexterno -------------| {"numero_pedido":"111112", "numero_pedido_externo":"ERP-98766"} ``` 1. **Cancelamento do original.** O ERP precisa cancelar o pedido e liberar a reserva. 2. **Intervalo de 4 minutos.** É só uma margem de segurança: a ViaShopModa **não** recebe confirmação de que o ERP terminou o cancelamento. 3. **Pedido novo.** O ERP cria e reserva como em um pedido novo comum, e associa o número dele. > **Importante:** processe o cancelamento **antes** de reservar o pedido novo. Se o pedido novo chegar e o cancelamento ainda não tiver sido processado, a mesma peça fica reservada duas vezes. Para saber qual pedido substituiu o cancelado, consulte o pedido cancelado: a resposta traz `numero_pedido_alterado` com o número do pedido novo. ### Pedidos criados fora da loja Vendas feitas no ERP, na loja física ou em marketplace podem ser registradas na ViaShopModa com [`pedido/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/cadastrar&formato=md). Esse endpoint **não mexe no estoque**: depois de cadastrar, o ERP envia o saldo novo com `estoque/atualizar`. ### Conferência periódica (reconciliação) Webhooks podem falhar (ERP fora do ar, timeout). Uma conferência periódica — por exemplo, uma vez por hora — evita pedidos perdidos sem gastar o limite diário: ```bash curl "https://api.viashopmoda.com.br/via/pedido/consultar/SEU_TOKEN?data_inicial=2026-11-16&data_final=2026-11-16&data_alteracao=S" ``` - `data_alteracao=S` busca pelos pedidos **alterados** no período (não só os criados). - O resultado é paginado em 20 por página (`pagina=2`, `pagina=3`…). - **Não** faça essa consulta a cada poucos segundos: o limite de 2.500 requisições por dia é da loja inteira. ### Erros comuns de integração - Importar no ERP só pedidos pagos. → Estoque divergente. Importe todos, desde a criação. - Enviar o status com outra grafia (`"pago"`, `"PG"`, `"Aguardando pagamento"`). → Recusado. Use a tabela de status acima. (Os códigos `AN`, `PG`, `EN`… valem **só** em `pedido/cadastrar`.) - Tratar o pedido novo de uma alteração antes do cancelamento do original. → Reserva em dobro. - Esquecer o `pedido/associar_codexterno`. → A loja não sabe qual pedido do ERP corresponde a qual, e a conferência fica manual. - Usar `pedido/cadastrar` para pedidos que **vieram da loja**. → Pedido duplicado. Pedidos da loja já existem; o ERP só associa o número dele. ### Endpoints deste processo - [`pedido/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/cadastrar&formato=md) — registrar pedido criado fora da loja - `pedido/consultar` — consultar um pedido, por período, por cliente ou pelo número no ERP - `pedido/associar_codexterno` — informar o número do pedido no ERP - `pedido/atualizar` — atualizar status, pagamento, rastreio - `pedido/atualizar_notafiscal` — informar a nota fiscal - `estoque/atualizar` — enviar o saldo depois de movimentações --- ## Vendas e marketing > Cupons, sacola abandonada, formas de pagamento, status personalizados, vendedores e dados da loja. Fonte: https://api.viashopmoda.com.br/docs-api/?p=guias/vendas-e-marketing · Atualizado em 18/11/2026 ### Cupons de desconto - Criar: [`cupom/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cupom/cadastrar&formato=md). Alterar: [`cupom/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cupom/atualizar&formato=md) (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`](https://api.viashopmoda.com.br/docs-api/?p=recursos/sacola_abandonada/consultar&formato=md) traz cliente, itens com foto e valor total — útil para mensagens de recuperação. ### Formas de pagamento [`formas_pagamento/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/formas_pagamento/consultar&formato=md) 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](https://api.viashopmoda.com.br/docs-api/?p=guias/pedidos&formato=md)). Se o ERP usa outros nomes, [`status_pedido/associar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/status_pedido/associar&formato=md) grava o "de/para" e [`status_pedido/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/status_pedido/consultar&formato=md) 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`](https://api.viashopmoda.com.br/docs-api/?p=recursos/vendedores/consultar&formato=md) lista vendedores e representantes. Use o `id`, `email` ou `whatsapp` para vincular clientes a um vendedor no cadastro. ### Dados da loja [`loja/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/loja/consultar&formato=md) traz nome, CNPJ, cidade, margem sugerida de varejo e banners. --- ## Webhooks > Quais avisos a loja envia ao ERP, como configurar e como processar sem perder nem duplicar eventos. Fonte: https://api.viashopmoda.com.br/docs-api/?p=guias/webhooks · Atualizado em 18/11/2026 ### O que é Webhook é uma chamada que a ViaShopModa faz para uma URL do ERP quando algo acontece na loja. Ele substitui as consultas repetidas ("tem pedido novo?") que gastam o limite diário. ### Eventos | Evento | Quando | |---|---| | Pedido | Pedido criado, cancelado ou alterado (a alteração gera um cancelamento e, 4 minutos depois, um pedido novo). | | Cliente | Cliente se cadastrou na loja ou foi incluído pela loja. | | Lead | Visitante deixou nome e e-mail ou WhatsApp. | | Sacola abandonada | Cliente identificado deixou itens na sacola sem finalizar. | ### Formato e configuração O formato de cada webhook (corpo, cabeçalhos, autenticação) e a configuração das URLs estão na [documentação de webhooks](https://documenter.getpostman.com/view/9868245/2sBXcHhyfT). Para cadastrar ou trocar as URLs da sua integração, fale com api@viashopmoda.com.br. ### Como processar 1. **Responda rápido** com HTTP 2xx assim que receber; faça o processamento pesado depois, numa fila do ERP. 2. **Trate repetição:** o mesmo evento pode chegar mais de uma vez. Antes de criar, verifique se o registro já existe no ERP (pedido pelo `numero_pedido`, cliente pelo CPF/CNPJ ou e-mail). 3. **Respeite a ordem em alterações de pedido:** processe o cancelamento antes de reservar o pedido novo. 4. **Busque dados completos se precisar:** `pedido/consultar?pedido=`, `cliente/consultar?email=`, `sacola_abandonada/consultar?sessao=`. 5. **Confira periodicamente:** uma consulta de pedidos alterados no período (por exemplo, de hora em hora) recupera eventos perdidos enquanto o ERP estava fora do ar. ### Erros comuns de integração - URL do ERP que demora para responder porque processa tudo antes do 2xx. - Criar pedido em dobro quando o webhook chega duas vezes. - Desligar o webhook e passar a consultar a API a cada minuto: consome o limite da loja inteira. --- ## Erros, limites e paginação > Como interpretar cada resposta de erro, quando tentar de novo e como paginar consultas sem estourar o limite. Fonte: https://api.viashopmoda.com.br/docs-api/?p=guias/erros-limites-paginacao · Atualizado em 18/11/2026 ### Formato das respostas Toda resposta é JSON. Campos que podem aparecer em qualquer rota: | Campo | Significado | |---|---| | `retorno` | `true` = a operação foi feita. `false` = não foi. **Sempre confira este campo**, mesmo com HTTP 200. | | `status` | O código HTTP, repetido no corpo. | | `msg` | Mensagem de sucesso. | | `msg_erro` | Motivo da recusa. | | `msg_alerta` | Aviso: a operação foi feita, mas algo merece atenção (ex.: itens descartados, vendedor não encontrado). | | `cod_erro` | Código do erro de limite (`limite_requisicoes_dia`, `limite_requisicoes_segundo`). | ### Códigos HTTP | HTTP | Quando | Tentar de novo? | |---|---|---| | `200` com `retorno: true` | Sucesso. | — | | `200` com `retorno: false` | Recusa de regra de negócio em algumas rotas (ex.: foto já enviada, cliente já existente). | Não. Leia `msg_erro`. | | `400` | Dados inválidos, campo faltando, registro não encontrado. | **Não** sem corrigir o envio. | | `401` | Token inválido ou ainda não ativo. | Não. Confira o token. | | `409` | Cadastro duplicado (ex.: `cliente/cadastrar` com CPF/e-mail já existente). | Não. Use o registro existente (`cod_cliente` vem na resposta). | | `429` + `cod_erro: limite_requisicoes_segundo` | Mais de 1 requisição no mesmo segundo. | Sim, depois de 1 segundo. | | `429` + `cod_erro: limite_requisicoes_dia` | Limite diário da loja atingido. | Só no dia seguinte. | | `500` | Erro interno. | Uma vez, depois de alguns minutos. Se repetir, envie a resposta para api@viashopmoda.com.br. | Exemplo de recusa: ```json { "retorno": false, "status": 400, "msg_erro": "Objeto 'pedido' não enviado" } ``` ### Operações em lote Rotas que recebem lista (`estoque/atualizar`, `preco/atualizar`, `cod_barras/atualizar`, `cod_externo/associar`…) processam **item a item** e respondem com o resultado de cada um: ```json { "retorno": true, "qtd_atualizar": 3, "qtd_atualizados": 2, "qtd_nao_atualizados": 1, "atualizados": [ ... ], "nao_atualizados": [ ... ] } ``` `retorno: true` significa que **o lote** foi processado — não que todos os itens deram certo. Sempre leia `nao_atualizados` (e `erros`, quando existir) e corrija só esses itens. ### Limites | Limite | Valor | |---|---| | Requisições por segundo | **1** | | Requisições por dia | **2.500** por loja, somando **todos os tokens** da loja | | Itens por lote | **20** | | Registros por página nas consultas | **20** (estoque sem filtro: 100) | Consulte o saldo do dia com [`limites_api/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/limites_api/consultar&formato=md). #### Boas práticas - Fila no ERP com no máximo 1 requisição por segundo. - Agrupe até 20 itens por lote em vez de 20 requisições de 1 item. - Envie só o que mudou. - Use webhooks para saber de novidades; deixe consultas periódicas para conferência, com folga. - Em `429` por segundo, espere e tente de novo; em `429` por dia, pare e registre. ### Paginação Consultas com mais de 20 resultados trazem `cabecalho.paginacao`: ```json { "cabecalho": { "paginacao": { "total_registros": 52, "limite_paginas": 20, "total_paginas": 3, "pagina_atual": 1, "ultima_pagina": false } } } ``` Peça `pagina=2`, `pagina=3`… até `ultima_pagina` ser `true`. Cada página é uma requisição e conta no limite. ### Rotas assíncronas `imagens/upload`, `pedido/associar_codexterno` e `cliente/associar_codexterno` não executam na hora: a resposta traz `automacao_id`, e o resultado final aparece em [`automacao/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/automacao/consultar&formato=md) (status `cadastrado`, `pendente`, `enviado` ou `erro`). --- ## Checklist antes de ir para produção > Lista de verificação para revisar a integração antes de ligar na loja de verdade. Fonte: https://api.viashopmoda.com.br/docs-api/?p=guias/checklist-producao · Atualizado em 18/11/2026 ### Acesso - [ ] Token de produção recebido e guardado fora do código-fonte. - [ ] URLs de webhook cadastradas com a ViaShopModa (api@viashopmoda.com.br). ### Catálogo - [ ] Cada produto é enviado com **todas** as variações em `produto/cadastrar`. - [ ] `cod_barras` único por variação. - [ ] Fotos enviadas por `imagens/upload`, com URLs sem espaços nem acentos. - [ ] `produto/ocorrencias` sem pendências nos produtos de teste. ### Estoque e preço - [ ] Estoque enviado como **saldo final**, só das variações que mudaram, em lotes de até 20. - [ ] Nenhuma rotina envia o estoque inteiro em intervalos curtos. - [ ] Preço promocional enviado em `*_promo`, menor que o preço normal. ### Pedidos - [ ] Todo pedido é importado desde a criação, pago ou não, com reserva de estoque. - [ ] Cancelamento libera a reserva. - [ ] Alteração de pedido testada: cancelamento do original + pedido novo 4 minutos depois. - [ ] `pedido/associar_codexterno` enviado depois de criar cada pedido no ERP. - [ ] Status enviados com os nomes exatos da loja (ex.: `Aguardando Pagamento`). - [ ] Nota fiscal enviada com `pedido/atualizar_notafiscal`. ### Robustez - [ ] No máximo 1 requisição por segundo; fila no ERP. - [ ] Leitura de `retorno`, `msg_erro`, `msg_alerta` e de `nao_atualizados` nos lotes. - [ ] `429` por segundo → espera e tenta de novo; `429` por dia → para. - [ ] Webhook duplicado não cria registro em dobro. - [ ] Conferência periódica de pedidos alterados, com folga (não polling). - [ ] Saldo diário acompanhado com `limites_api/consultar` nas primeiras semanas. --- ## Acompanhar uma ação assíncrona > Mostra o andamento de uma ação que foi para a fila (upload de imagem, associação de código do ERP). Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/automacao/consultar · Atualizado em 18/11/2026 ### O que faz As rotas assíncronas — [`imagens/upload`](https://api.viashopmoda.com.br/docs-api/?p=recursos/imagens/upload&formato=md), [`pedido/associar_codexterno`](https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/associar_codexterno&formato=md) e [`cliente/associar_codexterno`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/associar_codexterno&formato=md) — respondem com um `automacao_id`. Esta rota mostra o que aconteceu com ele. ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/automacao/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `id` | automacao_id devolvido pela rota assíncrona. | ### Status | `status_envio` | Significado | |---|---| | `cadastrado` | Entrou na fila. | | `pendente` | Aguardando ou em nova tentativa (veja `reprogramado_para`). | | `enviado` | Executado. Confira `response_body` para o resultado. | | `erro` | Falhou. O motivo está em `response_body`. | ### Exemplo ```bash curl "https://api.viashopmoda.com.br/via/automacao/consultar/SEU_TOKEN?id=123456" ``` ```json { "automacao": { "evento": "produto.upload_foto", "data_criacao": "2026-11-16 10:00:00", "data_execucao": "2026-11-16 10:00:05", "status_envio": "enviado", "request_body": { ... }, "response_code": 200, "response_body": { ... }, "quantidade_executada": 1, "reprogramado_para": null } } ``` Não encontrada: `{"automacao": [], "msg": "automação não encontrada"}`. Sem `id`: `'id' não enviado.` ### Pode reenviar? Sim (somente leitura). Não consulte em ciclo curto: espere alguns segundos entre consultas, ou confira o resultado depois de um tempo. --- ## Consultar gêneros (categorias) > Lista os gêneros da loja (Feminino, Masculino, Infantil…). Na API, gênero = categoria. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/categoria/consultar · Atualizado em 18/11/2026 ### O que faz Lista os **gêneros** — o campo `genero` do produto. A rota se chama `categoria` por motivo histórico (veja o [Glossário](https://api.viashopmoda.com.br/docs-api/?p=glossario&formato=md)). ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/categoria/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `id` | Id do gênero. | | `nome` | Nome exato do gênero. Se vierem id e nome, vale o nome. | ### Exemplo ```bash curl "https://api.viashopmoda.com.br/via/categoria/consultar/SEU_TOKEN?nome=FEMININO" ``` ```json { "retorno": true, "categoria": [ { "id": "1", "nome": "FEMININO", "seo_title": "", "seo_description": "", "seo_h1": "", "foto": "", "tag": "feminino" } ] } ``` Nada encontrado: `retorno: false`. ### Pode reenviar? Sim (somente leitura). ### Onde entra no processo Opcional na carga do catálogo: `produto/cadastrar` aceita o nome do gênero e cria se não existir. --- ## Cadastrar gênero (categoria) > Cria um gênero pelo nome; se já existir, devolve o id do existente. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/categoria/cadastrar · Atualizado em 18/11/2026 ### O que faz Cria um gênero (campo `genero` do produto). Se o nome já existir, **não** cria outro e devolve o id do existente. Normalmente não é preciso chamar esta rota: [`produto/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/cadastrar&formato=md) cria o gênero pelo nome. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/categoria/cadastrar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Limites | Descrição | |---|---|---|---|---| | `nome` | string | **sim** | mín. 2, máx. 30, gravado em MAIÚSCULAS | | ### Regras - Nome de 2 a 30 caracteres, gravado em MAIÚSCULAS. ### Exemplo ```json { "nome": "Plus size" } ``` Criado: ```json { "retorno": true, "cadastro": true, "nome": "PLUS SIZE", "id": 10 } ``` Já existia (não é erro — use o `id`): ```json { "retorno": true, "cadastro": false, "msg_erro": "Categoria não cadastrada. Nome enviado já existe.", "nome": "PLUS SIZE", "id": "10" } ``` Erros: `Parâmetro 'nome' em 'categoria/cadastrar' não encontrado`, `Categoria não cadastrado`. ### Pode reenviar? Sim. O reenvio devolve o id existente com `cadastro: false`. --- ## Atualizar gênero (categoria) > Renomeia um gênero pelo id. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/categoria/atualizar · Atualizado em 18/11/2026 ### O que faz Troca o nome de um gênero. Os produtos ligados a ele passam a mostrar o nome novo. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/categoria/atualizar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `id` | número | **sim** | Id do gênero ([`categoria/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/categoria/consultar&formato=md)). | | `nome` | texto | **sim** | Novo nome, 2 a 30 caracteres (gravado em MAIÚSCULAS). | ### Exemplo ```json { "id": 10, "nome": "Moda plus size" } ``` ```json { "retorno": true, "nome": "MODA PLUS SIZE", "id": "10" } ``` Erros: `Parâmetros 'nome' e 'id' não encontrados.`, `Categoria não atualizada. 'ID' não encontrado ou 'nome' enviado é o mesmo.` ### Pode reenviar? O reenvio com o mesmo nome devolve o erro "nome enviado é o mesmo" — pode tratar como já atualizado. --- ## Cadastrar cliente > Cria um cliente pessoa física, jurídica ou do exterior; se o CPF/CNPJ ou e-mail já existir, devolve o cliente existente (HTTP 409). Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/cadastrar · Atualizado em 18/11/2026 ### O que faz Cadastra um cliente na loja. Antes, procura duplicidade por **CPF/CNPJ ou e-mail**: se encontrar, não cadastra e devolve o `cod_cliente` existente. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/cliente/cadastrar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Limites | Descrição | |---|---|---|---|---| | `tipo_pessoa` | string | **sim** | máx. 1 | 'F' = pessoa física: , 'J' = pessoa jurídica e 'E' = cliente do exterior. | | `email` | string | **sim** | mín. 5, máx. 150 | Usado como contato e para acessar a loja virtual. | | `senha` | string | **sim** | mín. 4 | Senha para acessar a loja virtual. | | `tipo_cliente` | string | **sim** | máx. 100 | Sempre se 'tipo_pessoa'=F será 'Revendedor' e 'tipo_pessoa'=J será 'Lojista'. Somente será alterado se enviado como 'Consignado' e o 'compra_maxima_atacado' passa a ser necessário o envio. | | `cpf` | numeric | **sim** | mín. 11, máx. 11 | Somente números. Obrigatório quando pessoa física. | | `nome_completo` | string | **sim** | máx. 150 | Nome completo do cliente. Obrigatório quando pessoa física. | | `rg` | string | não | máx. 25 | Caso inexistente enviar 'Isento'. Obrigatório quando pessoa física. | | `data_nascimento` | date | **sim** | máx. 10 | Formato 'aaaa-mm-dd'. Obrigatório quando pessoa física. | | `sexo` | string | **sim** | | 'Masculino', 'Feminino' ou 'Nenhum'. Obrigatório quando pessoa física. | | `cnpj` | string | **sim** | mín. 14, máx. 14 | Somente números. Obrigatório quando pessoa jurísica. | | `nome_empresa` | string | **sim** | máx. 150 | Nome fantasia da empresa. Obrigatório quando pessoa jurídica. | | `responsavel_empresa` | string | **sim** | máx. 150 | Nome do responsável pela empresa. Obrigatório quando pessoa jurídica. | | `ie` | string | **sim** | máx. 25 | Caso inexistente enviar 'Isento'. Obrigatório quando pessoa jurídica. | | `moeda` | string | não | máx. 3 | Para os clientes do exterior, é possível alterar sua moeda enviando o código no padrão ISO 4217. USD para dolar, EUR para euro e etc. | | `condicao_diferenciada` | double | não | máx. 11 | Representa a porcentagem de acréscimo ou desconto nos preços dos produtos. | | `compra_minima_atacado` | double | não | máx. 11 | Valor minimo para compra de atacado. | | `compra_maxima_atacado` | double | não | máx. 11 | Usado para quando tipo_cliente=Consignado, limitando o valor máximo a ser comprado. Se não enviado será zero. | | `cep` | numeric | **sim** | mín. 8, máx. 8 | Somente números no formato '37001000'. | | `endereco` | string | **sim** | máx. 150 | Caso cliente do exterior, será usado como endereço completo. | | `numero` | string | **sim** | máx. 10 | Não utilizado para clientes do exterior. | | `complemento` | string | não | máx. 50 | Não utilizado para clientes do exterior. | | `bairro` | string | **sim** | máx. 50 | Não utilizado para clientes do exterior. | | `cidade` | string | **sim** | máx. 50 | | | `estado` | string | **sim** | máx. 2 | Sigla do estado com dois caracteres. Não utilizado para clientes do exterior. | | `pais` | string | não | máx. 50 | Para países diferente de 'Brasil' usar o campo cod_pais. | | `cod_pais` | string | não | máx. 2 | Código do país no padrão ISO-2, se não enviado será utilizado 'BR'. | | `codigo_ddi` | string | não | mín. 1, aceita null | Se não enviado sempre será 55. | | `telefone_celular` | string | **sim** | máx. 50 | Se não enviado no formato: '+{CODIGO_DDI}{NUMERO_TELEFONE}' será acrescentado o DDI (relativo ao cod_pais) ao número enviado. | | `operadora_celular` | string | não | máx. 20 | Nome da operadora de telefonia. Se não enviado será cadastrado 'Outras' | | `utm_source` | string | não | máx. 70 | Se enviado é necessário enviar utm_medium e utm_campaign | | `utm_medium` | string | não | máx. 70 | Se enviado é necessário enviar utm_source e utm_campaign | | `utm_campaign` | string | não | máx. 70 | Se enviado é necessário enviar utm_source e utm_medium | | `crm` | array | não | | Frases relacionadas ao CRM do cliente | | `assinar_newsletter` | string | não | máx. 1 | 'S' ou 'N', se não enviado será cadastrado 'N'. | | `data_cadastro` | datetime | não | máx. 19 | Data de cadastro do cliente. Padrão DATETIME 'aaaa-mm-dd hh:mm:ss'. | | `liberado_para_comprar` | string | não | máx. 1 | Padrão 'N'. Podendo ser 'S' ou 'N'. Onde 'S' está liberado e 'N' NÃO está liberado. Observações: (1) O 'N' não signifca bloqueio algum, mas a não possibilidade de login. (2) Se não enviado será cadastrado como 'N'. (3) Se enviado como 'S' poderá ser alterado caso a cidade ou o estado enviado for considerado uma região exclusiva. | | `vendedor` | object | não | | Objeto para consulta do vendedor. Poderá ser usado: vendedor.id, vendedor.email ou vendedor.whatsapp para localizar o vendedor a ser atrelado ao cliente. Para consultar o vendedor [vendedores/consultar](https://api.viashopmoda.com.br/docs-api/?p=recursos/vendedores/consultar&formato=md). Se enviar 'sortear' será sorteado entre os vendedores habilitados. Se não existir, cadastro não será vinculado a nenhum vendedor. | ### Regras (valem acima da tabela) **Obrigatórios conforme `tipo_pessoa`:** | `tipo_pessoa` | Exige | Dispensa | `tipo_cliente` padrão | |---|---|---|---| | `F` (física) | `cpf`, `nome_completo`, `data_nascimento`, `sexo` (`rg` pode ser `"Isento"`) | dados da empresa | `Revendedor` | | `J` (jurídica) | `cnpj`, `nome_empresa`, `responsavel_empresa` (`ie` pode ser `"Isento"`) | dados pessoais | `Lojista` | | `E` (exterior) | — | CPF, CNPJ, RG, CEP, número, complemento, bairro, estado | `Lojista` | Sempre obrigatórios: `tipo_pessoa`, `email`, `senha`, `endereco`, `cidade`, `telefone_celular`. Para `F` e `J`, também `cep`, `numero`, `bairro` e `estado`. `tipo_cliente` pode ser omitido (a loja usa o padrão da tabela acima). - `tipo_cliente: "Consignado"` exige `compra_maxima_atacado`. - `liberado_para_comprar`: `"S"` libera o login. Qualquer outro valor (ou ausente) deixa aguardando liberação da loja. Em cidade/estado com cliente exclusivo, o `S` vira "aguardando" com aviso em `msg_alerta`. - `vendedor`: objeto com **um** de `id`, `email` ou `whatsapp` de um vendedor ([`vendedores/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/vendedores/consultar&formato=md)), ou o texto `"sortear"` (rodízio entre os vendedores habilitados). Não encontrado → cliente sem vendedor, com aviso. - UTM só é gravado se vierem os três: `utm_source`, `utm_medium`, `utm_campaign`. - Telefone de cliente do exterior: com o código do país, ex.: `+11234567890`. - Nome gravado em MAIÚSCULAS. ### Exemplo ```json { "tipo_pessoa": "F", "nome_completo": "Maria José da Silva", "cpf": "12345678909", "data_nascimento": "1986-02-15", "sexo": "Feminino", "rg": "Isento", "email": "maria@exemplo.com.br", "senha": "troque123", "cep": "37002000", "endereco": "Avenida Imigrantes", "numero": "10", "bairro": "Centro", "cidade": "Varginha", "estado": "MG", "telefone_celular": "35988887777", "liberado_para_comprar": "S", "vendedor": { "email": "vendedora@loja.com.br" } } ``` ### Respostas Cadastrado (HTTP 200): ```json { "retorno": true, "cadastro": true, "msg": "...", "cod_cliente": "MTIz", "cod_vendedor": "Mg" } ``` Já existia (HTTP 409 — não é falha): ```json { "retorno": true, "status": 409, "cadastro": false, "cod_cliente": "MTIz", "cod_vendedor": "Mg" } ``` `cod_cliente` e `cod_vendedor` são textos codificados: guarde e use como recebidos. Erros de validação vêm em `msg_erro` com o nome do campo (ex.: tamanho, formato). ### Pode reenviar? Sim: o reenvio devolve `409` com o mesmo `cod_cliente`. Os dados enviados no reenvio **não** atualizam o cadastro — use [`cliente/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/atualizar&formato=md). ### Onde entra no processo Guia [Clientes](https://api.viashopmoda.com.br/docs-api/?p=guias/clientes&formato=md). --- ## Atualizar cliente > Altera só os campos enviados de um cliente, localizado por cod_cliente, CPF, CNPJ ou e-mail na URL. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/atualizar · Atualizado em 18/11/2026 ### O que faz Atualiza um cliente existente. Só os campos enviados (e diferentes de `null`) são alterados. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/cliente/atualizar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | **Qual cliente:** informe **na URL** um destes (nesta prioridade): `?cod_cliente=`, `?cpf=`, `?cnpj=`, `?email=`. ```text https://api.viashopmoda.com.br/via/cliente/atualizar/{TOKEN}?email=maria@exemplo.com.br ``` ### Campos Os mesmos de [`cliente/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/cadastrar&formato=md), todos opcionais, **exceto** os que não podem ser alterados pela API: `tipo_pessoa`, `nome_completo`, `nome_empresa`, `responsavel_empresa`, `ie`, `cpf`, `cnpj`, `condicao_diferenciada`, `compra_minima_atacado`, origem/UTM, `moeda`. Para trocar o vendedor, envie `vendedor_email` com o e-mail de um vendedor existente. ### Exemplo ```json { "telefone_celular": "35999990000", "endereco": "Rua Nova", "numero": "200", "liberado_para_comprar": "S", "vendedor_email": "outra.vendedora@loja.com.br" } ``` Sucesso: `{"retorno": true, "msg": "Cliente alterado com sucesso"}`. Erros: | Mensagem | Causa | |---|---| | `Cliente não encontrado.` | Nenhum cliente com o filtro da URL. | | `A busca retornou mais de um cliente. Utilize 'cod_cliente' para atualizar.` | Filtro ambíguo. | | `Cliente não alterado` | Nada foi gravado. | ### Pode reenviar? Sim. ### Onde entra no processo Guia [Clientes](https://api.viashopmoda.com.br/docs-api/?p=guias/clientes&formato=md). --- ## Consultar clientes > Busca um cliente por CPF, CNPJ, e-mail ou código, ou lista os cadastrados num período. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/consultar · Atualizado em 18/11/2026 ### O que faz Devolve um cliente (filtro por documento, e-mail ou código) ou uma lista paginada (período de cadastro). É obrigatório informar algum filtro. ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/cliente/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `cpf` | CPF, só números (11 dígitos). | | `cnpj` | CNPJ, só números (14 dígitos). | | `email` | E-mail do cliente. | | `cod_cliente` | Código do cliente devolvido pela API (texto codificado, ex.: "MTIz"). | | `data_inicial` | Início do período de cadastro (aaaa-mm-dd). Usar com data_final. | | `data_final` | Fim do período de cadastro (aaaa-mm-dd). | | `pagina` | Página (20 registros por página). Ex.: pagina=2 | ### Exemplo ```bash curl "https://api.viashopmoda.com.br/via/cliente/consultar/SEU_TOKEN?email=maria@exemplo.com.br" ``` ```json { "retorno": true, "cliente": { "cod_cliente": "MTIz", "tipo_pessoa": "F", "nome_completo": "MARIA JOSÉ DA SILVA", "cpf": "12345678909", "email": "maria@exemplo.com.br", "cidade": "Varginha", "estado": "MG", "tipo_cliente": "Revendedor", "data_cadastro": "2026-11-16 09:27:11", "liberado_para_comprar": "S", "utm": "google -> cpc -> inverno", "lgpd_aceite": "S", "vendedor": { "nome": "Ana", "email": "vendedora@loja.com.br" }, "etiquetas": [ ... ] } } ``` (Exemplo resumido; a resposta traz também telefones, endereço completo, condições comerciais e dados de LGPD.) Com período: `{"retorno": true, "cabecalho": {"paginacao": {...}}, "clientes": [ ... ]}`. Não encontrado: `retorno: false`. ### Pode reenviar? Sim (somente leitura). --- ## Definir limite de cliente consignado > Torna clientes consignados e define o valor máximo de compra, por e-mail, em lote. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/atualizar_consignado · Atualizado em 18/11/2026 ### O que faz Para cada item, marca o cliente (localizado pelo e-mail) como **Consignado** e grava o valor máximo de compra. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/cliente/atualizar_consignado/{TOKEN}` | | **Corpo** | Lista JSON `[ {...}, {...} ]`, até 20 itens por requisição, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos (de cada item) | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `email` | texto | **sim** | E-mail do cliente. | | `compra_maxima_atacado` | número | **sim** | Valor máximo de compra. `0` não é aceito. Valor negativo é gravado como `-1`. | Aceita um objeto ou uma lista de até 20. ### Exemplo ```json [ { "email": "maria@exemplo.com.br", "compra_maxima_atacado": 5000 }, { "email": "joana@exemplo.com.br", "compra_maxima_atacado": -1 } ] ``` ```json { "atualizacoes": [ { "retorno": true, "tipo_cliente": "Consignado" }, { "retorno": false, "msg_erro": "..." } ] } ``` O resultado vem na mesma ordem dos itens enviados. ### Pode reenviar? Sim. --- ## Adicionar/remover etiquetas do cliente > Aplica e retira etiquetas de CRM de um cliente, pelo e-mail. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/etiquetas · Atualizado em 18/11/2026 ### O que faz Adiciona e remove etiquetas de CRM de um cliente. Etiquetas que o cliente já tem não são duplicadas. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/cliente/etiquetas/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `email` | texto | **sim** | E-mail do cliente. | | `etiquetas_adicionar` | lista de números | não | Ids de [`etiquetas/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/etiquetas/consultar&formato=md). | | `etiquetas_remover` | lista de números | não | Ids a retirar. | Etiquetas do grupo de sistema da loja não podem ser adicionadas nem removidas pela API. ### Exemplo ```json { "email": "maria@exemplo.com.br", "etiquetas_adicionar": [21, 55], "etiquetas_remover": [2] } ``` ```json { "retorno": true, "adicionadas": [21, 55], "removidas": [2] } ``` ### Pode reenviar? Sim. --- ## Associar código do cliente no ERP > Grava no cliente da loja o código que ele tem no ERP. Processamento assíncrono. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/associar_codexterno · Atualizado em 18/11/2026 ### O que faz Liga o cliente da loja (pelo e-mail) ao código do cliente no ERP. Um cliente aceita uma única associação. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/cliente/associar_codexterno/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | | **Processamento** | **Assíncrono.** A resposta confirma que a ação entrou na fila (`automacao_id`). Acompanhe com [`automacao/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/automacao/consultar&formato=md). | ### Campos | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `email` | texto | **sim** | E-mail do cliente na loja. | | `cod_externo` | texto | **sim** | Código do cliente no ERP. | ### Exemplo ```json { "email": "maria@exemplo.com.br", "cod_externo": "C-1020" } ``` Aceito (entrou na fila): ```json { "retorno": true, "msg": "A automação 'cliente.cadastrar_codexterno' foi cadastrada e será processada.", "automacao_id": "123457", "consultar_automacao": "via/automacao/consultar/{TOKEN}?id=123457" } ``` Recusas (na hora): | Mensagem | Causa | |---|---| | `email_cliente e cod_externo são obrigatórios.` | Falta um campo (o campo se chama `email`). | | `cliente não encontrado` | E-mail inexistente. | | `cliente apresentando erro de duplicidade.` | Mais de um cliente com o e-mail. | | `associação já realizada.` | O cliente já tem esse mesmo código. Trate como sucesso. | | `cliente já associado ao cod_externo:X.` | O cliente já tem **outro** código. | ### Pode reenviar? Sim: o reenvio devolve "associação já realizada". ### Onde entra no processo Guia [Clientes](https://api.viashopmoda.com.br/docs-api/?p=guias/clientes&formato=md#fluxo-cliente-se-cadastra-na-loja). --- ## Trocar código de barras > Troca o código de barras de até 20 variações já existentes. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/cod_barras/atualizar · Atualizado em 18/11/2026 ### O que faz Grava um novo `cod_barras` numa variação existente. A variação é localizada pelo código antigo ou pelos ids. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/cod_barras/atualizar/{TOKEN}` | | **Corpo** | Lista JSON `[ {...}, {...} ]`, até 20 itens por requisição, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos (de cada item) | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `cod_barras` | texto | **sim** | O código **novo**. | | `cod_barras_antigo` | texto | um dos modos | Código atual da variação. | | `cod_produto`, `cod_grade`, `cod_estampa` | número | um dos modos | Ids da variação. | ### Regras - A variação precisa existir; se não existir, o item vem em `nao_atualizados`. - Todos os itens são validados antes de gravar: um item mal formado recusa a requisição inteira. - Máximo de 20 itens. ### Exemplo ```json [ { "cod_barras_antigo": "VES001-P-AZ", "cod_barras": "7890000000101" }, { "cod_produto": 153, "cod_grade": 18, "cod_estampa": 138, "cod_barras": "7890000000999" } ] ``` ```json { "retorno": true, "qtd_atualizar": 2, "qtd_atualizados": 2, "qtd_nao_atualizados": 0, "qtd_erros": 0, "atualizados": [ ... ], "nao_atualizados": [], "erros": [] } ``` Erro de validação: `Objeto index[N] inválido, é preciso enviar o 'cod_barras_antigo' ou 'cod_produto', 'cod_estampa' e 'cod_grade'`. ### Pode reenviar? Com `cod_barras_antigo`, não: depois da troca o código antigo não existe mais e o item vem em `nao_atualizados`. Com os ids, sim. --- ## Verificar códigos de barras > Informa quais códigos de barras de uma lista já existem na loja. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/cod_barras/verificar · Atualizado em 18/11/2026 ### O que faz Confere se cada código de barras está cadastrado em alguma variação. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/cod_barras/verificar/{TOKEN}` | | **Corpo** | Lista JSON `[ {...}, {...} ]`, até 20 itens por requisição, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos O corpo é uma **lista de textos** (não de objetos): ```json ["7890000000101", "7890000000102", "XYZ"] ``` Cada item precisa ser texto; número ou objeto recusa a requisição (`Valor do item 'N' do araay não é uma string...`). ### Exemplo de resposta ```json [ { "cod_barras": "7890000000101", "verificar": true }, { "cod_barras": "7890000000102", "verificar": true }, { "cod_barras": "XYZ", "verificar": false } ] ``` `verificar: true` = existe. ### Pode reenviar? Sim (somente leitura). --- ## Associar código do ERP a produto, tipo, grade ou estampa > Grava o código que o ERP usa para um produto, tipo, grade ou estampa, para o ERP localizar o registro pelo código dele. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/cod_externo/associar · Atualizado em 18/11/2026 ### O que faz Grava `cod_externo` em até 20 registros. Depois disso, as consultas aceitam `?cod_externo=` e as respostas trazem o código. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/cod_externo/associar/{TOKEN}` | | **Corpo** | Lista JSON `[ {...}, {...} ]`, até 20 itens por requisição, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos (de cada item) | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `item` | texto | **sim** | `produto`, `tipo`, `grade` ou `estampa`. | | `id` | texto | **sim** | Id do registro na loja. | | `cod_externo` | texto | **sim** | Código do ERP. | ### Regras - Um `cod_externo` não pode se repetir dentro do mesmo tipo de item. - **Variações e clientes não usam esta rota:** o código externo da variação vai em `estoque[].cod_externo` de [`produto/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/cadastrar&formato=md); o do cliente, em [`cliente/associar_codexterno`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/associar_codexterno&formato=md). ### Exemplo ```json [ { "item": "produto", "id": "325", "cod_externo": "ERP-VES001" }, { "item": "grade", "id": "17", "cod_externo": "T-GG" } ] ``` ```json { "retorno": true, "qtd_atualizar": 2, "qtd_atualizados": 2, "qtd_nao_atualizados": 0, "qtd_erros": 0, "atualizados": [ ... ], "nao_atualizados": [], "erros": [] } ``` Erros: `POST enviado não é um array.`, `Máximo de 20 itens por requisição. Enviados N.`, e por item `Algum dos itens obrigatórios não foi enviado: item, id, cod_externo. index[N]`. ### Pode reenviar? Sim. --- ## Consultar coleções > Lista as coleções da loja; por padrão só as ativas. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/colecao/consultar · Atualizado em 18/11/2026 ### O que faz Lista as coleções. Sem `status=todas`, só as **ativas** aparecem. ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/colecao/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `id` | Id da coleção. | | `nome` | Nome exato da coleção. | | `status` | Use status=todas para incluir as coleções inativas. Sem ele, só ativas. | ### Exemplo ```bash curl "https://api.viashopmoda.com.br/via/colecao/consultar/SEU_TOKEN?status=todas" ``` ```json { "colecao": [ { "id": "32", "nome": "INVERNO 2026", "status": "Ativo" }, { "id": "21", "nome": "VERÃO 2025", "status": "Inativo" } ] } ``` ### Pode reenviar? Sim (somente leitura). --- ## Cadastrar coleção > Cria uma coleção pelo nome; se já existir uma ativa com esse nome, devolve o id dela. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/colecao/cadastrar · Atualizado em 18/11/2026 ### O que faz Cria uma coleção ativa. Se já existir uma coleção **ativa** com o mesmo nome, devolve o id dela sem criar outra. Normalmente não é preciso: [`produto/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/cadastrar&formato=md) cria a coleção pelo nome. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/colecao/cadastrar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `nome` | texto | **sim** | 3 a 40 caracteres, gravado em MAIÚSCULAS. | ### Regras - A busca por nome considera só coleções **ativas**: se existir uma inativa com o mesmo nome, uma nova é criada. ### Exemplo ```json { "nome": "Inverno 2026" } ``` ```json { "retorno": true, "cadastro": true, "msg": "Coleção cadastrada com sucesso.", "id": 34, "nome": "INVERNO 2026" } ``` Já existia: `retorno: true`, `cadastro: false`, com `msg_erro` explicando e o `id` existente. Erros: `Parâmetro 'nome' não encontrado`, `Coleção não cadastrada`. ### Pode reenviar? Sim; devolve o id da coleção ativa existente. --- ## Atualizar coleção > Renomeia uma coleção pelo id. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/colecao/atualizar · Atualizado em 18/11/2026 ### O que faz Troca o nome de uma coleção. Não altera status nem produtos. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/colecao/atualizar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `id` | número | **sim** | Id da coleção ([`colecao/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/colecao/consultar&formato=md)). | | `nome` | texto | **sim** | Novo nome (gravado em MAIÚSCULAS). | ### Exemplo ```json { "id": 34, "nome": "Inverno 2026 - Parte 2" } ``` Sucesso: `{"retorno": true, "msg": "Coleção atualizada."}`. Erro: `Parâmetros 'id' e 'nome' são obrigatórios.` ### Pode reenviar? Sim. --- ## Consultar cores > Lista as cores sólidas (estampas do tipo hexadecimal). Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/cor/consultar · Atualizado em 18/11/2026 ### O que faz Lista as estampas do tipo **cor sólida**, com o código hexadecimal. ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/cor/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `id` | Id da cor. | ### Exemplo ```bash curl "https://api.viashopmoda.com.br/via/cor/consultar/SEU_TOKEN" ``` ```json { "cores": [ { "id": "6", "nome": "AMARELO", "cor_hexa": "#FFFF00" }, { "id": "138", "nome": "PRETO", "cor_hexa": "#000000" } ] } ``` Com `?id=`, a resposta vem em `cor` (um objeto). ### Pode reenviar? Sim (somente leitura). --- ## Cadastrar cupom > Cria um cupom de desconto percentual ou em reais, com validade e quantidade de usos. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/cupom/cadastrar · Atualizado em 18/11/2026 ### O que faz Cria um cupom. Se o código já existir, não cria outro e avisa em `msg_alerta`. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/cupom/cadastrar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Limites | Descrição | |---|---|---|---|---| | `codigo_cupom` | string | **sim** | máx. 20 | Código a ser usado na compra. | | `primeira_compra` | string | **sim** | máx. 1 | 'S' ou 'N' | | `nome_parceiro` | string | **sim** | máx. 100 | Nome do parceiro relacionado ao cupom. | | `data_validade` | datetime | **sim** | máx. 19 | Data de validade. Padrão DATETIME 'aaaa-mm-dd hh:mm:ss' | | `tipo_valor` | string | **sim** | máx. 1 | 'P' para valores percentuais e 'V' para valores em reais. | | `valor` | numeric | **sim** | máx. 11 | Valor a ser dado de desconto. Campo relacionado com 'tipo_valor' | | `quantidade` | numeric | **sim** | máx. 3 | Quantidade de cupons disponíveis | | `tipo_loja` | string | não | máx. 1 | 'A' para Atacado e 'V' para Varejo. Opcional: no cadastro, se não enviado, assume 'A'; na atualização, se não enviado, mantém o valor atual. | ### Regras - `tipo_valor`: `P` (percentual) ou `V` (valor em reais). Outro valor é recusado. - `quantidade`: número de usos, até 999. - `data_validade`: `aaaa-mm-dd hh:mm:ss`. - `primeira_compra`: `S` = só vale na primeira compra do cliente. ### Exemplo ```json { "codigo_cupom": "CANALINSTAGRAM", "tipo_valor": "P", "valor": 15, "primeira_compra": "S", "nome_parceiro": "Canal Instagram", "data_validade": "2026-12-31 23:59:59", "quantidade": 100 } ``` ```json { "retorno": true, "id": "OQS5", "msg": "Cupom 'CANALINSTAGRAM' cadastrado com sucesso." } ``` Já existe: `{"retorno": false, "msg_alerta": "Código 'CANALINSTAGRAM' já existe", "id": "OQS5"}`. Erros: `Parâmetro 'codigo_cupom' não encontrado`, `Parâmetro 'tipo_valor' precisa ser 'P' ou 'V'`. ### Pode reenviar? Sim: o reenvio avisa que o código já existe e devolve o `id`. --- ## Atualizar cupom > Altera um cupom pelo id — enviando todos os campos, não só os que mudaram. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/cupom/atualizar · Atualizado em 18/11/2026 ### O que faz Regrava os dados de um cupom existente. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/cupom/atualizar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos `id` (obrigatório: o id codificado devolvido no cadastro ou em [`cupom/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cupom/consultar&formato=md)) **mais todos** os campos do cadastro: | Campo | Tipo | Obrigatório | Limites | Descrição | |---|---|---|---|---| | `codigo_cupom` | string | **sim** | máx. 20 | Código a ser usado na compra. | | `primeira_compra` | string | **sim** | máx. 1 | 'S' ou 'N' | | `nome_parceiro` | string | **sim** | máx. 100 | Nome do parceiro relacionado ao cupom. | | `data_validade` | datetime | **sim** | máx. 19 | Data de validade. Padrão DATETIME 'aaaa-mm-dd hh:mm:ss' | | `tipo_valor` | string | **sim** | máx. 1 | 'P' para valores percentuais e 'V' para valores em reais. | | `valor` | numeric | **sim** | máx. 11 | Valor a ser dado de desconto. Campo relacionado com 'tipo_valor' | | `quantidade` | numeric | **sim** | máx. 3 | Quantidade de cupons disponíveis | | `tipo_loja` | string | não | máx. 1 | 'A' para Atacado e 'V' para Varejo. Opcional: no cadastro, se não enviado, assume 'A'; na atualização, se não enviado, mantém o valor atual. | > A validação é a mesma do cadastro: todos os campos obrigatórios precisam vir, mesmo os que não mudaram. ### Exemplo ```json { "id": "OQS5", "codigo_cupom": "CANALINSTAGRAM", "tipo_valor": "P", "valor": 20, "primeira_compra": "S", "nome_parceiro": "Canal Instagram", "data_validade": "2027-01-31 23:59:59", "quantidade": 100 } ``` Sucesso: `{"retorno": true, "msg": "Cupom código 'OQS5' alterado com sucesso."}`. Não encontrado: `msg_alerta` "Cupom código 'X' não encontrado.". Erros: `Parâmetro 'id' não encontrado`, `Parâmetro 'tipo_valor' precisa ser 'P' ou 'V'`. ### Pode reenviar? Sim. --- ## Consultar cupons > Lista os cupons válidos ou busca um cupom pelo código ou id. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/cupom/consultar · Atualizado em 18/11/2026 ### O que faz Sem filtro, lista só os cupons **válidos** (dentro da validade e com saldo de usos). Com filtro, devolve o cupom pedido. ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/cupom/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `codigo_cupom` | Código do cupom. | | `id` | Id do cupom (texto codificado). Sem filtro: só cupons válidos. | ### Exemplo ```json { "cupom": [ { "id": "OQS5", "codigo_cupom": "BOASVINDAS", "primeira_compra": "S", "nome_parceiro": "Boas-vindas", "data_validade": "2026-12-31 23:59:59", "tipo_valor": "P", "valor": 10, "saldo": 100 } ] } ``` `saldo` = usos restantes. ### Pode reenviar? Sim (somente leitura). --- ## Consultar estampas (cores/variações) > Lista as estampas ativas — cores sólidas (hex) e estampas com imagem. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/estampa/consultar · Atualizado em 18/11/2026 ### O que faz Lista as estampas **ativas**. Cada estampa é de um tipo: | `tipo` | `arquivo` | |---|---| | `hex` | A cor em hexadecimal (ex.: `#FF7518`). | | `jpg` | URL da imagem da estampa (com validade). | | `null` | Estampa ainda sem imagem. | ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/estampa/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `id` | Id da estampa. | | `nome` | Nome exato da estampa. | | `cod_externo` | Código da estampa no ERP. | | `arquivo` | arquivo=N lista só as estampas ainda sem imagem. | ### Exemplo ```bash curl "https://api.viashopmoda.com.br/via/estampa/consultar/SEU_TOKEN?nome=AZUL%20CLARO" ``` ```json { "estampa": [ { "id": "709", "nome": "AZUL CLARO", "tipo": "hex", "arquivo": "#ADD8E6", "cod_externo": null, "status": "S" } ] } ``` ### Pode reenviar? Sim (somente leitura). --- ## Cadastrar estampas (cores/variações) > Cria estampas em lote pelo nome; as que já existem são devolvidas sem alteração. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/estampa/cadastrar · Atualizado em 18/11/2026 ### O que faz Cria estampas (a "cor" da variação). Nomes que já existem entre as estampas ativas vêm em `nao_cadastrados`, com o id existente. Normalmente não é preciso: [`produto/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/cadastrar&formato=md) cria as estampas pelo nome. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/estampa/cadastrar/{TOKEN}` | | **Corpo** | Lista JSON `[ {...}, {...} ]`, até 20 itens por requisição, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos O corpo é uma **lista** `[ {...}, {...} ]` com no máximo 20 itens. Cada item tem os campos abaixo. | Campo | Tipo | Obrigatório | Limites | Descrição | |---|---|---|---|---| | `nome` | string | **sim** | mín. 3, máx. 50 | Nome da estampa | ### Regras - Nome de 3 a 50 caracteres. - A estampa nasce **sem imagem**. Para dar uma imagem, use [`imagens/upload`](https://api.viashopmoda.com.br/docs-api/?p=recursos/imagens/upload&formato=md) com o objeto `estampa`; para uma cor sólida, [`estampa/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/estampa/atualizar&formato=md) com `hex`. ### Exemplo ```json [ { "nome": "VERMELHO CEREJA" }, { "nome": "NUDE" } ] ``` ```json { "retorno": true, "total": 2, "cadastrados": [ { "id": "500", "nome": "VERMELHO CEREJA" } ], "nao_cadastrados": [ { "id": "10", "nome": "NUDE" } ] } ``` Erros: `POST enviado não é um 'array'`, `'nome' da estampa enviado é inválido ou vazio.`, `Estampa não cadastrada`. ### Pode reenviar? Sim; as existentes vêm em `nao_cadastrados`. --- ## Atualizar estampa > Renomeia uma estampa e/ou transforma em cor sólida com um código hexadecimal. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/estampa/atualizar · Atualizado em 18/11/2026 ### O que faz Altera o nome de uma estampa. Com `hex`, a estampa passa a ser uma **cor sólida** com esse código. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/estampa/atualizar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Limites | Descrição | |---|---|---|---|---| | `id` | numeric | **sim** | mín. 1 | id da estampa a ser atualizada. Pode ser consultado em [estampa/consultar](https://api.viashopmoda.com.br/docs-api/?p=recursos/estampa/consultar&formato=md) | | `nome` | string | **sim** | mín. 3, máx. 50 | Novo nome da estampa | | `hex` | string | não | mín. 6, máx. 7 | Cor da estampa no formato #RRGGBB (ex.: #000080). Quando enviado, a estampa passa a ser do tipo cor (hex), mantendo o id e os vínculos com os produtos. Para usar uma imagem, envie pela rota [imagens/upload](https://api.viashopmoda.com.br/docs-api/?p=recursos/imagens/upload&formato=md). | ### Regras - `hex` no formato `#RRGGBB` (o `#` é opcional). Ex.: `#000080`. - A imagem da estampa **não** é trocada por esta rota: use [`imagens/upload`](https://api.viashopmoda.com.br/docs-api/?p=recursos/imagens/upload&formato=md) com o objeto `estampa`. ### Exemplo ```json { "id": 709, "nome": "AZUL CLARO", "hex": "#ADD8E6" } ``` Sucesso: `{"retorno": true, "msg": "..."}`. Erros: `'id' da estampa não enviado.`, `'hex' inválido. Use o formato #RRGGBB (ex.: #000080).` ### Pode reenviar? Sim. --- ## Atualizar estoque > Grava o saldo disponível de até 20 variações por requisição, identificadas por código de barras, código externo ou ids. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/estoque/atualizar · Atualizado em 18/11/2026 ### O que faz Para cada item, localiza a variação e grava a **quantidade disponível**. Cada variação é processada separadamente: umas podem ser atualizadas e outras não. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/estoque/atualizar/{TOKEN}` | | **Corpo** | Lista JSON `[ {...}, {...} ]`, até 20 itens por requisição, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos O corpo é uma **lista** `[ {...}, {...} ]` com no máximo 20 itens. Cada item tem os campos abaixo. | Campo | Tipo | Obrigatório | Limites | Descrição | |---|---|---|---|---| | `cod_produto` | integer | não | | Código do produto na loja virtual | | `cod_grade` | integer | não | | Consultar códigos da grade em [grade/consultar](https://api.viashopmoda.com.br/docs-api/?p=recursos/grade/consultar&formato=md) | | `cod_estampa` | integer | não | | Consultar códigos da estampa em [estampa/consultar](https://api.viashopmoda.com.br/docs-api/?p=recursos/estampa/consultar&formato=md) | | `cod_barras` | string | não | | Código de barras cadastrado na loja virtual de acordo com o padrão do seu sistema | | `cod_externo` | string | não | | | | `quantidade` | integer | **sim** | | Quantidade de estoque q ser atualizada | ### Regras (valem acima da tabela) - Identifique a variação por **um** destes, nesta prioridade: `cod_barras` → `cod_externo` → `cod_produto` + `cod_grade` + `cod_estampa`. - `quantidade` é o **saldo final** disponível, não a movimentação. - Saldo menor que 0 é gravado como 0 (com aviso em `msg_alerta`). - Se a loja tiver margem de segurança negativa configurada (ex.: −2), ela é somada à quantidade enviada; a resposta traz `gordura` e um aviso. - Preços enviados aqui são **ignorados**. Use [`preco/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/preco/atualizar&formato=md). - Máximo de 20 itens; acima disso a requisição inteira é recusada. ### Exemplo ```json [ { "cod_barras": "7890000000101", "quantidade": 4 }, { "cod_barras": "7890000000102", "quantidade": 0 }, { "cod_produto": 325, "cod_grade": 17, "cod_estampa": 709, "quantidade": 2 } ] ``` ```json { "retorno": true, "msg_alerta": [], "qtd_atualizar": 3, "qtd_atualizados": 2, "qtd_nao_atualizados": 1, "atualizados": [ ... ], "nao_atualizados": [ { "cod_barras": "7890000000102", "quantidade": 0, "erro": "..." } ], "gordura": 0 } ``` Erros da requisição inteira: | Mensagem | Causa | |---|---| | `POST de 'estoque' deve ser um array (object)` | Corpo enviado como objeto; envie uma lista. | | `Permitido enviar no máximo 20 registros por requisição. Quantidade enviada N` | Lote grande demais. | Erro por item (em `nao_atualizados[].erro`): `faltou: cod_barras, cod_externo ou cod_produto, cod_grade e cod_estampa`, ou variação não encontrada. ### Pode reenviar? Sim. Como é o saldo final, reenviar o mesmo lote dá o mesmo resultado. ### Onde entra no processo Guia [Estoque e preço](https://api.viashopmoda.com.br/docs-api/?p=guias/estoque-e-preco&formato=md). ### Erros comuns de integração - Enviar `-1` para "baixar uma unidade". Envie o saldo resultante. - Enviar um objeto em vez de lista quando há um só item. Use `[ { ... } ]`. - Enviar o estoque inteiro periodicamente em vez de só o que mudou. --- ## Atualizar estoque (callback) > Mesmo comportamento de estoque/atualizar, em outro endereço — para ERPs que precisam de uma URL de retorno separada. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/estoque/callback · Atualizado em 18/11/2026 ### O que faz Executa exatamente a mesma operação de [`estoque/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/estoque/atualizar&formato=md): mesmos campos, regras, limites e respostas. Existe para ERPs que configuram uma URL de "callback" de estoque separada da URL de atualização. Se o seu ERP não exige isso, use `estoque/atualizar`. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/estoque/callback/{TOKEN}` | | **Corpo** | Lista JSON `[ {...}, {...} ]`, até 20 itens por requisição, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos O corpo é uma **lista** `[ {...}, {...} ]` com no máximo 20 itens. Cada item tem os campos abaixo. | Campo | Tipo | Obrigatório | Limites | Descrição | |---|---|---|---|---| | `cod_produto` | integer | não | | Código do produto na loja virtual | | `cod_grade` | integer | não | | Consultar códigos da grade em [grade/consultar](https://api.viashopmoda.com.br/docs-api/?p=recursos/grade/consultar&formato=md) | | `cod_estampa` | integer | não | | Consultar códigos da estampa em [estampa/consultar](https://api.viashopmoda.com.br/docs-api/?p=recursos/estampa/consultar&formato=md) | | `cod_barras` | string | não | | Código de barras cadastrado na loja virtual de acordo com o padrão do seu sistema | | `cod_externo` | string | não | | | | `quantidade` | integer | **sim** | | Quantidade de estoque q ser atualizada | ### Exemplo ```json [ { "cod_barras": "7890000000101", "quantidade": 4 } ] ``` ### Pode reenviar? Sim (saldo final). --- ## Consultar estoque > Saldo e dados das variações — uma, as de um produto, as de um pedido ou todas (100 por página). Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/estoque/consultar · Atualizado em 18/11/2026 ### O que faz Devolve as variações com saldo, código de barras, nomes de grade e estampa e códigos externos. ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/estoque/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `cod_barras` | Código de barras de uma variação. Usar sozinho. | | `cod_produto` | Id do produto: todas as variações. Com cod_grade e cod_estampa: uma variação. | | `cod_grade` | Id da grade (usar com cod_produto e cod_estampa). | | `cod_estampa` | Id da estampa (usar com cod_produto e cod_grade). | | `pedido` | Número do pedido: estoque dos itens desse pedido. | | `pagina` | Página. Sem filtro, a consulta lista 100 variações por página. | ### Regras - Sem filtro: lista as variações que têm código de barras, **100 por página** (não 20). - `preco_*` vazio na variação = usa o preço do produto. - Para conferir a loja inteira, faça no máximo uma vez por dia e fora do horário de pico. ### Exemplo ```bash curl "https://api.viashopmoda.com.br/via/estoque/consultar/SEU_TOKEN?cod_barras=7890000000101" ``` ```json { "estoque": [ { "cod_produto": "325", "cod_grade": "14", "cod_estampa": "709", "quantidade": "4", "preco_atacado": "", "preco_varejo": "", "cod_barras": "7890000000101", "nome_grade": "P", "cod_grade_externo": null, "nome_estampa": "AZUL CLARO", "cod_estampa_externo": null } ] } ``` ### Pode reenviar? Sim (somente leitura). Cada página conta no limite. --- ## Consultar etiquetas de CRM > Lista todas as etiquetas de CRM da loja, com id e cor. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/etiquetas/consultar · Atualizado em 18/11/2026 ### O que faz Lista as etiquetas que podem ser aplicadas a clientes com [`cliente/etiquetas`](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/etiquetas&formato=md). ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/etiquetas/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Esta consulta não tem parâmetros. ### Exemplo ```json { "etiquetas": [ { "id": "17", "nome": "Acessa e compra", "cor": "#C69FCC" } ] } ``` ### Pode reenviar? Sim (somente leitura). --- ## Consultar formas de pagamento > Lista as formas de pagamento da loja com tipo online/offline. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/formas_pagamento/consultar · Atualizado em 18/11/2026 ### O que faz Lista as formas de pagamento. Use o `nome` exato em `forma_pagamento` de [`pedido/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/atualizar&formato=md). ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/formas_pagamento/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `id` | Id da forma de pagamento. | | `nome` | Nome da forma de pagamento. | ### Exemplo ```json { "formas_pagamento": [ { "id": "3", "nome": "Boleto Parcelado na Loja", "tipo": "offline", "alias": "boleto" }, { "id": "7", "nome": "PIX", "tipo": "online", "alias": "pix" } ] } ``` - `tipo`: `online` = intermediador/gateway (o cliente paga na loja); `offline` = combinado diretamente com a loja. - `alias`: `pix`, `cartao_credito`, `boleto`, `deposito` ou `outros`. > **Atenção:** com um único resultado (ex.: `?id=3`), `formas_pagamento` vem como **objeto**, não lista. Não encontrada: `... não encontrado nas formas de pagamento da loja.` ### Pode reenviar? Sim (somente leitura). --- ## Consultar fotos > Busca registros de fotos por id, lista de ids ou nome de arquivo. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/fotos/consultar · Atualizado em 18/11/2026 ### O que faz Consulta fotos cadastradas. Para ver as fotos de um produto, normalmente basta [`produto/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/consultar&formato=md), que já traz a lista. ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/fotos/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `id` | Id da foto. | | `in_ids` | Vários ids separados por vírgula (mantém a ordem). | | `arquivo` | Nome do arquivo na loja. | | `arquivo_original` | Parte do caminho da URL original enviada no upload. | ### Regras - Sem filtro, a resposta vem vazia (`"fotos": ""`). - `in_ids` devolve na mesma ordem da lista enviada. ### Exemplo ```bash curl "https://api.viashopmoda.com.br/via/fotos/consultar/SEU_TOKEN?in_ids=101,102" ``` Resposta: `{"fotos": [ { ... }, { ... } ]}`. ### Pode reenviar? Sim (somente leitura). --- ## Consultar grades (tamanhos) > Lista os tamanhos cadastrados, com descrição e código do ERP. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/grade/consultar · Atualizado em 18/11/2026 ### O que faz Lista as grades (tamanhos), na ordem configurada na loja. ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/grade/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `id` | Id da grade. | | `nome` | Nome exato da grade (ex.: P). | | `cod_externo` | Código da grade no ERP. | | `kit` | kit=S lista só as grades do tipo kit. | ### Exemplo ```bash curl "https://api.viashopmoda.com.br/via/grade/consultar/SEU_TOKEN" ``` ```json { "grade": [ { "id": "14", "grade": "P", "info": "", "is_kit": "N", "cod_externo": null }, { "id": "17", "grade": "GG", "info": "Extra grande", "is_kit": "N", "cod_externo": "T-GG" } ] } ``` Atenção: o nome do tamanho vem no campo `grade` (não em `nome`), e a descrição em `info`. `is_kit` = `"S"` para grades do tipo kit. ### Pode reenviar? Sim (somente leitura). --- ## Cadastrar grades (tamanhos) > Cria tamanhos em lote pelo nome; tamanhos já existentes têm a descrição atualizada. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/grade/cadastrar · Atualizado em 18/11/2026 ### O que faz Para cada item: se não existe grade com o nome, cria; se existe, **atualiza** a descrição (aparece em `alterados`). Normalmente não é preciso: [`produto/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/cadastrar&formato=md) cria as grades pelo nome. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/grade/cadastrar/{TOKEN}` | | **Corpo** | Lista JSON `[ {...}, {...} ]`, até 20 itens por requisição, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos O corpo é uma **lista** `[ {...}, {...} ]` com no máximo 20 itens. Cada item tem os campos abaixo. | Campo | Tipo | Obrigatório | Limites | Descrição | |---|---|---|---|---| | `nome` | string | **sim** | | Nome da grade. Ex.: 'XG' | | `descricao` | string | não | aceita null | Informação adicional para a grade. Ex.: 'Extra G' | ### Exemplo ```json [ { "nome": "P" }, { "nome": "EXG", "descricao": "Extra GG" } ] ``` ```json { "retorno": true, "total": 2, "cadastrados": [ { "id": "20", "nome": "EXG", "descricao": "Extra GG" } ], "alterados": [ { "id": "14", "nome": "P", "descricao": "" } ] } ``` Erros: `POST enviado não é um 'array'`, `Grade não cadastrada`. ### Pode reenviar? Sim. Atenção: para uma grade que já existe, os dados enviados são regravados — envie sempre a `descricao` desejada junto com o nome. --- ## Atualizar grade (tamanho) > Renomeia uma grade e/ou muda a descrição, pelo id. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/grade/atualizar · Atualizado em 18/11/2026 ### O que faz Altera nome e descrição de uma grade. As variações que usam a grade passam a mostrar o nome novo. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/grade/atualizar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Limites | Descrição | |---|---|---|---|---| | `id` | numeric | **sim** | mín. 1 | id da grade a ser atualizada. Pode ser consultado em [grade/consultar](https://api.viashopmoda.com.br/docs-api/?p=recursos/grade/consultar&formato=md) | | `nome` | string | **sim** | mín. 1, máx. 30 | Novo nome da grade | | `descricao` | string | não | mín. 3, máx. 100 | Descrição da grade | ### Exemplo ```json { "id": 17, "nome": "GG", "descricao": "Extra grande" } ``` Sucesso: `{"retorno": true, "msg": "Grade atualizada."}`. Erro: `'id' da grade não enviado.` ### Pode reenviar? Sim. --- ## Enviar foto de produto ou de estampa > A loja baixa a imagem de uma URL pública e a liga a um produto (pelo código de barras de uma variação) ou a uma estampa. Processamento assíncrono. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/imagens/upload · Atualizado em 18/11/2026 ### O que faz Você envia a **URL** de uma imagem; a loja valida o pedido, coloca o download numa fila e responde na hora. Em seguida a imagem é baixada, redimensionada e ligada: - **foto de produto** (`produto`): ao produto e à estampa da variação do `cod_barras`; - **imagem de estampa** (`estampa`): à estampa pelo nome; a estampa passa a ser do tipo imagem. Uma requisição = uma imagem. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/imagens/upload/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | | **Processamento** | **Assíncrono.** A resposta confirma que a ação entrou na fila (`automacao_id`). Acompanhe com [`automacao/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/automacao/consultar&formato=md). | ### Campos Envie **um** dos objetos: | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `produto.cod_barras` | texto | **sim** | Código de barras de uma variação do produto. A foto fica ligada à estampa dessa variação. | | `produto.arquivo` | texto | **sim** | URL pública e completa da imagem. | | `estampa.nome` | texto | **sim** | Nome da estampa. | | `estampa.arquivo` | texto | **sim** | URL pública e completa da imagem. | ### Regras - A URL **não pode** ter espaços nem letras acentuadas ou caracteres como `ç`, `ã`, `<`, `>`. Codifique ou renomeie o arquivo. - Formatos: JPEG, PNG ou WEBP. - Foto de produto: tamanho ideal 900 × 1350 px. Imagens menores são aceitas, mas ganham bordas brancas. - A loja guarda a URL de origem: enviar de novo a **mesma URL** para o mesmo produto é recusado (`Arquivo enviado já existe para o produto...`). Para trocar uma foto, use outra URL ou remova a antiga com [`imagens/remover`](https://api.viashopmoda.com.br/docs-api/?p=recursos/imagens/remover&formato=md). - O `cod_barras` precisa existir e ser único. - A ordem das fotos na loja segue a ordem de envio. ### Exemplo ```json { "produto": { "cod_barras": "7890000000101", "arquivo": "https://seu-servidor.com.br/fotos/VES001-azul-1.jpg" } } ``` ```json { "estampa": { "nome": "FLORAL ROSA", "arquivo": "https://seu-servidor.com.br/estampas/floral-rosa.png" } } ``` ### Respostas Aceito (entrou na fila): ```json { "retorno": true, "msg": "A automação 'produto.upload_foto' foi cadastrada e será processada.", "automacao_id": "123456", "consultar_automacao": "via/automacao/consultar/{TOKEN}?id=123456" } ``` Acompanhe o resultado com [`automacao/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/automacao/consultar&formato=md). Recusas (na hora): | Mensagem | Causa | |---|---| | `Caractere X inválido encontrado na posição N da url do arquivo.` | Acento ou caractere especial na URL. | | `A url do arquivo não pode conter espaços` | Espaço na URL. | | `produto não encontrado com o cod_barras:X.` | Código de barras inexistente. | | `código de barras duplicado. cod_barras:X total:N.` | Mais de uma variação com o mesmo código. | | `Arquivo enviado já existe para o produto. ...` | Essa URL já foi enviada para o produto (HTTP 200, `retorno: false`). | ### Pode reenviar? A mesma URL para o mesmo produto é recusada com aviso — trate como "já enviada". ### Onde entra no processo Guia [Catálogo](https://api.viashopmoda.com.br/docs-api/?p=guias/catalogo-carga-inicial&formato=md#3-enviar-as-fotos). --- ## Remover fotos de um produto > Remove fotos de um produto informando as URLs de origem usadas no upload. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/imagens/remover · Atualizado em 18/11/2026 ### O que faz Localiza, entre as fotos do produto, as que vieram das URLs informadas e as remove. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/imagens/remover/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `produto.cod_ref` | texto | **sim** | Referência do produto. | | `produto.remover_arquivos` | lista | **sim** | URLs **originais** enviadas em `imagens/upload`. | ### Exemplo ```json { "produto": { "cod_ref": "VES001", "remover_arquivos": ["https://seu-servidor.com.br/fotos/VES001-azul-1.jpg"] } } ``` ```json { "retorno": true, "arquivos_removidos": [ ... ] } ``` ### Pode reenviar? Sim; fotos já removidas simplesmente não aparecem em `arquivos_removidos`. ### Onde entra no processo Troca de fotos: remova a antiga e envie a nova com [`imagens/upload`](https://api.viashopmoda.com.br/docs-api/?p=recursos/imagens/upload&formato=md). --- ## Renovar o link de uma imagem > Gera um novo link válido para uma imagem cujo link (devolvido por uma consulta) expirou. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/imagens/novo_token · Atualizado em 18/11/2026 ### O que faz As URLs de imagens devolvidas pelas consultas (`produto/consultar`, `estampa/consultar`…) são temporárias: valem cerca de **10 minutos**. Esta rota devolve uma URL nova para a mesma imagem. ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/imagens/novo_token/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `img_token` | Token da URL de imagem recebida antes (parâmetro img da URL). | O `img_token` é o valor do parâmetro `img` da URL antiga: em `https://imagens.viashopmoda.com.br/api?img=ABC123`, é `ABC123`. ### Exemplo ```bash curl "https://api.viashopmoda.com.br/via/imagens/novo_token/SEU_TOKEN?img_token=ABC123" ``` ```json { "retorno": true, "nova_url": "https://imagens.viashopmoda.com.br/api?img=XYZ789", "validade_token": "..." } ``` ### Pode reenviar? Sim. ### Dica Se o ERP precisa guardar as fotos, baixe a imagem logo depois da consulta em vez de guardar a URL. --- ## Consultar leads > Lista contatos que ainda não são clientes (deixaram e-mail ou WhatsApp), por id, contato ou período. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/leads/consultar · Atualizado em 18/11/2026 ### O que faz Devolve leads. Sem filtro, traz os leads de **hoje**. Não há paginação. ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/leads/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `id` | Id do lead. | | `email` | E-mail. | | `whatsapp` | WhatsApp. | | `data_inicial` | Início do período (aaaa-mm-dd). | | `data_final` | Fim do período (aaaa-mm-dd). Sem nenhum filtro: leads de hoje. | ### Exemplo ```bash curl "https://api.viashopmoda.com.br/via/leads/consultar/SEU_TOKEN?data_inicial=2026-11-01&data_final=2026-11-16" ``` ```json { "leads": [ { "id": "TVRZASD", "nome": "Joana", "email": "", "whatsapp": "(35) 98888-0101", "status_qualificacao": "Qualificado", "data_cadastro": "2026-11-11 11:03:33", "origem_pagina": "produto", "origem_acesso": "Acesso Direto", "utm": "feiras -> festlingerie -> standsvirtuais", "vendedor_nome": "Ana", "vendedor_email": "vendedora@loja.com.br" } ] } ``` - Um lead tem e-mail **ou** WhatsApp; o outro vem vazio. - `status_qualificacao`: `Aguardo`, `Qualificado` ou `Não qualificado` (definido pela vendedora). ### Pode reenviar? Sim (somente leitura). --- ## Cadastrar lead > Registra um contato (nome e e-mail ou WhatsApp) vindo de um formulário externo, como uma landing page. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/leads/cadastrar · Atualizado em 18/11/2026 ### O que faz Cria um lead com origem "api". Recusa se já existir lead com o mesmo WhatsApp (DDI + número) ou o mesmo e-mail. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/leads/cadastrar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `nome` | texto | **sim** | Nome do contato. | | `email` | texto | **sim** | E-mail. | | `whatsapp_ddi` | texto | **sim** | DDI, ex.: `55`. | | `whatsapp_numero` | texto | **sim** | Número com DDD, ex.: `35988880101`. | | `utm_source` | texto | não | Origem da campanha. | | `utm_medium` | texto | não | Mídia. | | `utm_campaign` | texto | não | Campanha. | ### Exemplo Pela API, os quatro primeiros campos são obrigatórios (leads criados pela própria loja podem ter só e-mail ou só WhatsApp). ```json { "nome": "Joana", "email": "joana@exemplo.com.br", "whatsapp_ddi": "55", "whatsapp_numero": "35988880101", "utm_source": "instagram", "utm_medium": "stories", "utm_campaign": "inverno" } ``` Sucesso: `{"retorno": true, "msg": "Lead cadastrado com sucesso.", "id": "..."}`. Duplicado: `Lead já existe`. ### Pode reenviar? Sim: o reenvio é recusado com "Lead já existe". --- ## Consultar saldo de requisições do dia > Quantas requisições a loja ainda pode fazer hoje. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/limites_api/consultar · Atualizado em 18/11/2026 ### O que faz Mostra o saldo de requisições do dia. O limite é da **loja**: soma o uso de todos os tokens dela. ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/limites_api/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Esta consulta não tem parâmetros. ### Exemplo ```json { "retorno": true, "limites_api": { "token": "...", "saldo": 532, "extras": { "data_utilizacao": "2026-10-10", "qtd_solicitada": 5000 } } } ``` - `saldo`: requisições restantes hoje (já com uma pequena margem de segurança descontada). - `extras`: último aumento de limite concedido, se houver. Esta consulta também conta como uma requisição. ### Pode reenviar? Sim, mas não em ciclo: uma vez por hora é suficiente para acompanhar. ### Onde entra no processo Guia [Erros, limites e paginação](https://api.viashopmoda.com.br/docs-api/?p=guias/erros-limites-paginacao&formato=md#limites). --- ## Solicitar aumento de limite (desativada) > Rota desativada — sempre responde que a solicitação não foi atendida. Peça aumento de limite ao suporte. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/limites_api/solicitar · Atualizado em 18/11/2026 ### O que faz **Nada.** A rota existe, mas está desativada e sempre responde: ```json { "retorno": false, "msg_erro": "Solicitação não atendida. Tente novamente mais tarde" } ``` Para precisar de mais requisições por dia, fale com api@viashopmoda.com.br. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/limites_api/solicitar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | | **Situação** | **Desativada.** A rota existe, mas não executa a ação. | ### Pode reenviar? Não adianta: a resposta é sempre a mesma. --- ## Consultar dados da loja > Nome, CNPJ, cidade, margem sugerida de varejo e banners da loja. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/loja/consultar · Atualizado em 18/11/2026 ### O que faz Devolve dados públicos da loja. ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/loja/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Esta consulta não tem parâmetros. ### Exemplo ```json { "nome": "Loja Exemplo", "cnpj": "00000000000100", "cidade": "Varginha", "percentual_sugerido": 100, "banners": { "principal": { "video": [], "app": [], "mobile": [ { "src": "https://...", "link": "https://...", "type": "imagem" } ] }, "secundario": { "peq": [], "med": [], "gra": [] } } } ``` `percentual_sugerido` é a margem usada para calcular o varejo quando ele não é informado em `produto/alterar_precos`. ### Pode reenviar? Sim (somente leitura). --- ## Consultar pedidos > Um pedido completo (por número na loja ou no ERP) ou listas por período ou por cliente. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/consultar · Atualizado em 18/11/2026 ### O que faz Consulta pedidos. O formato da resposta muda conforme o filtro: | Filtro | Resposta | |---|---| | `pedido` | Um pedido completo: `cliente`, `pedido`, `produtos` | | `numero_pedido_externo` | Um pedido: `cliente`, `pedido`, `produtos` (sem os dados do subpedido) | | `data_inicial` + `data_final` | Lista paginada: `cabecalho`, `pedidos[]` (cada um com o cliente) | | `cpf`, `cnpj` ou `email` | Lista paginada do cliente: `cabecalho`, `cliente`, `pedidos[]` | ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/pedido/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `pedido` | Número do pedido na loja (6 dígitos). | | `numero_pedido_externo` | Número do pedido no ERP. | | `data_inicial` | Início do período (aaaa-mm-dd). Usar com data_final. | | `data_final` | Fim do período (aaaa-mm-dd). | | `horario_inicial` | Hora inicial (hh:mm:ss), com o período. | | `horario_final` | Hora final (hh:mm:ss), com o período. | | `data_alteracao` | data_alteracao=S busca pela data de alteração do pedido, não pela de criação. | | `pagos` | pagos=S traz só pedidos pagos (com o período). | | `remover_cancelados` | remover_cancelados=S tira os cancelados (com o período). | | `cpf` | Pedidos do cliente com este CPF. | | `cnpj` | Pedidos do cliente com este CNPJ. | | `email` | Pedidos do cliente com este e-mail. | | `pagina` | Página (20 registros por página). Ex.: pagina=2 | ### Campos úteis da resposta | Campo | Significado | |---|---| | `pedido.numero_pedido` | Número na loja (6 dígitos). | | `pedido.status_pedido` | Status com o nome da loja. "Pagamento efetuado, aguardando captura" aparece como "Pagamento em análise". | | `pedido.status_pedido_externo` | Nome do status no ERP, se configurado com `status_pedido/associar`. | | `pedido.numero_pedido_alterado` | Em pedido **cancelado por alteração**: número do pedido novo que o substituiu. | | `pedido.foi_pago` | `S` ou `N`. | | `pedido.url_pagamento` | Em "Aguardando Pagamento": link para o cliente pagar. | | `produtos[]` | Itens, com `cod_barras`, grade, estampa, quantidade e preço. | ### Exemplo ```bash curl "https://api.viashopmoda.com.br/via/pedido/consultar/SEU_TOKEN?pedido=111111" ``` ```bash curl "https://api.viashopmoda.com.br/via/pedido/consultar/SEU_TOKEN?data_inicial=2026-11-16&data_final=2026-11-16&data_alteracao=S&pagina=1" ``` ### Regras - O número do pedido precisa ter 6 dígitos. - Pedido não encontrado → `retorno: false`. - Para conferência periódica, use o período com `data_alteracao=S` — e não consulte pedido por pedido. ### Pode reenviar? Sim (somente leitura). Cada página conta no limite. ### Onde entra no processo Guia [Pedidos](https://api.viashopmoda.com.br/docs-api/?p=guias/pedidos&formato=md#conferencia-periodica-reconciliacao). --- ## Cadastrar pedido criado fora da loja > Registra na loja um pedido que nasceu fora dela (venda no ERP, loja física, marketplace), cadastrando o cliente se ele ainda não existir. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/cadastrar · Atualizado em 18/11/2026 ### O que faz Cria um pedido na ViaShopModa a partir dos dados enviados pelo ERP: localiza ou cadastra o cliente, grava o pedido com o status informado e os itens. A loja gera um número de pedido novo (6 dígitos) e devolve na resposta. **Quando usar:** a venda aconteceu **fora** da loja virtual e você quer que ela apareça no histórico da loja e do cliente. **Quando não usar:** - Para pedidos que **vieram da loja** — eles já existem. Use [`pedido/associar_codexterno`](https://api.viashopmoda.com.br/docs-api/?p=guias/pedidos&formato=md#3-o-erp-informa-o-numero-do-pedido-no-erp) para ligar ao número do ERP. - Para mudar status de um pedido existente — use `pedido/atualizar`. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/pedido/cadastrar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos Estrutura do corpo JSON: ```text { "cliente": {...} "pedido": {...} "subpedido": {...} "produtos": [ {...}, {...} ] } ``` ##### `cliente` (objeto) Dados do cliente, no mesmo formato de cliente/cadastrar. Se o CPF, CNPJ ou e-mail já existir, o cliente existente é usado e não é cadastrado de novo. | Campo | Tipo | Obrigatório | Limites | Descrição | |---|---|---|---|---| | `cliente.tipo_pessoa` | string | **sim** | máx. 1 | 'F' = pessoa física: , 'J' = pessoa jurídica e 'E' = cliente do exterior. | | `cliente.email` | string | **sim** | mín. 5, máx. 150 | Usado como contato e para acessar a loja virtual. | | `cliente.senha` | string | **sim** | mín. 4 | Senha para acessar a loja virtual. | | `cliente.tipo_cliente` | string | **sim** | máx. 100 | Sempre se 'tipo_pessoa'=F será 'Revendedor' e 'tipo_pessoa'=J será 'Lojista'. Somente será alterado se enviado como 'Consignado' e o 'compra_maxima_atacado' passa a ser necessário o envio. | | `cliente.cpf` | numeric | **sim** | mín. 11, máx. 11 | Somente números. Obrigatório quando pessoa física. | | `cliente.nome_completo` | string | **sim** | máx. 150 | Nome completo do cliente. Obrigatório quando pessoa física. | | `cliente.rg` | string | não | máx. 25 | Caso inexistente enviar 'Isento'. Obrigatório quando pessoa física. | | `cliente.data_nascimento` | date | **sim** | máx. 10 | Formato 'aaaa-mm-dd'. Obrigatório quando pessoa física. | | `cliente.sexo` | string | **sim** | | 'Masculino', 'Feminino' ou 'Nenhum'. Obrigatório quando pessoa física. | | `cliente.cnpj` | string | **sim** | mín. 14, máx. 14 | Somente números. Obrigatório quando pessoa jurísica. | | `cliente.nome_empresa` | string | **sim** | máx. 150 | Nome fantasia da empresa. Obrigatório quando pessoa jurídica. | | `cliente.responsavel_empresa` | string | **sim** | máx. 150 | Nome do responsável pela empresa. Obrigatório quando pessoa jurídica. | | `cliente.ie` | string | **sim** | máx. 25 | Caso inexistente enviar 'Isento'. Obrigatório quando pessoa jurídica. | | `cliente.moeda` | string | não | máx. 3 | Para os clientes do exterior, é possível alterar sua moeda enviando o código no padrão ISO 4217. USD para dolar, EUR para euro e etc. | | `cliente.condicao_diferenciada` | double | não | máx. 11 | Representa a porcentagem de acréscimo ou desconto nos preços dos produtos. | | `cliente.compra_minima_atacado` | double | não | máx. 11 | Valor minimo para compra de atacado. | | `cliente.compra_maxima_atacado` | double | não | máx. 11 | Usado para quando tipo_cliente=Consignado, limitando o valor máximo a ser comprado. Se não enviado será zero. | | `cliente.cep` | numeric | **sim** | mín. 8, máx. 8 | Somente números no formato '37001000'. | | `cliente.endereco` | string | **sim** | máx. 150 | Caso cliente do exterior, será usado como endereço completo. | | `cliente.numero` | string | **sim** | máx. 10 | Não utilizado para clientes do exterior. | | `cliente.complemento` | string | não | máx. 50 | Não utilizado para clientes do exterior. | | `cliente.bairro` | string | **sim** | máx. 50 | Não utilizado para clientes do exterior. | | `cliente.cidade` | string | **sim** | máx. 50 | | | `cliente.estado` | string | **sim** | máx. 2 | Sigla do estado com dois caracteres. Não utilizado para clientes do exterior. | | `cliente.pais` | string | não | máx. 50 | Para países diferente de 'Brasil' usar o campo cod_pais. | | `cliente.cod_pais` | string | não | máx. 2 | Código do país no padrão ISO-2, se não enviado será utilizado 'BR'. | | `cliente.codigo_ddi` | string | não | mín. 1, aceita null | Se não enviado sempre será 55. | | `cliente.telefone_celular` | string | **sim** | máx. 50 | Se não enviado no formato: '+{CODIGO_DDI}{NUMERO_TELEFONE}' será acrescentado o DDI (relativo ao cod_pais) ao número enviado. | | `cliente.operadora_celular` | string | não | máx. 20 | Nome da operadora de telefonia. Se não enviado será cadastrado 'Outras' | | `cliente.utm_source` | string | não | máx. 70 | Se enviado é necessário enviar utm_medium e utm_campaign | | `cliente.utm_medium` | string | não | máx. 70 | Se enviado é necessário enviar utm_source e utm_campaign | | `cliente.utm_campaign` | string | não | máx. 70 | Se enviado é necessário enviar utm_source e utm_medium | | `cliente.crm` | array | não | | Frases relacionadas ao CRM do cliente | | `cliente.assinar_newsletter` | string | não | máx. 1 | 'S' ou 'N', se não enviado será cadastrado 'N'. | | `cliente.data_cadastro` | datetime | não | máx. 19 | Data de cadastro do cliente. Padrão DATETIME 'aaaa-mm-dd hh:mm:ss'. | | `cliente.liberado_para_comprar` | string | não | máx. 1 | Padrão 'N'. Podendo ser 'S' ou 'N'. Onde 'S' está liberado e 'N' NÃO está liberado. Observações: (1) O 'N' não signifca bloqueio algum, mas a não possibilidade de login. (2) Se não enviado será cadastrado como 'N'. (3) Se enviado como 'S' poderá ser alterado caso a cidade ou o estado enviado for considerado uma região exclusiva. | | `cliente.vendedor` | object | não | | Objeto para consulta do vendedor. Poderá ser usado: vendedor.id, vendedor.email ou vendedor.whatsapp para localizar o vendedor a ser atrelado ao cliente. Para consultar o vendedor [vendedores/consultar](https://api.viashopmoda.com.br/docs-api/?p=recursos/vendedores/consultar&formato=md). Se enviar 'sortear' será sorteado entre os vendedores habilitados. Se não existir, cadastro não será vinculado a nenhum vendedor. | ##### `pedido` (objeto) Cabeçalho do pedido: status, valores e endereço de entrega. | Campo | Tipo | Obrigatório | Limites | Descrição | |---|---|---|---|---| | `pedido.numero_pedido_externo` | string | **sim** | aceita null | Código do pedido no sistema de origem | | `pedido.status_pedido` | string | **sim** | máx. 50 | Opções de status: 'AN' = Análise, 'PG' = Pago ou 'EN' = Entregue. | | `pedido.url_notafiscal` | string | não | máx. 200 | URL completa da nota fiscal do pedido. Usado quando o pedido já estiver pago/faturado. | | `pedido.data_pedido` | date | **sim** | máx. 11 | Formato 'aaaa-mm-dd'. | | `pedido.tipo_frete` | string | não | máx. 50 | Opcional para 'status_pedido' = 'EN', se não informado será cadastrado valor padrão. | | `pedido.valor_pedido` | double | **sim** | máx. 11 | Obrigatório para 'status_pedido' = 'EN' e 'PG'. | | `pedido.valor_desconto` | double | **sim** | máx. 11 | Obrigatório para 'status_pedido' = 'EN' e 'PG'. Caso não tenha enviar '0.00' | | `pedido.valor_frete` | double | **sim** | máx. 11 | Obrigatório para 'status_pedido' = 'EN'. | | `pedido.valor_total` | double | **sim** | máx. 11 | Valor total do pedido. Somatória dos produtos + 'valor_pedido' - 'valor_desconto' + 'valor_frete'. | | `pedido.cep_entrega` | numeric | **sim** | mín. 8, máx. 8 | Somente números no formato '37001000'. | | `pedido.endereco_entrega` | string | **sim** | máx. 150 | Caso cliente do exterior, será usado como endereço completo. | | `pedido.numero_entrega` | string | **sim** | máx. 10 | Não utilizado para clientes do exterior. | | `pedido.complemento_entrega` | string | não | máx. 50 | Não utilizado para clientes do exterior. | | `pedido.bairro_entrega` | string | **sim** | máx. 50 | Não utilizado para clientes do exterior. | | `pedido.cidade_entrega` | string | **sim** | máx. 50 | | | `pedido.estado_entrega` | string | **sim** | máx. 2 | Sigla do estado com dois caracteres. Não utilizado para clientes do exterior. | ##### `subpedido` (objeto) Tipo de venda, pagamento e rastreio. | Campo | Tipo | Obrigatório | Limites | Descrição | |---|---|---|---|---| | `subpedido.tipo_pedido` | string | **sim** | máx. 50 | 'A' = Atacado e 'V' = Varejo. Se não enviado, será cadastrado como 'Atacado'. | | `subpedido.parcelas_pagamento` | integer | não | máx. 2 | Número de parcelas. | | `subpedido.rastreio_frete` | string | não | máx. 100 | Código de rastreamento do pedido na transportadora. | ##### `produtos[]` (lista) Itens do pedido. Não enviar quando pedido.tipo = "compra_rapida". | Campo | Tipo | Obrigatório | Limites | Descrição | |---|---|---|---|---| | `produtos[].quantidade` | integer | **sim** | | Quantidade do produto no pedido. | | `produtos[].preco` | double | **sim** | | Preço unitário do produto. | | `produtos[].cod_barras` | string | não | | Código de barras do produto. | ### Regras (valem acima da tabela) Estas regras foram conferidas com o código da API. Quando a descrição de um campo na tabela disser algo diferente, vale o que está aqui. **`pedido.status_pedido`** — use um destes códigos (não o nome do status): | Código | Status gravado | Conta como pago? | |---|---|---| | `AN` | Pedido em análise | não | | `AG` | Aguardando Pagamento | não | | `PA` | Pagamento autorizado, aguardando envio | não (ver nota) | | `PG` | Pagamento autorizado, aguardando envio | sim | | `ET` | Pedido em transporte | sim | | `EN` | Pedido entregue | sim | Nota: `PA` grava o mesmo status de `PG`, mas sem marcar o pedido como pago. Em caso de dúvida, use `PG`. Para clientes do exterior (`tipo_pessoa` = `"E"`), CPF, CNPJ, RG, CEP, número, complemento, bairro e estado deixam de ser obrigatórios. **`subpedido.tipo_pedido`** — **obrigatório**: `"A"` (atacado) ou `"V"` (varejo). Qualquer outro valor, ou não enviar, é recusado. (A descrição antiga dizia que o padrão era atacado; não é.) **Valores** — a API confere duas contas, com 2 casas decimais: 1. `pedido.valor_pedido` = soma de `quantidade × preco` de todos os itens de `produtos`. 2. `pedido.valor_total` = `valor_pedido` − `valor_desconto` + `valor_frete`. Envie `valor_desconto` e `valor_frete` como `0` quando não houver. **Itens (`produtos[]`)** — cada item é localizado pelo `cod_barras` (o mesmo código de barras cadastrado na variação do produto). Envie `cod_barras` em todos os itens, mesmo a tabela mostrando "não". Se `preco` vier vazio, a loja usa o preço de atacado do produto. **`pedido.numero_pedido_externo`** — obrigatório e único. É recusado se já estiver associado a outro pedido. **Cliente** — se o CPF, CNPJ ou e-mail já existir na loja, o cliente existente é usado e os dados enviados não alteram o cadastro. Os campos de pessoa física (`cpf`, `nome_completo`, `data_nascimento`, `sexo`, `rg`) só são exigidos quando `tipo_pessoa` = `"F"`; os de pessoa jurídica (`cnpj`, `nome_empresa`, `responsavel_empresa`, `ie`) só quando `tipo_pessoa` = `"J"`. **Compra rápida** — para registrar só o financeiro, sem itens: envie `"tipo": "compra_rapida"` dentro de `pedido` e não envie `produtos`. **Preenchido pela loja** (não envie): número do pedido, forma de pagamento (sempre "Na Loja Física (Offline)"), moeda (BRL), vendedor (o do cliente). ### Exemplo mínimo Pessoa física, dois itens, pago: ```json { "cliente": { "tipo_pessoa": "F", "nome_completo": "MARIA JOSÉ DA SILVA", "cpf": "12345678909", "data_nascimento": "1986-02-15", "sexo": "Feminino", "rg": "Isento", "email": "maria@exemplo.com.br", "senha": "troque123", "tipo_cliente": "Revendedor", "cep": "37002000", "endereco": "Avenida Imigrantes", "numero": "10", "bairro": "Centro", "cidade": "Varginha", "estado": "MG", "telefone_celular": "35988887777" }, "pedido": { "numero_pedido_externo": "ERP-98765", "status_pedido": "PG", "data_pedido": "2026-11-16", "valor_pedido": 249.76, "valor_desconto": 10.00, "valor_frete": 25.50, "valor_total": 265.26, "cep_entrega": "37002000", "endereco_entrega": "Avenida Imigrantes", "numero_entrega": "10", "bairro_entrega": "Centro", "cidade_entrega": "Varginha", "estado_entrega": "MG" }, "subpedido": { "tipo_pedido": "A" }, "produtos": [ { "cod_barras": "7890000000017", "quantidade": 3, "preco": 43.32 }, { "cod_barras": "7890000000024", "quantidade": 2, "preco": 59.90 } ] } ``` Conta: 3 × 43,32 + 2 × 59,90 = **249,76** (`valor_pedido`); 249,76 − 10,00 + 25,50 = **265,26** (`valor_total`). ```bash curl -X POST "https://api.viashopmoda.com.br/via/pedido/cadastrar/SEU_TOKEN" \ -H "Content-Type: application/json" \ -d @pedido.json ``` ### Respostas Sucesso: ```json { "retorno": true, "msg": "Pedido '111112' cadastrado com sucesso.", "numero_pedido": "111112", "numero_pedido_externo": "ERP-98765" } ``` Erros (`retorno: false`, motivo em `msg_erro`): | Mensagem | Causa | Como resolver | |---|---|---| | `Objeto 'cliente' não enviado` | Falta `cliente`. | Envie o objeto. | | `Objeto 'pedido' não enviado` | Falta `pedido`. | Envie o objeto. | | `'numero_pedido_externo' não enviado no objeto 'pedido'` | Falta o número do ERP. | Envie `pedido.numero_pedido_externo`. | | `Objeto 'subpedido' não enviado` | Falta `subpedido`. | Envie ao menos `{"tipo_pedido": "A"}`. | | `Objeto 'produtos' não enviado` | Falta `produtos` (e não é compra rápida). | Envie os itens. | | `Pedido não cadastrado. 'numero_pedido_externo' 'X' está associado ao pedido 'NNNNNN'` | Esse número do ERP já foi usado. | É um reenvio: o pedido já existe (veja abaixo). | | `status_pedido' desconhecido ou não enviado` | Código de status fora da lista. | Use `AN`, `AG`, `PA`, `PG`, `ET` ou `EN`. | | `tipo_pedido' desconhecido ou não enviado` | `subpedido.tipo_pedido` diferente de `A`/`V`. | Envie `"A"` ou `"V"`. | | `Resultado: X (valor_pedido - valor_desconto + valor_frete) não é igual ao valor_total de Y informado` | Conta 2 das regras não fecha. | Recalcule `valor_total`. | | `A somatória dos produtos enviados de X não confere com o valor_total de Y.` | Conta 1 não fecha (apesar do texto dizer `valor_total`, a comparação é com `valor_pedido`). | Ajuste `valor_pedido` ou os itens. | | Mensagens de validação do cliente | Algum campo de `cliente` inválido. | Veja a tabela de `cliente`. | ### Pode reenviar? Sim, com segurança. Como `numero_pedido_externo` é único, um reenvio do mesmo pedido é **recusado** com a mensagem "está associado ao pedido 'NNNNNN'" — e esse `NNNNNN` é o número que a loja já deu ao pedido. Trate essa resposta como "já cadastrado". ### Efeitos colaterais - **Não altera o estoque.** Depois de cadastrar, envie o saldo novo com `estoque/atualizar`. - Pode **cadastrar o cliente**, se ele ainda não existir. - As observações do pedido recebem "Integração ERP {nome da integração}". ### Onde entra no processo Guia [Pedidos → Pedidos criados fora da loja](https://api.viashopmoda.com.br/docs-api/?p=guias/pedidos&formato=md#pedidos-criados-fora-da-loja). ### Erros comuns de integração - Enviar o nome do status (`"Pedido entregue"`) em vez do código (`"EN"`). Aqui é **código**; em `pedido/atualizar` é **nome**. - Mandar os campos de `pedido` soltos na raiz do JSON. Eles vão dentro de `"pedido": { ... }`. - `valor_total` calculado sobre os itens em vez de sobre `valor_pedido`. - Esperar que o estoque seja baixado automaticamente. --- ## Atualizar status do pedido > O ERP muda o status do pedido (pago, em transporte, entregue, cancelado) e informa pagamento, rastreio e nota. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/atualizar · Atualizado em 18/11/2026 ### O que faz Atualiza o status de um pedido e, opcionalmente, forma de pagamento, parcelas, comprovante, rastreio e nota fiscal. Cancelar devolve o estoque à loja. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/pedido/atualizar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `pedido.numero_pedido` | texto | **sim** | Número do pedido na loja (6 dígitos). | | `pedido.status_pedido` | texto | **sim** | Nome **exato** de um status (tabela abaixo). | | `pedido.forma_pagamento` | texto | não | Nome exato de uma forma de [`formas_pagamento/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/formas_pagamento/consultar&formato=md). Sem ele, mantém a atual. | | `pedido.fixar_pagamento` | texto | não | `"Sim"` obriga o cliente a pagar com essa forma. | | `pedido.url_notafiscal` | texto | não | URL da nota fiscal. | | `subpedido.parcelas_pagamento` | número | não | Parcelas. | | `subpedido.numero_comprovante` | texto | não | Comprovante de pagamento. | | `subpedido.rastreio_frete` | texto | não | Código de rastreio. | Os campos de `subpedido` também são aceitos dentro de `pedido`. ### Status aceitos Use o texto exatamente assim: | Status | Conta como pago? | |---|---| | `Pedido em análise` | não | | `Aguardando Pagamento` | não | | `Falha na tentativa de pagamento` | não | | `Pagamento efetuado, aguardando captura` | sim | | `Pagamento autorizado, aguardando envio` | sim | | `Pedido em transporte` | sim | | `Pedido entregue` | sim | | `Pedido cancelado` | — | > `Aguardando Pagamento` tem o "P" maiúsculo. Os códigos `AN`, `PG`, `EN`… valem **só** em `pedido/cadastrar`, não aqui. ### Regras - `Pedido cancelado` devolve ao estoque da loja os itens que tinham sido baixados. - Um pedido cancelado pode voltar a outro status; a loja anota a mudança nas observações. - As datas de cada etapa são gravadas com a data do dia da atualização. ### Exemplo ```json { "pedido": { "numero_pedido": "111111", "status_pedido": "Pedido em transporte" }, "subpedido": { "rastreio_frete": "BR123456789BR" } } ``` ```json { "retorno": true, "msg": "Pedido '111111' atualizado com sucesso.", "numero_pedido": "111111", "status_antigo": "Pagamento autorizado, aguardando envio", "status_novo": "Pedido em transporte" } ``` Recusas (HTTP 200 com `retorno: false`): | Mensagem | Causa | |---|---| | `POST do pedido deve ser um object (...)` | Corpo não é objeto. | | `'status_pedido' não encontrado` / `'status_pedido' não pode ser vazio` | Falta o status. | | `Status 'X' não encontrado ou não existe` | Grafia diferente da tabela. | ### Pode reenviar? Sim. Reenviar o mesmo status não muda nada além das datas da etapa. ### Onde entra no processo Guia [Pedidos](https://api.viashopmoda.com.br/docs-api/?p=guias/pedidos&formato=md#4-o-erp-atualiza-o-status). --- ## Associar número do pedido no ERP > Depois de criar o pedido no ERP, informa à loja o número que ele ganhou no ERP. Processamento assíncrono. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/associar_codexterno · Atualizado em 18/11/2026 ### O que faz Liga o pedido da loja ao pedido do ERP. É o passo que fecha a importação de cada pedido. Um pedido aceita uma única associação, e um número do ERP só pode estar em um pedido. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/pedido/associar_codexterno/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | | **Processamento** | **Assíncrono.** A resposta confirma que a ação entrou na fila (`automacao_id`). Acompanhe com [`automacao/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/automacao/consultar&formato=md). | ### Campos | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `numero_pedido` | texto | **sim** | Número do pedido na loja (6 dígitos). | | `numero_pedido_externo` | texto | **sim** | Número do pedido no ERP. | ### Exemplo ```json { "numero_pedido": "111111", "numero_pedido_externo": "ERP-98765" } ``` Aceito (entrou na fila): ```json { "retorno": true, "msg": "A automação 'pedido.cadastrar_codexterno' foi cadastrada e será processada.", "automacao_id": "123456", "consultar_automacao": "via/automacao/consultar/{TOKEN}?id=123456" } ``` Recusas (na hora): | Mensagem | Significado | |---|---| | `numero_pedido e numero_pedido_externo são obrigatórios.` | Falta um campo. | | `associação já realizada.` | Esse par já estava associado. Trate como sucesso. | | `numero_pedido_externo já associado ao pedido NNNNNN.` | O número do ERP está em **outro** pedido. | | `pedido não encontrado.` | Número da loja inexistente. | | `pedido já associado ao numero_pedido_externo:X.` | O pedido já tem outro número do ERP. | ### Pode reenviar? Sim: o reenvio devolve "associação já realizada". ### Onde entra no processo Guia [Pedidos](https://api.viashopmoda.com.br/docs-api/?p=guias/pedidos&formato=md#3-o-erp-informa-o-numero-do-pedido-no-erp). --- ## Informar nota fiscal do pedido > Grava a URL da nota fiscal (XML ou DANFE) de um pedido. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/atualizar_notafiscal · Atualizado em 18/11/2026 ### O que faz Grava o link da nota fiscal no pedido. A loja disponibiliza o link ao cliente. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/pedido/atualizar_notafiscal/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `pedido.numero_pedido` | texto | **sim** | Número do pedido na loja. | | `pedido.url_notafiscal` | texto | **sim** | URL completa e pública da nota. | ### Exemplo ```json { "pedido": { "numero_pedido": "111111", "url_notafiscal": "https://seu-erp.com.br/nfe/35260000000000000000550010000012341000012345.xml" } } ``` Sucesso: `{"retorno": true, "msg": "Url da nota fiscal cadastrada com sucesso."}`. Erros: `pedido inválido`, `url da nota fiscal inválida`. ### Pode reenviar? Sim; a URL é substituída. ### Onde entra no processo Guia [Pedidos](https://api.viashopmoda.com.br/docs-api/?p=guias/pedidos&formato=md#5-nota-fiscal). A URL também pode ir em `pedido.url_notafiscal` de [`pedido/atualizar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/atualizar&formato=md). --- ## Consultar tipos de produto (pesos) > Lista os tipos de produto (Vestido, Blusas…). Na API, tipo = peso. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/peso/consultar · Atualizado em 18/11/2026 ### O que faz Lista os **tipos de produto** — o campo `tipo` do produto. A rota se chama `peso` por motivo histórico; não tem relação com o peso em gramas (veja o [Glossário](https://api.viashopmoda.com.br/docs-api/?p=glossario&formato=md)). ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/peso/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `id` | Id do tipo. | | `nome` | Nome exato do tipo. | ### Exemplo ```bash curl "https://api.viashopmoda.com.br/via/peso/consultar/SEU_TOKEN" ``` ```json { "peso": [ { "id": "1", "nome": "Acessórios" }, { "id": "2", "nome": "Vestido" } ] } ``` ### Pode reenviar? Sim (somente leitura). --- ## Cadastrar tipos de produto (pesos) > Cria tipos de produto em lote, pelo nome; os que já existem são devolvidos sem alteração. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/peso/cadastrar · Atualizado em 18/11/2026 ### O que faz Cria tipos de produto (campo `tipo` do produto). Nomes que já existem não são duplicados e aparecem em `nao_cadastrados`, com o id existente. Normalmente não é preciso: [`produto/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/cadastrar&formato=md) cria o tipo pelo nome. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/peso/cadastrar/{TOKEN}` | | **Corpo** | Lista JSON `[ {...}, {...} ]`, até 20 itens por requisição, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos O corpo é uma **lista** `[ {...}, {...} ]` com no máximo 20 itens. Cada item tem os campos abaixo. | Campo | Tipo | Obrigatório | Limites | Descrição | |---|---|---|---|---| | `nome` | string | **sim** | mín. 2, máx. 50 | | ### Regras - O corpo **precisa** ser uma lista, mesmo com um item. - Nome de 2 a 50 caracteres. ### Exemplo ```json [ { "nome": "Blusas e Camisetas" }, { "nome": "Shorts e Bermudas" } ] ``` ```json { "retorno": true, "total": 2, "cadastrados": [ { "id": "60", "nome": "Blusas e Camisetas" } ], "nao_cadastrados": [ { "id": "40", "nome": "Shorts e Bermudas" } ] } ``` `nao_cadastrados` = já existiam (não é erro). Erros: `POST enviado não é um 'array'`, `Peso não cadastrado`. ### Pode reenviar? Sim; os já existentes vêm em `nao_cadastrados`. --- ## Atualizar tipo de produto (peso) > Renomeia um tipo de produto pelo id. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/peso/atualizar · Atualizado em 18/11/2026 ### O que faz Troca o nome de um tipo de produto. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/peso/atualizar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `id` | número | **sim** | Id do tipo ([`peso/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/peso/consultar&formato=md)). | | `nome` | texto | **sim** | Novo nome. | Só o nome é alterado; outros campos enviados são ignorados. ### Exemplo ```json { "id": 2, "nome": "Vestidos" } ``` Sucesso: `{"retorno": true, "msg": "..."}`. Erros: `Body não pode ser um array. Enviar como objeto.`, `parâmetro 'id' do peso a alterar não foi enviado.`, `parâmetro 'nome' não foi enviado.` ### Pode reenviar? Sim. --- ## Atualizar preço de variações > Dá um preço diferente do produto para até 20 variações (ex.: tamanho GG mais caro), ou volta a herdar o preço do produto. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/preco/atualizar · Atualizado em 18/11/2026 ### O que faz Grava o preço próprio de cada variação. `null` faz a variação voltar a usar o preço do produto. Para mudar o preço do **produto** (todas as variações), use [`produto/alterar_precos`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/alterar_precos&formato=md). ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/preco/atualizar/{TOKEN}` | | **Corpo** | Lista JSON `[ {...}, {...} ]`, até 20 itens por requisição, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos O corpo é uma **lista** `[ {...}, {...} ]` com no máximo 20 itens. Cada item tem os campos abaixo. | Campo | Tipo | Obrigatório | Limites | Descrição | |---|---|---|---|---| | `cod_produto` | integer | não | | Código do produto na loja virtual | | `cod_grade` | integer | não | | Consultar códigos da grade em [grade/consultar](https://api.viashopmoda.com.br/docs-api/?p=recursos/grade/consultar&formato=md) | | `cod_estampa` | integer | não | | Consultar códigos da estampa em [estampa/consultar](https://api.viashopmoda.com.br/docs-api/?p=recursos/estampa/consultar&formato=md) | | `cod_barras` | string | não | | Código de barras cadastrado na loja virtual de acordo com o padrão do seu sistema | | `preco_atacado` | double | **sim** | aceita null | Preço especial do SKU no atacado, diferenciando do preço produto. Se não enviado, não será atualizado. Se enviado como NULL, o preço de atacado desse SKU passará a ser o valor do produto. | | `preco_varejo` | double | **sim** | aceita null | Preço especial do SKU no varejo, diferenciando do preço produto. Se não enviado, não será atualizado. Se enviado como NULL, o preço de atacado desse SKU passará a ser o valor do produto. | ### Regras - Identifique a variação por `cod_barras` **ou** por `cod_produto` + `cod_grade` + `cod_estampa`. - Depois de gravar, a loja tenta recalcular o preço do produto como o **menor** preço entre as variações. Para não fazer isso, acrescente `?atualizar_produtos=N` na URL. - Máximo de 20 itens. ### Exemplo ```json [ { "cod_barras": "7890000000103", "preco_atacado": 64.90, "preco_varejo": 129.90 }, { "cod_barras": "7890000000101", "preco_atacado": null, "preco_varejo": null } ] ``` O primeiro item fica com preço próprio; o segundo volta a herdar o preço do produto. ```json { "retorno": true, "qtd_atualizar": 2, "qtd_atualizados": 2, "qtd_nao_atualizados": 0, "qtd_erros": 0, "atualizados": [ ... ], "nao_atualizados": [], "erros": [] } ``` Erros da requisição: `POST de 'produtos' deve ser um array (...)`, `POST de 'produtos' está zerado.`, `Permitido enviar no máximo 20 registros por requisição...`, `Se não enviar 'cod_barras' deverá informar 'cod_produto, cod_grade e cod_estampa' no index [N] do array enviado`. ### Pode reenviar? Sim. ### Onde entra no processo Guia [Estoque e preço](https://api.viashopmoda.com.br/docs-api/?p=guias/estoque-e-preco&formato=md). --- ## Cadastrar ou atualizar produto > Cria o produto com todas as variações (tamanho × cor) e estoque, ou atualiza o produto que já tem o mesmo cod_ref. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/cadastrar · Atualizado em 18/11/2026 ### O que faz Recebe um produto com todas as suas variações e: - se **não existe** produto com o `cod_ref` → cria; - se **existe** → atualiza o produto e **substitui** todas as variações pelas enviadas. Tipo, gênero, coleção, grades e estampas são localizados **pelo nome** e criados se não existirem. **Quando usar:** carga inicial do catálogo e quando dados do cadastro do produto mudam (título, descrição, variações novas). **Quando não usar:** para mudar só estoque (`estoque/atualizar`) ou só preço (`produto/alterar_precos`, `preco/atualizar`). ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/produto/cadastrar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` (JSON cru; form-data é recusado) | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Limites | Descrição | |---|---|---|---|---| | `cod_ref` | string | **sim** | | Código de referência do produto | | `titulo` | string | **sim** | máx. 255, gravado em MAIÚSCULAS | Título do produto | | `descricao` | string | não | | Descrição completa do produto. | | `preco_atacado` | double | **sim** | | Exemplo: 9.99 | | `preco_varejo` | double | **sim** | | Exemplo: 9.99 | | `peso` | numeric | não | | Peso do produto em gramas | | `altura` | numeric | não | | em cm | | `largura` | numeric | não | | em cm | | `comprimento` | numeric | não | | em cm | | `ncm` | string | não | | Código NCM do produto | | `preco_atacado_promo` | double | não | | Exemplo: 9.99 | | `preco_varejo_promo` | double | não | | Exemplo: 9.99 | | `tipo` | integer | **sim** | | O nome do tipo de produto, se não existir será cadastrado. [Consultar método](https://api.viashopmoda.com.br/docs-api/?p=recursos/peso/consultar&formato=md) | | `genero` | integer | **sim** | | O nome do gênero, se não existir será cadastrado. [Consultar método](https://api.viashopmoda.com.br/docs-api/?p=recursos/categoria/consultar&formato=md) | | `colecao` | integer | **sim** | | O nome da coleção, se não existir será cadastrado. [Consultar método](https://api.viashopmoda.com.br/docs-api/?p=recursos/colecao/consultar&formato=md) | | `video_produto` | string | não | | Video de apresentação do produto. Sendo a url do video no youtube ou vimeo no padrão: 'https://vimeo.com/{VIDEO}' ou 'https://youtu.be/{VIDEO}'. | | `video_atacado` | string | não | | Video ensinando os clientes de atacado a vender esse produto. Sendo a url do video no youtube ou vimeono padrão: 'https://vimeo.com/{VIDEO}' ou 'https://youtu.be/{VIDEO}'. | | `seo_title` | string | não | máx. 150 | Título para SEO | | `seo_description` | string | não | máx. 150 | Descrição para SEO | | `estoque` | array | **sim** | | | | `estoque[].estampa` | object | **sim** | | | | `estoque[].estampa.nome` | string | **sim** | mín. 3, máx. 50 | Nome da estampa | | `estoque[].grade` | object | **sim** | | | | `estoque[].grade.nome` | string | **sim** | | Nome da grade. Ex.: 'XG' | | `estoque[].grade.descricao` | string | não | aceita null | Informação adicional para a grade. Ex.: 'Extra G' | | `estoque[].cod_barras` | string | não | | Código de barras cadastrado na loja virtual de acordo com o padrão do seu sistema | | `estoque[].cod_gtin` | string | não | | | | `estoque[].cod_externo` | string | não | | | | `estoque[].quantidade` | integer | **sim** | | Quantidade de estoque q ser atualizada | | `estoque[].preco_atacado` | double | não | aceita null | Preço especial do SKU no atacado, diferenciando do preço produto. Se não enviado, não será atualizado. Se enviado como NULL, o preço de atacado desse SKU passará a ser o valor do produto. | | `estoque[].preco_varejo` | double | não | aceita null | Preço especial do SKU no varejo, diferenciando do preço produto. Se não enviado, não será atualizado. Se enviado como NULL, o preço de atacado desse SKU passará a ser o valor do produto. | ### Regras (valem acima da tabela) **Identificação:** o produto é localizado pelo `cod_ref`. Se houver mais de um com a mesma referência, a loja usa o ativo. **Variações (`estoque`)** - Cada item é uma combinação **grade × estampa**. A mesma combinação repetida faz o cadastro ser recusado. - Ao atualizar, as variações antigas são **apagadas** e as enviadas são criadas de novo. Variação não enviada deixa de existir. - Envie `cod_barras` em todas as variações (a tabela diz "não", mas sem ele não é possível atualizar estoque, preço ou fotos depois). - `quantidade` é o saldo disponível. A margem de segurança configurada na loja é aplicada automaticamente. **`tipo`, `genero`, `colecao`** — envie o **nome** (texto), não o id, apesar da tabela mostrar "integer". Se não existir, é criado. Valor especial `"*DEFAULT"`: num produto novo usa o padrão da loja (para coleção: "Integração ERP"); num produto existente mantém o que já está gravado. **Preços** - `preco_atacado` é obrigatório. Se não vier, a loja usa o menor `preco_atacado` das variações; se nenhuma tiver, o cadastro é recusado. - `preco_varejo` não enviado → menor `preco_varejo` das variações → se não houver, igual ao atacado. - Preço da variação igual ao do produto é gravado como "herda do produto". - Promoção: `preco_*_promo` é o preço promocional e precisa ser **menor** que o preço normal; senão é ignorado. Veja [Estoque e preço](https://api.viashopmoda.com.br/docs-api/?p=guias/estoque-e-preco&formato=md#promocao-de-por). - A loja pode ter um fator de preço configurado para a sua integração; ele é aplicado só nesta rota. **Textos** - `titulo` é gravado em MAIÚSCULAS, até 255 caracteres. - `descricao` aceita só as tags `
`, `

`, `` e ``, sem atributos. As demais são removidas. - `video_produto` / `video_atacado`: só links `https://vimeo.com/...` ou `https://youtu.be/...`. **Medidas:** `peso` em gramas; `altura`, `largura`, `comprimento` em cm (arredondados para cima). `ncm` só com dígitos. **Ao atualizar, a loja mantém** fotos, produtos relacionados (Compre Junto) e SuperVitrine, e **reativa** o produto se ele estava desativado. ### Exemplo ```json { "cod_ref": "VES001", "titulo": "Vestido xadrez flanela", "descricao": "Vestido em flanela leve.
Modelagem: reta
Composição: 100% viscose", "tipo": "Vestido", "genero": "Feminino", "colecao": "Inverno 2026", "preco_atacado": 59.90, "preco_varejo": 119.90, "preco_varejo_promo": 99.90, "peso": 350, "ncm": "62044200", "seo_title": "Vestido xadrez flanela", "estoque": [ { "grade": { "nome": "P" }, "estampa": { "nome": "AZUL CLARO" }, "cod_barras": "7890000000101", "quantidade": 5 }, { "grade": { "nome": "M" }, "estampa": { "nome": "AZUL CLARO" }, "cod_barras": "7890000000102", "quantidade": 8 }, { "grade": { "nome": "GG", "descricao": "Extra grande" }, "estampa": { "nome": "AZUL CLARO" }, "cod_barras": "7890000000103", "quantidade": 2, "preco_atacado": 64.90, "preco_varejo": 129.90 } ] } ``` A variação GG tem preço diferente; as outras herdam o preço do produto. ```bash curl -X POST "https://api.viashopmoda.com.br/via/produto/cadastrar/SEU_TOKEN" \ -H "Content-Type: application/json" \ -d @produto.json ``` ### Respostas Sucesso: ```json { "retorno": true, "msg": "Produto Ref. VES001 cadastrado com sucesso.", "cadastro": true, "cod_produto": 325, "cod_tipo": 51, "cod_colecao": 21, "cod_genero": 1, "estoque": { "estampas": [ { "id": 709, "nome": "AZUL CLARO" } ], "grades": [ { "id": 14, "nome": "P" }, { "id": 15, "nome": "M" }, { "id": 17, "nome": "GG" } ] } } ``` Na atualização, `msg` diz "atualizado com sucesso" e `cadastro` vem `false`. Guarde `cod_produto` e os ids de grade e estampa se o ERP for usar `cod_produto` + `cod_grade` + `cod_estampa`. Erros (`msg_erro`): | Mensagem | Causa | |---|---| | `Item 'tipo' não enviado ou vazio.` | Falta `tipo`. | | `Item 'genero' não enviado ou vazio.` | Falta `genero`. | | `Item 'colecao' não enviado ou vazio.` | Falta `colecao`. | | `Produto VES001 não importado. A estampa ou grade ... esta duplicada nos itens de estoque.` | Mesma grade × estampa repetida. | | `preco_atacado não enviado` | Sem preço de atacado no produto e nas variações. | | `'video_produto' no formato errado. ...` | Link de vídeo fora do padrão. | | `grade: ... no index:N para ref. VES001` | Grade do item N inválida (ex.: nome vazio). | | `estampa: ... index N` | Estampa do item N inválida (nome com menos de 3 ou mais de 50 caracteres). | ### Pode reenviar? Sim. Reenviar o mesmo produto completo produz o mesmo resultado. Atenção apenas para enviar **todas** as variações. ### Onde entra no processo Guia [Catálogo — carga inicial](https://api.viashopmoda.com.br/docs-api/?p=guias/catalogo-carga-inicial&formato=md). ### Erros comuns de integração - Enviar `tipo`, `genero` ou `colecao` como id numérico. - Reenviar com só a variação alterada (as demais somem). - Mandar o corpo como form-data: esta rota exige JSON cru. - Usar esta rota para atualizar estoque a cada venda. --- ## Atualizar textos e SEO do produto > Altera título, descrição, SEO e vídeos de um produto existente sem enviar preço nem estoque. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/atualizar_textos · Atualizado em 18/11/2026 ### O que faz Atualiza **só os textos** de um produto que já existe na loja. Preço, estoque, variações, fotos, coleção, tipo, gênero e status **não são alterados**. Use esta rota quando o preço e o estoque vêm do ERP e você só cuida da vitrine. Reenviar `produto/cadastrar` para isso recria as variações e regrava os preços. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/produto/atualizar_textos/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` (JSON cru; form-data é recusado) | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos Informe o produto por **um** destes: | Campo | Tipo | Descrição | |---|---|---| | `cod_produto` | número | Id do produto na loja. | | `cod_ref` | texto | Código de referência. Se houver mais de um produto com a mesma referência, vale o ativo. | E envie ao menos um dos campos abaixo. **Campo não enviado não é alterado.** | Campo | Tipo | Limite | Descrição | |---|---|---|---| | `titulo` | texto | 255 | Nome do produto. Não pode ser vazio. | | `descricao` | texto | — | Descrição completa. Aceita só `
`, `

`, `` e ``; as outras tags são removidas. `""` apaga a descrição. | | `seo_title` | texto | 150 | Título para buscadores. `""` limpa. | | `seo_description` | texto | 150 | Descrição para buscadores. `""` limpa. | | `seo_h1` | texto | 150 | Título principal (H1) da página do produto. `""` limpa. | | `video_produto` | texto | — | Link `https://vimeo.com/...` ou `https://youtu.be/...`. `""` remove. | | `video_atacado` | texto | — | Mesmo formato, vídeo do atacado. `""` remove. | O endereço (URL) do produto **não muda** quando o título é alterado, para não quebrar links e a indexação. ### Exemplo ```json { "cod_ref": "0000618", "titulo": "Vestido Midi Azul Marinho", "seo_title": "Vestido Midi Azul Marinho | Coleção Verão", "seo_description": "Vestido midi em viscose, alças finas, do P ao GG." } ``` Sucesso: ```json { "retorno": true, "msg": "Textos do produto Ref. 0000618 atualizados.", "cod_produto": 325, "cod_ref": "0000618", "campos_atualizados": ["titulo", "seo_title", "seo_description"] } ``` ### Erros | Mensagem | Causa | |---|---| | `Informe 'cod_produto' ou 'cod_ref'.` | Falta identificar o produto. | | `Produto não encontrado.` | Id ou referência inexistente. | | `Nenhum campo para atualizar...` | Nenhum dos campos de texto foi enviado. | | `'titulo' não pode ser vazio.` | Título enviado como `""`. | | `'' tem mais de N caracteres.` | Passou do limite da tabela acima. | | `'' deve ser texto.` | Valor enviado como número, lista ou objeto. | | `'video_produto' no formato errado...` | Link que não é do Vimeo nem do youtu.be. | ### Pode reenviar? Sim. Reenviar o mesmo conteúdo deixa o produto igual. ### Onde entra no processo Ajustes de vitrine depois da carga do catálogo. Dispara o webhook `produto.atualizado` — guia [Catálogo](https://api.viashopmoda.com.br/docs-api/?p=guias/catalogo-carga-inicial&formato=md#reenviar-um-produto-atualizacao). --- ## Consultar produtos > Busca produtos por id, referência, código externo, código de barras ou período de atualização, com variações e fotos. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/consultar · Atualizado em 18/11/2026 ### O que faz Devolve produtos com as variações (`estoque`) e as fotos. Use **um** filtro por vez. ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/produto/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `id` | Id do produto na loja (qualquer status). | | `cod_ref` | Código de referência (só produtos ativos). | | `cods_refs` | Várias referências separadas por vírgula (só ativos). | | `cod_externo` | Código do produto no ERP (só ativos). | | `cod_barras` | Código de barras de uma variação (qualquer status). | | `data_inicial` | Início do período de atualização (aaaa-mm-dd). Usar com data_final. | | `data_final` | Fim do período de atualização (aaaa-mm-dd). | | `pagina` | Página (20 registros por página). Ex.: pagina=2 | ### Regras - Ordem de prioridade se vier mais de um filtro: `id`, `cod_ref`, `cod_externo`, `cods_refs`, `cod_barras`, período. - `cod_ref`, `cods_refs` e `cod_externo` só encontram produtos **ativos**; `id` e `cod_barras` encontram qualquer status. - Sem filtro: produtos ativos de coleções ativas, 20 por página. - Preços: `preco_*` é o preço de venda e `preco_*_promo` é o preço "de" (normal), quando há promoção. Veja [Estoque e preço](https://api.viashopmoda.com.br/docs-api/?p=guias/estoque-e-preco&formato=md#promocao-de-por). - Preço vazio na variação = usa o preço do produto. - As URLs das fotos têm validade curta (cerca de 10 minutos). Para renovar, use [`imagens/novo_token`](https://api.viashopmoda.com.br/docs-api/?p=recursos/imagens/novo_token&formato=md). ### Exemplo ```bash curl "https://api.viashopmoda.com.br/via/produto/consultar/SEU_TOKEN?cod_ref=VES001" ``` ```json { "produto": [ { "id": "325", "cod_ref": "VES001", "cod_externo": "ERP-VES001", "titulo": "VESTIDO XADREZ FLANELA", "preco_atacado": "59.90", "preco_varejo": "99.90", "preco_atacado_promo": "0.00", "preco_varejo_promo": "119.90", "data_atualizacao": "2026-11-16", "colecao": "INVERNO 2026", "tipo": "VESTIDO", "genero": "FEMININO", "fotos": [ { "cod_estampa": "709", "arquivo": "https://imagens.viashopmoda.com.br/api?img=..." } ], "estoque": [ { "cod_produto": "325", "cod_grade": "14", "cod_estampa": "709", "quantidade": "5", "preco_atacado": "", "preco_varejo": "", "cod_barras": "7890000000101", "cod_grade_externo": null, "cod_estampa_externo": null } ] } ] } ``` ### Pode reenviar? Sim (somente leitura). Cada página conta uma requisição no limite. ### Onde entra no processo Conferência do catálogo — guia [Catálogo](https://api.viashopmoda.com.br/docs-api/?p=guias/catalogo-carga-inicial&formato=md). --- ## Desativar produto > Tira o produto da loja e apaga todas as variações dele. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/desativar · Atualizado em 18/11/2026 ### O que faz Marca o produto como inativo e **apaga todas as variações** (estoque), registrando no histórico de estoque. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/produto/desativar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` (JSON cru; form-data é recusado) | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `id` | número | **sim** | Id do produto na loja (`cod_produto`). | ### Regras - Para voltar a vender, reenvie o produto **completo** com [`produto/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/cadastrar&formato=md) — as variações precisam ser recriadas. - Depois de desativado, o produto não aparece em `produto/consultar?cod_ref=` (só por `?id=`). ### Exemplo ```json { "id": 325 } ``` Sucesso: `{"retorno": true, "msg": "..."}` — a mensagem informa quantas variações foram removidas. ### Pode reenviar? Sim; o produto continua desativado. ### Onde entra no processo Guia [Catálogo](https://api.viashopmoda.com.br/docs-api/?p=guias/catalogo-carga-inicial&formato=md#desativar-um-produto). --- ## Verificar se produtos existem > Informa, para uma lista de referências ou códigos externos, quais produtos ativos existem na loja. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/verificar · Atualizado em 18/11/2026 ### O que faz Confere em lote se existem produtos **ativos** com as referências (ou códigos externos) enviadas. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/produto/verificar/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` (JSON cru; form-data é recusado) | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos Envie **uma** das listas (se vierem as duas, vale a primeira): | Campo | Tipo | Descrição | |---|---|---| | `cod_refs` | lista de textos | Códigos de referência. | | `cod_externos` | lista de textos | Códigos do produto no ERP. | ### Exemplo ```json { "cod_refs": ["VES001", "BLU020", "XYZ999"] } ``` ```json { "retorno": true, "msg": "Verificação concluída.", "verificacao": [ { "VES001": { "existe": true, "data_atualizacao": "2026-11-16" } }, { "BLU020": { "existe": true, "data_atualizacao": "2026-10-02" } }, { "XYZ999": { "existe": false } } ] } ``` ### Pode reenviar? Sim (somente leitura). ### Onde entra no processo Útil antes da carga inicial para saber o que já existe — guia [Catálogo](https://api.viashopmoda.com.br/docs-api/?p=guias/catalogo-carga-inicial&formato=md). --- ## Alterar preços de produtos > Muda os preços de atacado, varejo e promoção de até 20 produtos por requisição, sem mexer nas variações. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/alterar_precos · Atualizado em 18/11/2026 ### O que faz Atualiza os quatro preços do produto. As variações sem preço próprio passam a usar os novos preços. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/produto/alterar_precos/{TOKEN}` | | **Corpo** | Lista JSON `[ {...}, {...} ]`, até 20 itens por requisição, cabeçalho `Content-Type: application/json` (JSON cru; form-data é recusado) | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos (de cada item) | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `cod_produto` ou `cod_ref` | texto | **um dos dois** | Identifica o produto. Se vierem os dois, vale `cod_ref`. | | `preco_atacado` | número | **sim** | Não pode ser 0. | | `preco_varejo` | número | não | `0` ou ausente → atacado + margem sugerida da loja. | | `preco_atacado_promo` | número | não | Preço promocional de atacado (menor que `preco_atacado`). | | `preco_varejo_promo` | número | não | Preço promocional de varejo (menor que `preco_varejo`). | ### Regras - Aceita um objeto ou uma lista. Mais de 20 itens: os excedentes são **descartados** e a resposta avisa em `msg_alerta` — a requisição não é recusada. - Promoção: veja [Estoque e preço](https://api.viashopmoda.com.br/docs-api/?p=guias/estoque-e-preco&formato=md#promocao-de-por). - O fator de preço por integração **não** é aplicado aqui (só em `produto/cadastrar`). ### Exemplo ```json [ { "cod_ref": "VES001", "preco_atacado": 59.90, "preco_varejo": 119.90, "preco_varejo_promo": 99.90 }, { "cod_produto": "144", "preco_atacado": 129.99, "preco_varejo": 259.00 } ] ``` ```json { "retorno": true, "qtd_atualizar": 2, "qtd_atualizados": 2, "qtd_nao_atualizar": 0, "atualizados": ["Item[0]: cod_ref VES001", "Item[1]: cod_produto 144"], "nao_atualizados": [] } ``` Erros por item aparecem em `nao_atualizados`, por exemplo `cod_produto ou cod_ref de ser informado.` ou `preco_atacado não pode ser vazio ou 0.` ### Pode reenviar? Sim; o resultado é o mesmo. ### Onde entra no processo Guia [Estoque e preço](https://api.viashopmoda.com.br/docs-api/?p=guias/estoque-e-preco&formato=md). --- ## Ver por que um produto não aparece à venda > Lista o que impede um produto de ser vendido na loja — preço zerado, sem foto, sem estoque, inativo ou coleção indisponível. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/ocorrencias · Atualizado em 18/11/2026 ### O que faz Diagnostica um produto e devolve a lista de impedimentos para ele aparecer à venda. ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/produto/ocorrencias/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `id` | Id do produto na loja. | ### Impedimentos verificados | Campo | Motivo | |---|---| | `preco_varejo` / `preco_atacado` | `zerado` | | `fotos` | `não encontrado` (produto sem foto) | | `estoque` | `não encontrado` (sem variações) ou `sem estoque` (soma das quantidades ≤ 0) | | `status` | `não ativo` | | `colecao` | `não encontrado`, ou o motivo da coleção: inativa, pré-venda fora do período, restrita a etiquetas de clientes | ### Exemplo ```bash curl "https://api.viashopmoda.com.br/via/produto/ocorrencias/SEU_TOKEN?id=325" ``` Com impedimentos: ```json { "retorno": true, "campos_impeditivos": [ ["fotos", "não encontrado"], ["estoque", "sem estoque"] ] } ``` Sem impedimentos: `{"retorno": true, "mensagem": "Produto sem ocorrências impeditivas"}`. ### Pode reenviar? Sim (somente leitura). ### Onde entra no processo Último passo da carga — guia [Catálogo](https://api.viashopmoda.com.br/docs-api/?p=guias/catalogo-carga-inicial&formato=md#4-conferir-se-o-produto-esta-a-venda). --- ## Mover produtos de coleção > Transfere para outra coleção uma lista de produtos ou todos os produtos ativos de uma coleção. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/alterar_colecao · Atualizado em 18/11/2026 ### O que faz Move produtos para a coleção `colecao_para`. Escolha **um** modo: - `cods_produtos`: os produtos da lista; - `colecao_de`: todos os produtos **ativos** dessa coleção. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/produto/alterar_colecao/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` (JSON cru; form-data é recusado) | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `colecao_para` | texto | **sim** | Nome de uma coleção **ativa** existente. | | `cods_produtos` | lista | um dos dois | Ids dos produtos (`cod_produto`). | | `colecao_de` | texto | um dos dois | Nome da coleção de origem (ativa). Se vierem os dois, vale `colecao_de`. | ### Exemplo ```json { "colecao_de": "VERÃO 2026", "colecao_para": "OUTLET" } ``` ```json { "cods_produtos": [325, 326, 327], "colecao_para": "OUTLET" } ``` Sucesso: `{"retorno": true, "mensagem": "3 produtos foram transferidos para coleção OUTLET."}` ### Erros | Mensagem | Causa | |---|---| | `colecao_para é obrigatório` | Falta o destino. | | `cods_produtos ou colecao_de é obrigatório` | Falta a origem. | | `colecao_para duplicada ou não encontrada` | Coleção de destino inexistente, inativa ou com nome repetido. | | `cods_produtos não é um array` | Envie uma lista. | | `colecao_de duplicada ou não encontrada` / `colecao_de não possui produtos ativos` | Problema na coleção de origem. | | `produtos não encontrados` | Nenhum dos ids existe. | ### Pode reenviar? Sim; os produtos ficam na coleção de destino. ### Onde entra no processo Organização da vitrine — guia [Catálogo](https://api.viashopmoda.com.br/docs-api/?p=guias/catalogo-carga-inicial&formato=md#organizar-a-vitrine). --- ## Agrupar produtos na SuperVitrine > Liga produtos que são o mesmo modelo em cores diferentes, cadastrados como produtos separados. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/associar_supervitrine · Atualizado em 18/11/2026 ### O que faz Algumas lojas cadastram um produto **por cor** (ex.: `001 - Preto`, `001 - Verde`). A SuperVitrine liga esses produtos para que a página de cada um mostre as outras cores. Cada produto da lista passa a apontar para **todos** os produtos da lista (o grupo inteiro é substituído). ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/produto/associar_supervitrine/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` (JSON cru; form-data é recusado) | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos Envie **uma** das listas: | Campo | Tipo | Descrição | |---|---|---| | `ids` | lista | Ids dos produtos (`cod_produto`). | | `cods_ref` | lista | Códigos de referência. | Só produtos **ativos** são associados. ### Exemplo ```json { "cods_ref": ["001 - PRETO", "001 - VERDE", "001 - VERMELHO"] } ``` ```json { "retorno": true, "associados": "2032, 2033", "nao_associados": "2034" } ``` Erro: `ids ou cods_ref precisa ser array`. ### Pode reenviar? Sim. Para mudar o grupo, envie a lista completa nova. ### Onde entra no processo Guia [Catálogo](https://api.viashopmoda.com.br/docs-api/?p=guias/catalogo-carga-inicial&formato=md#organizar-a-vitrine). --- ## Definir produtos do Compre Junto > Define a lista de produtos sugeridos junto com um produto (relacionados). Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/associar_comprejunto · Atualizado em 18/11/2026 ### O que faz Grava os produtos sugeridos na página de um produto. A lista enviada **substitui** a anterior. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/produto/associar_comprejunto/{TOKEN}` | | **Corpo** | Objeto JSON `{ ... }`, cabeçalho `Content-Type: application/json` (JSON cru; form-data é recusado) | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `cod_produto` | texto | **sim** | Id do produto principal. | | `associar_ids` | lista | **sim** | Ids dos produtos sugeridos. Lista vazia remove as sugestões. | ### Exemplo ```json { "cod_produto": "285", "associar_ids": ["253", "295"] } ``` ```json { "retorno": true, "cod_produto": "285", "ids_associados": "253,295" } ``` ### Pode reenviar? Sim; o resultado é o mesmo. ### Onde entra no processo Guia [Catálogo](https://api.viashopmoda.com.br/docs-api/?p=guias/catalogo-carga-inicial&formato=md#organizar-a-vitrine). --- ## Listar campos do cadastro de produto > Devolve os nomes dos campos do cabeçalho do produto aceitos em produto/cadastrar. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/campos · Atualizado em 18/11/2026 ### O que faz Lista os campos do **cabeçalho** do produto (não inclui os campos das variações em `estoque`). A referência completa, com tipos e limites, está em [`produto/cadastrar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/cadastrar&formato=md). ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/produto/campos/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Esta consulta não tem parâmetros. ### Exemplo ```bash curl "https://api.viashopmoda.com.br/via/produto/campos/SEU_TOKEN" ``` Resposta: `{"campos": { "cod_ref": "...", "titulo": "...", ... }}`. ### Pode reenviar? Sim (somente leitura). --- ## Consultar itens de um pedido > Lista crua dos itens de um pedido (ids de produto, grade e estampa, quantidade e preço). Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/sacola/consultar · Atualizado em 18/11/2026 ### O que faz Devolve todas as linhas de itens de um pedido, só com ids, quantidade e preço. Para itens com código de barras, nomes e fotos, prefira [`pedido/consultar?pedido=`](https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/consultar&formato=md). ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/sacola/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `pedido` | Número do pedido (6 dígitos). | ### Exemplo ```json { "sacola": [ { "cod_produto": 325, "cod_grade": 14, "cod_estampa": 709, "quantidade": 3, "preco": 43.32 } ] } ``` A lista inclui também linhas removidas do pedido (quantidade 0). ### Pode reenviar? Sim (somente leitura). --- ## Consultar sacola abandonada > Cliente, itens com foto e valor total de uma sacola não finalizada, a partir da sessão recebida no webhook. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/sacola_abandonada/consultar · Atualizado em 18/11/2026 ### O que faz Devolve os dados de uma sacola abandonada para ações de recuperação (mensagem, e-mail, ligação da vendedora). ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/sacola_abandonada/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `sessao` | Identificador da sessão recebido no webhook de sacola abandonada. | ### Exemplo ```bash curl "https://api.viashopmoda.com.br/via/sacola_abandonada/consultar/SEU_TOKEN?sessao=abc123" ``` Resposta (resumida): ```json { "cliente": { "nome_completo": "MARIA JOSÉ DA SILVA", "email": "maria@exemplo.com.br", ... }, "simulacao": { "data": "2026-11-16", "origem_acesso": "Instagram", "utm": "...", "valor_total": 249.76, "total_produtos": 5 }, "produtos": [ { "cod_referencia": "VES001", "descricao": "VESTIDO XADREZ FLANELA", "grade": "P", "estampa_descricao": "AZUL CLARO", "quantidade": 3, "preco": 43.32, "cod_barras": "7890000000101", "foto_principal": "https://..." } ] } ``` ### Pode reenviar? Sim (somente leitura). ### Onde entra no processo Guia [Vendas e marketing](https://api.viashopmoda.com.br/docs-api/?p=guias/vendas-e-marketing&formato=md#sacola-abandonada). --- ## Consultar status de pedido da loja > Lista os status de pedido da loja e o nome correspondente no ERP, quando configurado. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/status_pedido/consultar · Atualizado em 18/11/2026 ### O que faz Mostra os status de pedido e o "de/para" com os nomes do ERP (`erp_envia`, `erp_recebe`). ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/status_pedido/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `id` | Id do status. | | `nome` | Nome do status. | | `erp_envia` | Nome que o ERP usa para o status. | ### Exemplo ```json { "status_pedido": [ { "id": "1", "nome": "Pedido em análise", "erp_envia": null, "erp_recebe": null }, { "id": "5", "nome": "Pedido em transporte", "erp_envia": "Despachado", "erp_recebe": "Despachado" } ] } ``` ### Pode reenviar? Sim (somente leitura). --- ## Associar nomes de status do ERP > Grava o nome que o ERP usa para cada status de pedido da loja (de/para). Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/status_pedido/associar · Atualizado em 18/11/2026 ### O que faz Para cada status da loja, grava os nomes equivalentes no ERP. Depois disso, `pedido/consultar` passa a trazer `status_pedido_externo`. `pedido/atualizar` continua exigindo o **nome da loja**. ### Requisição | | | |---|---| | **Método** | `POST` | | **URL** | `https://api.viashopmoda.com.br/via/status_pedido/associar/{TOKEN}` | | **Corpo** | Lista JSON `[ {...}, {...} ]`, até 20 itens por requisição, cabeçalho `Content-Type: application/json` | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Campos (de cada item) | Campo | Tipo | Obrigatório | Descrição | |---|---|---|---| | `id_status_pedido` | número | **sim** | Id do status da loja ([`status_pedido/consultar`](https://api.viashopmoda.com.br/docs-api/?p=recursos/status_pedido/consultar&formato=md)). | | `status_envia` | texto | não | Nome do status no ERP, enviado ao ERP pela loja. | | `status_recebe` | texto | não | Nome do status no ERP, recebido do ERP. | ### Exemplo ```json [ { "id_status_pedido": 5, "status_envia": "Despachado", "status_recebe": "Despachado" }, { "id_status_pedido": 6, "status_envia": "Entregue", "status_recebe": "Entregue" } ] ``` ```json { "atualizados": "5, 6", "nao_atualizados": [] } ``` Erro: `POST de associação de status deve ser um array. (object)`. ### Pode reenviar? Sim. --- ## Consultar vendedores > Lista vendedores e representantes da loja, para vincular clientes. Fonte: https://api.viashopmoda.com.br/docs-api/?p=recursos/vendedores/consultar · Atualizado em 18/11/2026 ### O que faz Sem filtro, lista os usuários com cargo **Vendedor** ou **Representante Externo**. ### Requisição | | | |---|---| | **Método** | `GET` | | **URL** | `https://api.viashopmoda.com.br/via/vendedores/consultar/{TOKEN}` | | **Corpo** | Nenhum. Filtros vão na query string (`?campo=valor&...`). | | **Token** | Substitua `{TOKEN}` pelo token da loja. Ele vai no caminho da URL, não em cabeçalho. | ### Parâmetros Todos os parâmetros são opcionais e vão na query string. Use um filtro por vez, salvo quando a descrição disser para combinar. | Parâmetro | Descrição | |---|---| | `id` | Id do vendedor (texto codificado). | | `email` | E-mail do vendedor. | | `whatsapp` | WhatsApp do vendedor. | ### Exemplo ```json { "retorno": true, "vendedores": [ { "id": "MQ", "nome": "Ana", "email": "vendedora@loja.com.br", "whatsapp": "(35) 99999-0000", "cargo": "Vendedor" } ] } ``` O `id` é um texto codificado; use como recebido em `cliente/cadastrar` (`"vendedor": {"id": "MQ"}`). ### Pode reenviar? Sim (somente leitura).