Glossário

Definições dos principais termos usados nesta documentação e nos dados da API.

Termo	Significado
Endpoint	Endereço (URL) de um recurso da API. O endpoint base é https://api.toplojas.com.br/.
Token	Credencial de acesso da loja, enviada no header Authorization: Bearer [Token].
Identificador da Loja	Código que identifica sua loja, enviado no header Loja.
x-webhook-api-key	Chave enviada no header das notificações de Webhook, usada para você validar que a notificação veio do Toplojas.
Status A / D	Situação de um registro: A (Ativado) ou D (Desativado).
CodigoImportacao	Código do produto em um sistema terceiro, usado para localizar/relacionar produtos importados.
Marketplace	Canal externo pelo qual um pedido pode ter sido feito; indicado nos detalhes e filtros de pedidos.
Variação	Combinação específica de um produto (ex.: Cor "Azul"), com seu próprio SKU, preço e estoque.
SKU	Código único de identificação de um produto ou variação (Stock Keeping Unit).
Departamento	Categoria que organiza os produtos. Pode ter um Pai (CodigoPai), formando uma hierarquia.
CodigoPai	Código do departamento "pai" de um subdepartamento. Ausente ou 0 indica um departamento raiz.
Forma de Entrega	Modalidade de envio ativa na loja (ex.: PAC, Sedex), com Codigo e Nome.
Forma de Pagamento	Meio de pagamento ativo na loja, com Codigo, Grupo, Gateway e Nome.
Gateway	Serviço que processa um pagamento (ex.: Cielo), associado a uma forma de pagamento.
Paginação	Divisão de listagens em páginas, controlada por Pagina e QtdPorPagina (máx. 100).
Webhook	Notificação automática enviada pela API quando um evento ocorre (ex.: pedido pago).
NF-e	Nota Fiscal Eletrônica; seus dados podem ser informados em um pedido.

A referência completa de cada campo de cada endpoint está no Simulador Online.