API atual/Referência completa/Configurações da loja

Configurações do checkout

Lê as regras de compra da loja (comprador sem login, quantidades, pedido mínimo, parcelamento, PIX, termos, política de endereço) para desenhar o carrinho e o checkout.

Esta é a configuração mais importante para quem monta um carrinho ou checkout próprio. Ela diz se o visitante pode comprar sem conta, qual o pedido mínimo, quantas parcelas existem, se há desconto no PIX, se o comprador precisa aceitar termos e quais campos do endereço a loja exige. Leia uma vez ao abrir a loja e use os valores para mostrar ou esconder elementos.

GET/api/v1/storefront/settings/checkoutPública

Consulta as configurações públicas de checkout da loja

Sem parâmetros. A resposta não é guardada em cache e nunca falha com 500: se as configurações não puderem ser lidas, devolve 200 com um conjunto padrão seguro, para que a compra não trave.

Cabeçalhos

X-Tenant-IDstring

Identifica a loja quando você chama o servidor diretamente. Não é necessário no domínio da loja.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/settings/checkout"

Resposta

200Configurações do checkout

json

{
  "allow_guest_cart": true,
  "allow_guest_checkout": true,
  "allow_guest_view_price": true,
  "allow_multiple_addresses": true,
  "allow_rep_price_override": true,
  "allow_seller_chat": true,
  "allow_shopping_unlogged": true,
  "cep_consistency": "off",
  "checkout_from_cart_only": false,
  "customer_invoice_email": false,
  "enable_pix": true,
  "estimate_shipping_on_cart": true,
  "filter_catalog_by_delivery_area": true,
  "flow_type": "single_step",
  "free_installments": 3,
  "free_ship_min": 19900,
  "group_cart_by_vendor": false,
  "interest_rate": 0,
  "max_installments": 12,
  "max_qty_per_product": 0,
  "min_installment_value": 500,
  "min_order_amount": 0,
  "min_qty_per_product": 1,
  "offer_account_after_order": true,
  "offer_passkey_after_order": false,
  "one_step_checkout": true,
  "otp_required_before_checkout": false,
  "pix_discount_percent": 500,
  "prices_include_tax": false,
  "pwa_enabled": false,
  "require_address_district": false,
  "require_address_number": false,
  "tax_engine_enabled": true,
  "terms_page_slug": "",
  "terms_required": false,
  "terms_text": "",
  "unified_discount_code_field": false
}

Campos da resposta

allow_shopping_unloggedboolean

false fecha a loja para visitantes: catálogo, preços, carrinho e checkout exigem login. Quando false, os três allow_guest_* abaixo também saem false.

allow_guest_cartboolean

O visitante pode montar carrinho sem conta.

allow_guest_checkoutboolean

O visitante pode fechar pedido sem conta (informando só o e-mail). Veja Iniciar o checkout.

allow_guest_view_priceboolean

O visitante vê preços. false: mostre "Entre para ver o preço".

offer_account_after_orderboolean

Oferecer criar conta depois do pedido de um visitante.

offer_passkey_after_orderboolean

Oferecer cadastro de passkey (login biométrico) na tela de pedido confirmado.

allow_multiple_addressesboolean

Permitir endereço de cobrança diferente do de entrega.

allow_seller_chatboolean

Mostrar o chat com o seller durante a compra.

allow_rep_price_overrideboolean

Representantes comerciais podem alterar o preço de um item em vendas assistidas.

customer_invoice_emailboolean

O cliente logado pode enviar o PDF do próprio pedido por e-mail.

one_step_checkoutboolean

true: checkout em uma página só, com todas as etapas visíveis. false: etapa por etapa.

flow_typestring

Campo antigo, mantido por compatibilidade (single_step ou vazio). Use one_step_checkout.

checkout_from_cart_onlyboolean

Só abrir o checkout a partir da página do carrinho.

estimate_shipping_on_cartboolean

Mostrar estimativa de frete já no carrinho.

group_cart_by_vendorboolean

Agrupar os itens do carrinho em cartões por seller.

unified_discount_code_fieldboolean

true: um único campo aceita cupom, voucher e vale-presente. false: três campos separados.

min_qty_per_productinteger

Quantidade mínima por produto no carrinho. 0 sem mínimo.

max_qty_per_productinteger

Quantidade máxima por produto no carrinho. 0 sem máximo.

min_order_amountinteger

Pedido mínimo em centavos. 0 sem mínimo. O servidor recusa abaixo disso ao fechar o pedido.

free_ship_mininteger

Valor em centavos a partir do qual há frete grátis (o menor entre os métodos de frete ativos, ou o valor global). 0: não há limite, esconda o aviso "frete grátis acima de...".

max_installmentsinteger

Máximo de parcelas no cartão.

free_installmentsinteger

Quantas parcelas são sem juros.

min_installment_valueinteger

Valor mínimo de cada parcela, em centavos.

interest_rateinteger

Juros mensais do parcelamento acima das parcelas sem juros, em basis points (150 = 1,5% ao mês). 0 sem juros.

enable_pixboolean

A loja aceita PIX.

pix_discount_percentinteger

Desconto do PIX em basis points (500 = 5%), apesar do nome. É o desconto que o servidor realmente aplica.

prices_include_taxboolean

Os preços da vitrine já incluem impostos.

tax_engine_enabledboolean

O cálculo de impostos (ICMS, ISS, IPI...) está ligado.

terms_requiredboolean

O comprador precisa marcar o aceite dos termos para fechar o pedido.

terms_textstring

Texto curto do aceite, a exibir ao lado da caixa de seleção.

terms_page_slugstring

slug da página com os termos completos. Vazio quando não há.

require_address_numberboolean

O número do endereço é obrigatório. Veja a política de endereço em Endereço, frete e pagamento.

require_address_districtboolean

O bairro é obrigatório.

cep_consistencystring

offblock

block: o servidor recusa endereço cujo CEP não confere com UF, cidade e bairro.

filter_catalog_by_delivery_areaboolean

Esconder sellers que não entregam no endereço do comprador.

otp_required_before_checkoutboolean

O comprador precisa verificar o e-mail com um código antes de fechar o pedido (resposta 412 otp_required no fechamento).

pwa_enabledboolean

A loja usa o modo de aplicativo instalável (PWA). Quando false, o front-end deve desregistrar o service worker.

checkout_stepsarray

Lista das etapas do checkout desta loja (guest_info, address, shipping, payment, review). Só aparece quando a loja alterou o fluxo padrão, por exemplo sem a etapa review. As quatro primeiras etapas nunca saem da lista.

Erros

Status	Quando	Corpo
404	Loja não identificada	`{"error":"tenant not found","message":"could not resolve storefront from request"}`

Veja também