# 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. Para responder perguntas sobre esta API, leia primeiro o arquivo completo: https://api.viashopmoda.com.br/docs-api/llms-full.txt Especificação OpenAPI 3.1 (rotas e schemas dos campos): https://api.viashopmoda.com.br/docs-api/openapi.json ## Comece aqui - [Introdução](https://api.viashopmoda.com.br/docs-api/?p=inicio&formato=md): O que é a API, como chamar, como ler as respostas e por onde começar a integração. - [Glossário](https://api.viashopmoda.com.br/docs-api/?p=glossario&formato=md): O que cada termo significa nesta API — vários nomes não são os que um ERP costuma usar. ## Guias de processo (como a integração deve funcionar) - [Integração ERP — visão geral](https://api.viashopmoda.com.br/docs-api/?p=guias/integracao-erp&formato=md): O que o ERP envia para a loja, o que a loja avisa ao ERP e a ordem de implementação recomendada. - [Catálogo — carga inicial e manutenção de produtos](https://api.viashopmoda.com.br/docs-api/?p=guias/catalogo-carga-inicial&formato=md): 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. - [Estoque e preço — atualização contínua](https://api.viashopmoda.com.br/docs-api/?p=guias/estoque-e-preco&formato=md): Como manter estoque e preços em dia depois da carga inicial, sem estourar os limites. - [Clientes](https://api.viashopmoda.com.br/docs-api/?p=guias/clientes&formato=md): Como os cadastros de clientes circulam entre a loja e o ERP — cadastro, atualização, duplicidade, consignado, vendedor e etiquetas. - [Pedidos](https://api.viashopmoda.com.br/docs-api/?p=guias/pedidos&formato=md): 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. - [Vendas e marketing](https://api.viashopmoda.com.br/docs-api/?p=guias/vendas-e-marketing&formato=md): Cupons, sacola abandonada, formas de pagamento, status personalizados, vendedores e dados da loja. - [Webhooks](https://api.viashopmoda.com.br/docs-api/?p=guias/webhooks&formato=md): Quais avisos a loja envia ao ERP, como configurar e como processar sem perder nem duplicar eventos. - [Erros, limites e paginação](https://api.viashopmoda.com.br/docs-api/?p=guias/erros-limites-paginacao&formato=md): Como interpretar cada resposta de erro, quando tentar de novo e como paginar consultas sem estourar o limite. - [Checklist antes de ir para produção](https://api.viashopmoda.com.br/docs-api/?p=guias/checklist-producao&formato=md): Lista de verificação para revisar a integração antes de ligar na loja de verdade. ## Referência de endpoints - [Acompanhar uma ação assíncrona](https://api.viashopmoda.com.br/docs-api/?p=recursos/automacao/consultar&formato=md): Mostra o andamento de uma ação que foi para a fila (upload de imagem, associação de código do ERP). - [Consultar gêneros (categorias)](https://api.viashopmoda.com.br/docs-api/?p=recursos/categoria/consultar&formato=md): Lista os gêneros da loja (Feminino, Masculino, Infantil…). Na API, gênero = categoria. - [Cadastrar gênero (categoria)](https://api.viashopmoda.com.br/docs-api/?p=recursos/categoria/cadastrar&formato=md): Cria um gênero pelo nome; se já existir, devolve o id do existente. - [Atualizar gênero (categoria)](https://api.viashopmoda.com.br/docs-api/?p=recursos/categoria/atualizar&formato=md): Renomeia um gênero pelo id. - [Cadastrar cliente](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/cadastrar&formato=md): 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). - [Atualizar cliente](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/atualizar&formato=md): Altera só os campos enviados de um cliente, localizado por cod_cliente, CPF, CNPJ ou e-mail na URL. - [Consultar clientes](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/consultar&formato=md): Busca um cliente por CPF, CNPJ, e-mail ou código, ou lista os cadastrados num período. - [Definir limite de cliente consignado](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/atualizar_consignado&formato=md): Torna clientes consignados e define o valor máximo de compra, por e-mail, em lote. - [Adicionar/remover etiquetas do cliente](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/etiquetas&formato=md): Aplica e retira etiquetas de CRM de um cliente, pelo e-mail. - [Associar código do cliente no ERP](https://api.viashopmoda.com.br/docs-api/?p=recursos/cliente/associar_codexterno&formato=md): Grava no cliente da loja o código que ele tem no ERP. Processamento assíncrono. - [Trocar código de barras](https://api.viashopmoda.com.br/docs-api/?p=recursos/cod_barras/atualizar&formato=md): Troca o código de barras de até 20 variações já existentes. - [Verificar códigos de barras](https://api.viashopmoda.com.br/docs-api/?p=recursos/cod_barras/verificar&formato=md): Informa quais códigos de barras de uma lista já existem na loja. - [Associar código do ERP a produto, tipo, grade ou estampa](https://api.viashopmoda.com.br/docs-api/?p=recursos/cod_externo/associar&formato=md): 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. - [Consultar coleções](https://api.viashopmoda.com.br/docs-api/?p=recursos/colecao/consultar&formato=md): Lista as coleções da loja; por padrão só as ativas. - [Cadastrar coleção](https://api.viashopmoda.com.br/docs-api/?p=recursos/colecao/cadastrar&formato=md): Cria uma coleção pelo nome; se já existir uma ativa com esse nome, devolve o id dela. - [Atualizar coleção](https://api.viashopmoda.com.br/docs-api/?p=recursos/colecao/atualizar&formato=md): Renomeia uma coleção pelo id. - [Consultar cores](https://api.viashopmoda.com.br/docs-api/?p=recursos/cor/consultar&formato=md): Lista as cores sólidas (estampas do tipo hexadecimal). - [Cadastrar cupom](https://api.viashopmoda.com.br/docs-api/?p=recursos/cupom/cadastrar&formato=md): Cria um cupom de desconto percentual ou em reais, com validade e quantidade de usos. - [Atualizar cupom](https://api.viashopmoda.com.br/docs-api/?p=recursos/cupom/atualizar&formato=md): Altera um cupom pelo id — enviando todos os campos, não só os que mudaram. - [Consultar cupons](https://api.viashopmoda.com.br/docs-api/?p=recursos/cupom/consultar&formato=md): Lista os cupons válidos ou busca um cupom pelo código ou id. - [Consultar estampas (cores/variações)](https://api.viashopmoda.com.br/docs-api/?p=recursos/estampa/consultar&formato=md): Lista as estampas ativas — cores sólidas (hex) e estampas com imagem. - [Cadastrar estampas (cores/variações)](https://api.viashopmoda.com.br/docs-api/?p=recursos/estampa/cadastrar&formato=md): Cria estampas em lote pelo nome; as que já existem são devolvidas sem alteração. - [Atualizar estampa](https://api.viashopmoda.com.br/docs-api/?p=recursos/estampa/atualizar&formato=md): Renomeia uma estampa e/ou transforma em cor sólida com um código hexadecimal. - [Atualizar estoque](https://api.viashopmoda.com.br/docs-api/?p=recursos/estoque/atualizar&formato=md): Grava o saldo disponível de até 20 variações por requisição, identificadas por código de barras, código externo ou ids. - [Atualizar estoque (callback)](https://api.viashopmoda.com.br/docs-api/?p=recursos/estoque/callback&formato=md): Mesmo comportamento de estoque/atualizar, em outro endereço — para ERPs que precisam de uma URL de retorno separada. - [Consultar estoque](https://api.viashopmoda.com.br/docs-api/?p=recursos/estoque/consultar&formato=md): Saldo e dados das variações — uma, as de um produto, as de um pedido ou todas (100 por página). - [Consultar etiquetas de CRM](https://api.viashopmoda.com.br/docs-api/?p=recursos/etiquetas/consultar&formato=md): Lista todas as etiquetas de CRM da loja, com id e cor. - [Consultar formas de pagamento](https://api.viashopmoda.com.br/docs-api/?p=recursos/formas_pagamento/consultar&formato=md): Lista as formas de pagamento da loja com tipo online/offline. - [Consultar fotos](https://api.viashopmoda.com.br/docs-api/?p=recursos/fotos/consultar&formato=md): Busca registros de fotos por id, lista de ids ou nome de arquivo. - [Consultar grades (tamanhos)](https://api.viashopmoda.com.br/docs-api/?p=recursos/grade/consultar&formato=md): Lista os tamanhos cadastrados, com descrição e código do ERP. - [Cadastrar grades (tamanhos)](https://api.viashopmoda.com.br/docs-api/?p=recursos/grade/cadastrar&formato=md): Cria tamanhos em lote pelo nome; tamanhos já existentes têm a descrição atualizada. - [Atualizar grade (tamanho)](https://api.viashopmoda.com.br/docs-api/?p=recursos/grade/atualizar&formato=md): Renomeia uma grade e/ou muda a descrição, pelo id. - [Enviar foto de produto ou de estampa](https://api.viashopmoda.com.br/docs-api/?p=recursos/imagens/upload&formato=md): 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. - [Remover fotos de um produto](https://api.viashopmoda.com.br/docs-api/?p=recursos/imagens/remover&formato=md): Remove fotos de um produto informando as URLs de origem usadas no upload. - [Renovar o link de uma imagem](https://api.viashopmoda.com.br/docs-api/?p=recursos/imagens/novo_token&formato=md): Gera um novo link válido para uma imagem cujo link (devolvido por uma consulta) expirou. - [Consultar leads](https://api.viashopmoda.com.br/docs-api/?p=recursos/leads/consultar&formato=md): Lista contatos que ainda não são clientes (deixaram e-mail ou WhatsApp), por id, contato ou período. - [Cadastrar lead](https://api.viashopmoda.com.br/docs-api/?p=recursos/leads/cadastrar&formato=md): Registra um contato (nome e e-mail ou WhatsApp) vindo de um formulário externo, como uma landing page. - [Consultar saldo de requisições do dia](https://api.viashopmoda.com.br/docs-api/?p=recursos/limites_api/consultar&formato=md): Quantas requisições a loja ainda pode fazer hoje. - [Solicitar aumento de limite (desativada)](https://api.viashopmoda.com.br/docs-api/?p=recursos/limites_api/solicitar&formato=md): Rota desativada — sempre responde que a solicitação não foi atendida. Peça aumento de limite ao suporte. - [Consultar dados da loja](https://api.viashopmoda.com.br/docs-api/?p=recursos/loja/consultar&formato=md): Nome, CNPJ, cidade, margem sugerida de varejo e banners da loja. - [Consultar pedidos](https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/consultar&formato=md): Um pedido completo (por número na loja ou no ERP) ou listas por período ou por cliente. - [Cadastrar pedido criado fora da loja](https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/cadastrar&formato=md): 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. - [Atualizar status do pedido](https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/atualizar&formato=md): O ERP muda o status do pedido (pago, em transporte, entregue, cancelado) e informa pagamento, rastreio e nota. - [Associar número do pedido no ERP](https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/associar_codexterno&formato=md): Depois de criar o pedido no ERP, informa à loja o número que ele ganhou no ERP. Processamento assíncrono. - [Informar nota fiscal do pedido](https://api.viashopmoda.com.br/docs-api/?p=recursos/pedido/atualizar_notafiscal&formato=md): Grava a URL da nota fiscal (XML ou DANFE) de um pedido. - [Consultar tipos de produto (pesos)](https://api.viashopmoda.com.br/docs-api/?p=recursos/peso/consultar&formato=md): Lista os tipos de produto (Vestido, Blusas…). Na API, tipo = peso. - [Cadastrar tipos de produto (pesos)](https://api.viashopmoda.com.br/docs-api/?p=recursos/peso/cadastrar&formato=md): Cria tipos de produto em lote, pelo nome; os que já existem são devolvidos sem alteração. - [Atualizar tipo de produto (peso)](https://api.viashopmoda.com.br/docs-api/?p=recursos/peso/atualizar&formato=md): Renomeia um tipo de produto pelo id. - [Atualizar preço de variações](https://api.viashopmoda.com.br/docs-api/?p=recursos/preco/atualizar&formato=md): 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. - [Cadastrar ou atualizar produto](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/cadastrar&formato=md): Cria o produto com todas as variações (tamanho × cor) e estoque, ou atualiza o produto que já tem o mesmo cod_ref. - [Atualizar textos e SEO do produto](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/atualizar_textos&formato=md): Altera título, descrição, SEO e vídeos de um produto existente sem enviar preço nem estoque. - [Consultar produtos](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/consultar&formato=md): Busca produtos por id, referência, código externo, código de barras ou período de atualização, com variações e fotos. - [Desativar produto](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/desativar&formato=md): Tira o produto da loja e apaga todas as variações dele. - [Verificar se produtos existem](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/verificar&formato=md): Informa, para uma lista de referências ou códigos externos, quais produtos ativos existem na loja. - [Alterar preços de produtos](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/alterar_precos&formato=md): Muda os preços de atacado, varejo e promoção de até 20 produtos por requisição, sem mexer nas variações. - [Ver por que um produto não aparece à venda](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/ocorrencias&formato=md): Lista o que impede um produto de ser vendido na loja — preço zerado, sem foto, sem estoque, inativo ou coleção indisponível. - [Mover produtos de coleção](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/alterar_colecao&formato=md): Transfere para outra coleção uma lista de produtos ou todos os produtos ativos de uma coleção. - [Agrupar produtos na SuperVitrine](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/associar_supervitrine&formato=md): Liga produtos que são o mesmo modelo em cores diferentes, cadastrados como produtos separados. - [Definir produtos do Compre Junto](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/associar_comprejunto&formato=md): Define a lista de produtos sugeridos junto com um produto (relacionados). - [Listar campos do cadastro de produto](https://api.viashopmoda.com.br/docs-api/?p=recursos/produto/campos&formato=md): Devolve os nomes dos campos do cabeçalho do produto aceitos em produto/cadastrar. - [Consultar itens de um pedido](https://api.viashopmoda.com.br/docs-api/?p=recursos/sacola/consultar&formato=md): Lista crua dos itens de um pedido (ids de produto, grade e estampa, quantidade e preço). - [Consultar sacola abandonada](https://api.viashopmoda.com.br/docs-api/?p=recursos/sacola_abandonada/consultar&formato=md): Cliente, itens com foto e valor total de uma sacola não finalizada, a partir da sessão recebida no webhook. - [Consultar status de pedido da loja](https://api.viashopmoda.com.br/docs-api/?p=recursos/status_pedido/consultar&formato=md): Lista os status de pedido da loja e o nome correspondente no ERP, quando configurado. - [Associar nomes de status do ERP](https://api.viashopmoda.com.br/docs-api/?p=recursos/status_pedido/associar&formato=md): Grava o nome que o ERP usa para cada status de pedido da loja (de/para). - [Consultar vendedores](https://api.viashopmoda.com.br/docs-api/?p=recursos/vendedores/consultar&formato=md): Lista vendedores e representantes da loja, para vincular clientes. ## Optional - [Documentação completa em um arquivo](https://api.viashopmoda.com.br/docs-api/llms-full.txt) - [OpenAPI 3.1](https://api.viashopmoda.com.br/docs-api/openapi.json)