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

Configurações públicas da loja

Como a vitrine descobre as regras da loja (checkout, aparência, busca, filtros, linha do tempo do pedido) e o mapa das 9 rotas de configuração pública.

Cada loja da Venddor tem suas próprias regras: aceita comprador sem cadastro ou não, quantas parcelas oferece, quantos produtos mostra por página, quais filtros aparecem na lateral. O lojista define tudo isso no painel. O front-end (site, app, quiosque) lê essas escolhas por rotas públicas GET /api/v1/storefront/settings/..., sem login, e se adapta. Esta seção documenta as nove rotas.

São rotas de leitura. Para alterar uma configuração o lojista usa o painel de administração, que tem rotas próprias fora desta seção.

Pontos principais
  • Todas as rotas são públicas, GET, sem corpo e sem cache (Cache-Control: no-store). Leia no início da sessão do comprador e guarde em memória.
  • A loja é identificada pelo endereço (minhaloja.io.venddor.com.br) ou, em chamadas diretas ao servidor, pelo cabeçalho X-Tenant-ID. Sem nenhum dos dois: 404 {"error":"tenant not found"}.
  • A resposta mostra só o que é seguro para qualquer visitante: nunca chaves secretas, e-mails internos nem dados de clientes.
  • Dinheiro é inteiro em centavos. Percentuais de desconto e juros vêm em basis points (500 = 5%, apesar do nome pix_discount_percent).
  • Chaves novas podem aparecer a qualquer momento. Ignore campos que você não conhece.

Como funciona

  1. Leia o que você precisa ao abrir a loja

    Configurações do checkout e dados gerais cobrem quase toda decisão de tela: comprador sem login, moeda, parcelamento, frete grátis.

  2. Leia o resto quando a tela precisar

    Aparência, filtros e busca para listagens, e a linha do tempo do pedido na página do pedido.

  3. Revalide ao voltar do plano de fundo

    Não há aviso de mudança. Um app que fica aberto por horas deve reler as configurações de vez em quando.

Conceitos-chave

O servidor sempre decide

As configurações servem para desenhar a tela, não para garantir regras. Se a loja exige número no endereço ou pedido mínimo, o servidor recusa o pedido de qualquer forma. Use a configuração para avisar o comprador antes, e trate a recusa do servidor como a verdade final.

Visitante e "loja fechada"

allow_shopping_unlogged = false fecha a loja para visitantes: o servidor então devolve allow_guest_cart, allow_guest_checkout e allow_guest_view_price como false, mesmo que o lojista tenha deixado essas opções marcadas. Os valores devolvidos já são os efetivos.

Em caso de falha

GET /settings/checkout nunca devolve 500. Se o servidor não consegue ler as configurações, responde 200 com valores padrão seguros (comprador sem login permitido, sem mínimo de pedido, sem termos obrigatórios) para não travar a compra. As outras rotas respondem 500 normalmente.

Rotas

MétodoCaminhoPara que serveAutenticação
GET/api/v1/storefront/settings/checkoutRegras de compra, parcelamento e PIXPública
GET/api/v1/storefront/settings/generalNome, moeda, idioma e contato da lojaPública
GET/api/v1/storefront/settings/featuresQuais recursos a loja usaPública
GET/api/v1/storefront/settings/securityChave do reCAPTCHA e forma de loginPública
GET/api/v1/storefront/settings/vendorsRegras para sellers e cadastro de produtoPública
GET/api/v1/storefront/settings/appearanceGrade de produtos, imagens e formatosPública
GET/api/v1/storefront/settings/filtersFiltros da lateral das listagensPública
GET/api/v1/storefront/settings/searchComportamento da busca ao vivoPública
GET/api/v1/storefront/settings/order-timelineEtapas da linha do tempo do pedidoPública

Erros comuns

  • Chamar sem identificar a loja. Em chamada direta ao servidor (não pelo domínio da loja) falta o X-Tenant-ID: 404 tenant not found.
  • Ler pix_discount_percent como porcentagem. 500 significa 5%, não 500%. É basis points.
  • Tratar free_ship_min: 0 como "frete grátis para tudo". Zero quer dizer que não há limite configurado: esconda o aviso.
  • Confiar só na configuração para validar o endereço ou o pedido mínimo. O servidor aplica as regras de qualquer forma e responde com os códigos do checkout.
  • Guardar a resposta para sempre. O lojista pode mudar a configuração a qualquer momento.

Próximos passos

Configurações do checkout
A leitura mais importante para montar a compra.
Aparência, filtros e busca
Como desenhar as listagens.
Checkout
Onde essas regras são aplicadas.
Anterior
Voto de utilidade em avaliação
Próxima
Configurações do checkout
Nesta página
  • Como funciona
  • Conceitos-chave
  • O servidor sempre decide
  • Visitante e "loja fechada"
  • Em caso de falha
  • Rotas
  • Erros comuns
  • Próximos passos