Glossário Os termos da plataforma Venddor usados na documentação da API legada: loja, tenant, seller, sub-pedido, SKU, status em letra, chave de API e outros.
A API usa vocabulário de e-commerce brasileiro e alguns termos próprios da Venddor. Esta página define cada um em uma frase e aponta para onde ele aparece. Os nomes em inglês são os que aparecem nos campos JSON.
Pontos-chave
Loja e tenant são a mesma coisa vista por lados diferentes: o negócio e a instalação técnica.Seller (lojista) é uma empresa que vende dentro de uma loja; uma compra com vários sellers vira pedido pai e sub-pedidos .O status de vários registros é uma letra que não é a inicial do nome.
O dinheiro é uma string decimal ("49.90") e as datas são Unix timestamp .
Termo Significado Loja (storefront) O site de vendas de um negócio, com catálogo, clientes e pedidos próprios. Tenant A loja do ponto de vista da plataforma: uma instalação isolada, com banco de dados próprio. Quase sempre é sinônimo de loja. Slug O identificador curto da loja, como minhaloja. Aparece no endereço (minhaloja.io.venddor.com.br) e vale no cabeçalho X-Tenant-ID. Seller (lojista, vendor) Empresa que vende dentro de uma loja que funciona como marketplace. Nos campos JSON aparece como company_id. Painel (admin) A área administrativa da loja, em /admin. É onde se gera a chave de API. Vitrine A parte pública da loja, que o comprador navega: catálogo, carrinho, checkout. Módulo Uma função opcional que a loja liga ou desliga. Uma rota de um módulo desligado responde como inexistente. API legada O contrato da Venddor 1.0, mantido em /api/v1.0/... e /api/... para integrações existentes.
Termo Significado Produto O item à venda, com nome, preço, estoque e imagens. Nos campos: product_id, product. SKU (product_code) Código interno do produto (SD-002373), definido pela loja. É para você; a chave é o product_id. Variação Uma versão de um produto (cor, tamanho) com código, preço e estoque próprios. Categoria Um nó da árvore do catálogo. Tem status em letra (A, D, H, T). Característica (feature) Um atributo do produto, como marca, cor ou material, usado em filtros e fichas. Caixa (embalagem) O volume em que o produto é despachado. Alimenta o cálculo de frete e a separação. Estoque (amount) Quantidade disponível. Um pedido criado pela API baixa o estoque; cancelar devolve.
Termo Significado Usuário Qualquer conta da loja. O user_type diz o tipo: C (comprador), V (usuário de seller) ou A (administrador). Cliente (comprador) Usuário do tipo C. É quem faz pedidos. Administrador Usuário que opera a loja. É o único que autentica nas rotas administrativas. CPF e CNPJ Documentos de pessoa física e jurídica. O cliente pode ser PF ou PJ. Convidado (guest) Comprador sem conta. O pedido guarda só o e-mail e o nome.
Termo Significado Pedido O registro de uma compra: quem, o quê, quanto, como paga, para onde vai. Número do pedido (order_number) O código legível do pedido (PEDIDO-20261011-0007). Não é a chave; use o order_id. Pedido pai e sub-pedido Quando uma compra tem itens de mais de um seller, a plataforma cria um pedido pai (o que o comprador vê) e um sub-pedido por seller (o que cada seller cumpre). Status em letra O estado do pedido como uma letra. A letra não é a inicial do nome. Remessa (shipment) O envio de um pedido, com transportadora e código de rastreio. Rastreio O acompanhamento da remessa na transportadora. Nota fiscal O documento fiscal do pedido (NF-e), registrado no pedido ou emitido pela loja. Reembolso A devolução do dinheiro ao comprador.
Os status de pedido na instalação padrão. Cada loja pode renomear, esconder e criar status , então leia o cadastro da loja (Pedidos ).
Código Letra Significado pendingOPendente: aguarda pagamento ou confirmação. processingPProcessando. paidAPago. on_holdHEm espera. failedFFalho. shippedSEnviado. deliveredCEntregue. completedKConcluído. cancelledICancelado. refundedRReembolsado. chargebackZContestado no cartão.
Termo Significado Chave de API Senha de integração do usuário, usada com HTTP Basic. Gerada no painel, mostrada uma única vez. HTTP Basic O esquema de autenticação do cabeçalho Authorization: Basic base64(e-mail:chave). Token (auth_tokens) O JWT que a rota POST /api/v1.0/auth_tokens devolve, com validade em segundos (ttl). Token de app Token vat_... de um aplicativo de terceiros, limitado por escopos. Escopo Uma permissão de um token de app, como read_orders. Privilégio Uma permissão de um usuário do painel, como manage_orders. Idempotência Propriedade de uma chamada que, repetida, não cria nada a mais. A API legada não a oferece nas criações. Veja Limites e boas práticas .
Termo Significado String decimal O dinheiro: "49.90". Unix timestamp O formato de data: segundos desde 1970, como 1791751836. UUID O formato dos ids em /api/v1.0: c3f92551-9dda-4fc7-b518-353d1c4e4035. Id decimal O formato dos ids na rota /api/... (sem v1.0): texto numérico, como "4521". legacy_idO id que um registro tinha na plataforma antiga, quando a loja foi migrada.
Limites e boas práticas
Perguntas frequentes
