Glossário

Os termos da plataforma Venddor usados na documentação: loja, tenant, seller, sub-pedido, SKU, status em letra, token 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.

Plataforma e lojas

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 `vendor_id` ou `company_id`.
Painel (admin)	A área administrativa da loja, em `/admin`. A API administrativa faz o que o painel faz.
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 (por exemplo, rastreio de envios). Uma rota de um módulo desligado responde como inexistente.

Catálogo

Termo	Significado
Produto	O item à venda, com nome, preço, estoque e imagens.
SKU	Código interno do produto ou da variação (`SD-002373`), definido pela loja. É para você; a chave é o UUID.
Variação	Uma versão de um produto (cor, tamanho) com SKU, 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	Quantidade disponível. Um pedido criado pela API baixa o estoque; cancelar devolve.

Clientes e contas

Termo	Significado
Usuário	Qualquer conta da loja. O `user_type` diz o tipo: `customer` (comprador), `vendor` (seller) ou `admin` (administrador).
Cliente (comprador)	Usuário do tipo `customer`. É quem faz pedidos.
Administrador	Usuário que opera a loja. É o único que autentica nas rotas `/api/v1/admin/...`.
CPF e CNPJ	Documentos de pessoa física e jurídica. O cliente pode ser PF (`person_type` `F`) ou PJ (`J`).
Convidado (guest)	Comprador sem conta. O pedido guarda só o e-mail e o nome.

Pedidos

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 `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). Veja Sub-pedidos.
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 (Status de pedido).

Código	Letra	Significado
`pending`	`O`	Pendente: aguarda pagamento ou confirmação.
`processing`	`P`	Processando.
`paid`	`A`	Pago.
`on_hold`	`H`	Em espera.
`failed`	`F`	Falho.
`shipped`	`S`	Enviado.
`delivered`	`C`	Entregue.
`completed`	`K`	Concluído.
`cancelled`	`I`	Cancelado.
`refunded`	`R`	Reembolsado.
`chargeback`	`Z`	Contestado no cartão.

Acesso

Termo	Significado
JWT	Token assinado que prova quem você é. O `access_token` do login é um JWT.
`access_token`	O JWT de curta duração, enviado em `Authorization: Bearer`.
`refresh_token`	O token de longa duração e uso único que troca por um `access_token` novo.
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`.
Chave da vitrine	Chave `sfk_...` para a API pública da vitrine.
Idempotência	Propriedade de uma chamada que, repetida, não cria nada a mais. Veja Limites e boas práticas.
Webhook	Um aviso que a plataforma envia ao seu sistema quando algo acontece (um pedido pago, um envio).

Formatos

Termo	Significado
Centavos	A unidade do dinheiro: `4990` é R$ 49,90.
RFC 3339	O formato de data: `2026-10-11T20:50:36Z`.
UUID	O formato dos ids: `c3f92551-9dda-4fc7-b518-353d1c4e4035`.

Veja também

Convenções

Formatos em detalhe.

Pedidos

Os conceitos de pedido, a fundo.

Perguntas frequentes

Dúvidas da primeira integração.

API atual/Guia rápido/Primeiros passos

Glossário

Os termos da plataforma Venddor usados na documentação: loja, tenant, seller, sub-pedido, SKU, status em letra, token e outros.

Plataforma e lojas

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 `vendor_id` ou `company_id`.
Painel (admin)	A área administrativa da loja, em `/admin`. A API administrativa faz o que o painel faz.
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 (por exemplo, rastreio de envios). Uma rota de um módulo desligado responde como inexistente.

Catálogo

Termo	Significado
Produto	O item à venda, com nome, preço, estoque e imagens.
SKU	Código interno do produto ou da variação (`SD-002373`), definido pela loja. É para você; a chave é o UUID.
Variação	Uma versão de um produto (cor, tamanho) com SKU, 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	Quantidade disponível. Um pedido criado pela API baixa o estoque; cancelar devolve.

Clientes e contas

Termo	Significado
Usuário	Qualquer conta da loja. O `user_type` diz o tipo: `customer` (comprador), `vendor` (seller) ou `admin` (administrador).
Cliente (comprador)	Usuário do tipo `customer`. É quem faz pedidos.
Administrador	Usuário que opera a loja. É o único que autentica nas rotas `/api/v1/admin/...`.
CPF e CNPJ	Documentos de pessoa física e jurídica. O cliente pode ser PF (`person_type` `F`) ou PJ (`J`).
Convidado (guest)	Comprador sem conta. O pedido guarda só o e-mail e o nome.

Pedidos

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 `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). Veja Sub-pedidos.
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 (Status de pedido).

Código	Letra	Significado
`pending`	`O`	Pendente: aguarda pagamento ou confirmação.
`processing`	`P`	Processando.
`paid`	`A`	Pago.
`on_hold`	`H`	Em espera.
`failed`	`F`	Falho.
`shipped`	`S`	Enviado.
`delivered`	`C`	Entregue.
`completed`	`K`	Concluído.
`cancelled`	`I`	Cancelado.
`refunded`	`R`	Reembolsado.
`chargeback`	`Z`	Contestado no cartão.

Acesso

Termo	Significado
JWT	Token assinado que prova quem você é. O `access_token` do login é um JWT.
`access_token`	O JWT de curta duração, enviado em `Authorization: Bearer`.
`refresh_token`	O token de longa duração e uso único que troca por um `access_token` novo.
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`.
Chave da vitrine	Chave `sfk_...` para a API pública da vitrine.
Idempotência	Propriedade de uma chamada que, repetida, não cria nada a mais. Veja Limites e boas práticas.
Webhook	Um aviso que a plataforma envia ao seu sistema quando algo acontece (um pedido pago, um envio).

Formatos

Termo	Significado
Centavos	A unidade do dinheiro: `4990` é R$ 49,90.
RFC 3339	O formato de data: `2026-10-11T20:50:36Z`.
UUID	O formato dos ids: `c3f92551-9dda-4fc7-b518-353d1c4e4035`.

Veja também

Convenções

Formatos em detalhe.

Pedidos

Os conceitos de pedido, a fundo.

Perguntas frequentes

Dúvidas da primeira integração.