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.
Como funciona
- 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.
- 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.
- 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étodo | Caminho | Para que serve | Autenticação |
|---|---|---|---|
| GET | /api/v1/storefront/settings/checkout | Regras de compra, parcelamento e PIX | Pública |
| GET | /api/v1/storefront/settings/general | Nome, moeda, idioma e contato da loja | Pública |
| GET | /api/v1/storefront/settings/features | Quais recursos a loja usa | Pública |
| GET | /api/v1/storefront/settings/security | Chave do reCAPTCHA e forma de login | Pública |
| GET | /api/v1/storefront/settings/vendors | Regras para sellers e cadastro de produto | Pública |
| GET | /api/v1/storefront/settings/appearance | Grade de produtos, imagens e formatos | Pública |
| GET | /api/v1/storefront/settings/filters | Filtros da lateral das listagens | Pública |
| GET | /api/v1/storefront/settings/search | Comportamento da busca ao vivo | Pública |
| GET | /api/v1/storefront/settings/order-timeline | Etapas da linha do tempo do pedido | Pú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_percentcomo porcentagem.500significa 5%, não 500%. É basis points. - Tratar
free_ship_min: 0como "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.