V
Venddor-IO
RecursosComo FuncionaPlanosDesenvolvedoresDocsLoginComece Gratis
Voltar para Docs

Referencia da API REST

223+ endpoints cobrindo autenticacao, catalogo, carrinho, checkout, pagamentos, frete e administracao.

Base URL: https://<loja>.io.venddor.com.brGraphQL Playground →

Categorias

Autenticacao8API publica v2 (integradores)13Produtos17Categorias6Carrinho12Checkout9Pedidos9Frete9Pagamentos10Busca4Sellers6Perfil do Usuario11Lista de Desejos5Conteudo (CMS)9Brasil8Promocoes e Cupons5Mensagens6Outros (Storefront)15Admin: Produtos11Admin: Pedidos7Admin: Categorias5Admin: Usuarios9Admin: Sellers7Admin: Configuracoes7Admin: Analytics5GraphQL2Webhooks5WebSocket1Saude e Monitoramento2

Clique em Payload em qualquer POST, PUT ou PATCH para ver os campos JSON aceitos. Dinheiro e inteiro em centavos (R$49,90 = 4990). A API vive no hostname da loja, nao em api.venddor.com.br. Integradores: /api/v2 com JWT admin ou X-API-Key. Storefront: /api/v1 com JWT ou X-Session-ID.

GETLeitura
POSTCriacao
PUTAtualizacao
PATCHParcial
DELETEExclusao

Autenticacao

Duas formas de autenticar — escolha a que combina com seu cliente.

A

Sessao de usuario (JWT)

Para acoes do usuario logado: carrinho, checkout, perfil. Faca login e use o access_token retornado.

  1. POST /api/v1/auth/login → access_token
  2. Envie em cada request:
Authorization: Bearer eyJhbGci...
B

Chave de API (apps e integracoes)

Para acesso server-to-server ao catalogo storefront. Mesma chave funciona em REST e GraphQL.

  1. Gere uma chave em /admin/api-keys (perfil admin)
  2. Envie em cada request:
X-API-Key: sfk_live_abc123...

Escopos: storefront:read, storefront:write, customer:read, customer:write

Endpoints retornam 403 missing_scope se a chave nao tem o escopo exigido.

Precisa de compatibilidade? Veja a API v1.0 Compat→