Referência completa
Todas as rotas da API legada da Venddor, agrupadas por tema, com a explicação de quem chama cada uma.
A referência completa da API legada documenta as rotas de compatibilidade com a Venddor 1.0: as que os aplicativos, os terminais de balcão, os ERPs e os conectores antigos chamam, uma operação por vez, com parâmetros, exemplos de requisição, 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, passe antes pelos Primeiros passos: chave de API, formato de resposta, paginação, erros e ids valem para todas as rotas e são explicados uma vez só.
Quem chama o quê
| Quem chama | Onde fica | Para que serve |
|---|---|---|
| Aplicativo do cliente | API 4.0 (app móvel) | Catálogo, home, sellers, avaliações, meios de pagamento e cancelamento de pedido no aplicativo móvel da loja. |
| App do seller | App do seller (1.0) e Catálogo do app do vendedor | O aplicativo do lojista: painel, chats, produtos e pedidos da própria empresa. |
| PDV e terminal de balcão | PDV e terminal de balcão | Login do caixa, carga de produtos e clientes e fechamento da venda de balcão. |
| ERP e integrações | Integração ERP (1.0) e API v2 | Sincronização incremental, códigos de pagamento por cliente, crédito, cupons, devoluções e webhooks. |
| Rotas sem prefixo de versão | Pedidos: rotas sem versão e Vitrine /api/storefront | As rotas /api/... sem v1.0, chamadas por conectores antigos, com ids decimais. |
| Aplicativos de terceiros | API de apps (token vat_) | Relatórios, banners, páginas e estoque em massa, com token de app e escopos. |
Como a barra lateral está organizada
A barra lateral da referência completa é agrupada por tema. Dentro de cada tema ficam as seções que tratam do assunto.
| Tema | O que contém |
|---|---|
| Catálogo | O catálogo visto pelo app do vendedor: listar, consultar e manter os produtos do seller. |
| Pedidos | O terminal de balcão (PDV) e os pedidos nas rotas sem versão e no app do seller. |
| Clientes | Parceiros e clientes B2B, representantes, registros da loja, lojas e sellers (companies) e assinantes da newsletter. |
| Frete | As rotas de frete e de áreas de entrega. |
| Aplicativos | O app do seller, a API 4.0 do app móvel, a integração com ERP, a equipe de campo, a API v2 e a API de apps com token. |
| Design | Os blocos de layout, os idiomas e a vitrine sem prefixo de versão. |
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.
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).
- Exemplos completos de requisição.
- 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), $EMAIL é o e-mail do usuário de integração e $API_KEY é a chave de API dele.