VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Configurações da loja

Onde ficam as preferências da loja e como ler e gravar cada uma: configurações por seção, busca, menus do painel e traduções.

Quase todo comportamento configurável de uma loja Venddor vive em configurações: nome e moeda, regras de checkout, formas de pagamento, e-mail de envio, entrada social, seller, filtros da vitrine. Esta seção documenta a rota central (/settings, organizada em seções) e três rotas especializadas: a busca da vitrine, os menus escondidos do painel e o dicionário de traduções em inglês.

Pontos-chave
  • GET /settings devolve tudo de uma vez; PUT /settings grava uma seção por vez, com {"section": "...", "data": {...}}.
  • A gravação mescla: só as chaves que você manda mudam. null nunca apaga um valor existente.
  • O GET /settings devolve também segredos em texto aberto (senha de SMTP, tokens). Limite quem tem o privilégio manage_settings e nunca registre essas respostas.
  • A busca da vitrine (/search-settings), ao contrário, substitui tudo: envie sempre o objeto completo.
  • Esconder um menu do painel não é permissão: a rota e o privilégio continuam funcionando.

Como funciona

Seções de /settings

SeçãoO que controla
generalNome, e-mails de contato, moeda, idioma, fuso, logo, cores do painel.
featuresLiga e desliga recursos da loja (lista de desejos, blog, banners, moderação de produtos...).
checkoutRegras do carrinho e do checkout: visitante, pedido mínimo, termos, cancelamento pelo cliente, endereço.
paymentMeios de pagamento ativos, parcelamento, desconto no PIX.
shippingForma de envio padrão, limite de frete grátis.
notificationE-mails de aviso, departamentos e o servidor SMTP.
storefront_filtersFiltros da barra lateral da vitrine.
searchBusca da vitrine (veja Busca da vitrine). Não aparece no GET.
securityreCAPTCHA, entrada com Google e Facebook, verificação de e-mail, identidade de login.
appearancePreferências de exibição (documentadas em outra seção).
vendorsRegras de seller (cadastro, KYC, prazo de repasse, campos escondidos).
focusnfeIntegração fiscal (NF-e).
order_timelineEtapas da linha do tempo do pedido.
social_proof, price_transparency, product_qa, pdp_media, fbt, review_rewardsRecursos da página do produto. São lidos e gravados também por Conversão da página do produto e não aparecem no GET /settings.

Conceitos-chave

Dinheiro e porcentagens

Valores em dinheiro são centavos inteiros. Porcentagens de juros e de desconto no PIX são em pontos-base (500 é 5%, 150 é 1,5%).

Endpoints

Método e caminhoPara que serveAutenticaçãoPágina
GET /api/v1/admin/settingsLê todas as seçõesadministradorConfigurações
PUT /api/v1/admin/settingsGrava uma seçãoadministradorConfigurações
GET /api/v1/admin/search-settingsLê a busca da vitrineadministradorBusca da vitrine
PUT /api/v1/admin/search-settingsGrava a buscaadministradorBusca da vitrine
GET /api/v1/admin/panel-menusLê os menus escondidosadministradorMenus do painel
PUT /api/v1/admin/panel-menusSubstitui os menus escondidosadministradorMenus do painel
GET /api/v1/admin/translations/bundled-enDicionário em inglêsadministradorTraduções

Erros comuns

  • Mandar os campos no primeiro nível do corpo. O corpo é {"section","data"}; sem isso, 400 section is required.
  • Inventar uma seção. 400 com a lista de seções aceitas.
  • Usar PUT /search-settings parcial. Os campos omitidos viram false ou 0.
  • Tratar GET /settings como seguro para log. Ele traz segredos.
  • Achar que esconder menu impede o acesso. Só esconde; o acesso é decidido por privilégio.

Próximos passos

Configurações
Ler e gravar por seção.
Busca da vitrine
Ajustar a busca instantânea.
Menus do painel
Simplificar o painel por perfil.
Anterior
Preferências de exibição
Próxima
Configurações por seção
Nesta página
  • Como funciona
  • Seções de /settings
  • Conceitos-chave
  • Dinheiro e porcentagens
  • Endpoints
  • Erros comuns
  • Próximos passos