Referência completa
Todas as rotas da API da Venddor, agrupadas por tema, com a explicação dos conceitos que valem para todas.
A referência completa documenta todas as rotas integráveis da API da Venddor, uma operação por vez, com parâmetros, exemplos de requisição em cURL, JavaScript e Python, respostas reais e a lista de erros. Ela complementa o Guia rápido, que cobre só produtos, clientes, pedidos, categorias, características e embalagens.
Se esta é a sua primeira visita, comece pelos Conceitos: lojas, tokens, erros, paginação, dinheiro e datas valem para todas as rotas e são explicados uma vez só.
As três superfícies da API
| Superfície | Prefixo | Quem chama | Quando escolher |
|---|---|---|---|
| Administrador | /api/v1/admin/... | ERP, BI e automações da equipe da loja | Gerenciar catálogo, pedidos, clientes, promoções, frete, pagamentos e configurações. |
| Seller (lojista) | /api/v1/vendor/... | Sistemas de um vendedor do marketplace | Um seller sincronizando os próprios produtos, estoque, pedidos e equipe. |
| Cliente (vitrine) | /api/v1/storefront/..., /api/v1/auth/... | Site, app ou checkout próprio | Montar a experiência de compra: catálogo, carrinho, checkout, conta do cliente. |
Como escolher
- Quem é a pessoa por trás da chamada? Equipe da loja: administrador. Vendedor do marketplace: seller. Comprador: cliente.
- Precisa de acesso sem usuário? Um app de terceiros pode usar um token de app com escopos nas rotas que o aceitam (Tokens e escopos).
A página Atores e APIs detalha cada superfície, os privilégios do administrador e do seller, e o comportamento do cliente visitante.
Como a barra lateral está organizada
A barra lateral da referência completa é agrupada por tema. Dentro de cada tema ficam as seções das três superfícies que tratam do assunto, para você achar o que quer sem saber de antemão quem chama.
| Tema | O que contém |
|---|---|
| Início | Conceitos compartilhados e a autenticação de todas as superfícies: login, cadastro, renovação, 2FA, sessões, conta do administrador e do seller, webhooks, saúde, GraphQL. |
| Catálogo | Produtos, variações, categorias do seller, importação e exportação, qualidade, busca, kits, selos e página do produto. |
| Pedidos | Carrinho, checkout, pedidos do cliente e do seller, devoluções, carrinhos abandonados e venda de balcão. |
| Clientes | Conta do cliente, cadastro e verificação, sellers e seus planos, representantes comerciais e moderação. |
| Pagamentos | Formas de pagamento, gateways, cotações B2B, assinaturas, carteiras, vouchers, comissões e repasses. |
| Frete e entrega | Métodos de envio, transportadoras, áreas de tarifa, entrega agendada, expedição e monitoramento. |
| Fiscal | NF-e e NFC-e, impostos, regras de imposto e exportação contábil. |
| Promoções e preços | Promoções, cupons, orçamentos, regras de preço e de vitrine, preço e estoque na vitrine. |
| Design da loja | Temas, layouts, editor visual, menus, páginas, idiomas e configurações da loja. |
| Marketing | Banners, blog, newsletter, CRM, avaliações, lives de vendas e mensagens. |
| Conexão, caixa de entrada, campanhas, fluxos do bot, catálogo e a mini-loja. | |
| Inteligência artificial | Venddor Intelligence, predições, alertas e preenchimento de produto com IA. |
| Análises | Dashboards, relatórios, indicadores e registro de atividades. |
| ERP e integrações | Módulos de ERP do seller (estoque, compras, finanças, PDV, armazém), canais de venda e hubs de marketplaces. |
| Operação | Módulos, backups, scripts, central de pendências e fluxos operacionais. |
Dentro de cada tema, uma seção é uma área funcional. A página inicial da seção explica o conceito, o fluxo típico de integração e o mapa de todas as rotas; cada página seguinte documenta uma operação.
Quem chama o quê
Cada seção traz no nome o prefixo da superfície que a usa, e as rotas daquela seção seguem o prefixo correspondente.
| Prefixo da seção | Superfície | Exemplo |
|---|---|---|
admin-... | Administrador (/api/v1/admin/...) | Métodos de envio, Promoções e cupons |
vendor-... | Seller (/api/v1/vendor/...) | Produtos do seller, Pedidos do seller |
storefront-... | Cliente (/api/v1/storefront/...) | Carrinho, Checkout |
fundamentals-... | Todas | Autenticação, Webhooks e eventos |
O que tem em cada página de rota
- Uma explicação em linguagem simples do que a operação faz, quando usar e os efeitos colaterais.
- O quadro da rota, com método, caminho, tipo de autenticação e todos os parâmetros (tipo, obrigatório, padrão, valores aceitos).
- Um campo de teste (Try it) que usa o seu token.
- Exemplos completos em cURL, JavaScript e Python.
- Respostas reais e a descrição de cada campo.
- A tabela de erros com os status e as mensagens que o servidor devolve.
- Avisos sobre armadilhas e links para as páginas relacionadas.
Nos exemplos, $BASE_URL é o endereço da sua loja (como https://minhaloja.io.venddor.com.br) e $TOKEN é o token de acesso.