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

Dados gerais, recursos, segurança e sellers

Lê o nome, a moeda e o contato da loja, quais recursos ela usa, a forma de login e o reCAPTCHA, e as regras públicas para sellers.

Quatro leituras curtas, todas públicas e sem parâmetros, que juntas dizem quem é a loja e o que ela oferece: general (nome, moeda, contato), features (blog, lista de desejos, promoções...), security (como o cliente entra e se há reCAPTCHA) e vendors (regras para sellers, os lojistas do marketplace). Em todas, a loja é identificada pelo domínio ou pelo cabeçalho X-Tenant-ID.

Dados gerais

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

Consulta as configurações públicas gerais da loja

Nome, moeda, idioma, contato e três opções de navegação de categorias.

Exemplo de requisição

bash

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

Resposta

200Dados gerais

json

{
  "category_include_children": false,
  "currency": "BRL",
  "hide_empty_categories": false,
  "language": "en-US",
  "logo_url": "",
  "simple_registration": false,
  "store_name": "Loja de Demonstração Venddor",
  "support_email": "contato@venddor.com.br",
  "support_phone": ""
}

Campos da resposta

store_namestring

Nome da loja.

support_emailstring

E-mail de atendimento. Pode ser vazio.

support_phonestring

Telefone de atendimento. Pode ser vazio.

currencystring

Moeda principal (ISO 4217, BRL).

languagestring

Idioma padrão da loja (pt-BR, en-US...).

logo_urlstring

Endereço do logotipo. Vazio quando a loja não enviou um.

category_include_childrenboolean

A página de uma categoria também lista os produtos das subcategorias.

hide_empty_categoriesboolean

Esconder categorias sem produtos.

simple_registrationboolean

Cadastro simplificado (menos campos) no registro do cliente.

Recursos ativos

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

Consulta quais recursos a loja ativou

Liga e desliga seções da vitrine: se a loja não usa blog, não mostre o link.

Exemplo de requisição

bash

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

Resposta

200Recursos

json

{
  "banners": true,
  "blog": false,
  "live_chat": false,
  "multi_vendor": true,
  "newsletter": false,
  "product_premoderation": true,
  "promotions": true,
  "wishlists": true
}

Campos da resposta

wishlistsboolean

Lista de desejos disponível.

promotionsboolean

A loja usa promoções.

bannersboolean

A loja usa banners.

blogboolean

A loja tem blog.

newsletterboolean

Assinatura de newsletter disponível.

live_chatboolean

Chat ao vivo disponível.

multi_vendorboolean

A loja é um marketplace com vários sellers (campo antigo; a regra atual está em allow_vendor_registration).

product_premoderationboolean

Produtos novos de sellers passam por aprovação do administrador antes de aparecer.

Segurança pública

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

Consulta as configurações públicas de segurança (reCAPTCHA e identidade de login)

Só o que o formulário de login e cadastro precisa: a chave pública do reCAPTCHA (a chave secreta nunca é exposta) e qual dado identifica o cliente no login.

Exemplo de requisição

bash

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

Resposta

200Segurança pública

json

{
  "login_identity": "email",
  "recaptcha_enabled": false,
  "recaptcha_site_key": ""
}

Campos da resposta

login_identitystring

emailphoneboth

Com qual dado o cliente entra: email, phone (telefone) ou both (cadastro pede os dois e o login aceita qualquer um). Qualquer valor desconhecido vira email.

recaptcha_enabledboolean

true quando a loja tem a chave pública e a secreta configuradas.

recaptcha_site_keystring

Chave pública do reCAPTCHA para o navegador. Vazia quando desligado.

Regras para sellers

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

Consulta as regras públicas para sellers

Regras que afetam a vitrine e os formulários de produto de sellers (lojistas).

Exemplo de requisição

bash

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

Resposta

200Regras para sellers

json

{
  "allow_vendor_registration": true,
  "display_product_vendor": true,
  "hidden_product_fields": [],
  "require_product_barcode": false,
  "unique_product_barcode": false,
  "vendors_per_page": 12
}

Campos da resposta

allow_vendor_registrationboolean

Novos sellers podem se cadastrar.

display_product_vendorboolean

Mostrar o nome do seller na página do produto.

vendors_per_pageinteger

Sellers por página na lista de lojas.

require_product_barcodeboolean

O cadastro de produto exige código de barras.

unique_product_barcodeboolean

Não pode haver dois produtos com o mesmo código de barras.

hidden_product_fieldsarray

Chaves de campos do formulário de produto que a loja escondeu. Sempre uma lista, nunca null.

Erros

Status	Quando	Corpo
404	Loja não identificada	`{"error":"tenant not found","message":"could not resolve storefront from request"}`
500	Falha ao ler a configuração	`{"error":"failed to get settings","detail":"..."}`

Veja também

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

Dados gerais, recursos, segurança e sellers

Lê o nome, a moeda e o contato da loja, quais recursos ela usa, a forma de login e o reCAPTCHA, e as regras públicas para sellers.

Dados gerais

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

Consulta as configurações públicas gerais da loja

Nome, moeda, idioma, contato e três opções de navegação de categorias.

Exemplo de requisição

bash

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

Resposta

200Dados gerais

json

{
  "category_include_children": false,
  "currency": "BRL",
  "hide_empty_categories": false,
  "language": "en-US",
  "logo_url": "",
  "simple_registration": false,
  "store_name": "Loja de Demonstração Venddor",
  "support_email": "contato@venddor.com.br",
  "support_phone": ""
}

Campos da resposta

store_namestring

Nome da loja.

support_emailstring

E-mail de atendimento. Pode ser vazio.

support_phonestring

Telefone de atendimento. Pode ser vazio.

currencystring

Moeda principal (ISO 4217, BRL).

languagestring

Idioma padrão da loja (pt-BR, en-US...).

logo_urlstring

Endereço do logotipo. Vazio quando a loja não enviou um.

category_include_childrenboolean

A página de uma categoria também lista os produtos das subcategorias.

hide_empty_categoriesboolean

Esconder categorias sem produtos.

simple_registrationboolean

Cadastro simplificado (menos campos) no registro do cliente.

Recursos ativos

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

Consulta quais recursos a loja ativou

Liga e desliga seções da vitrine: se a loja não usa blog, não mostre o link.

Exemplo de requisição

bash

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

Resposta

200Recursos

json

{
  "banners": true,
  "blog": false,
  "live_chat": false,
  "multi_vendor": true,
  "newsletter": false,
  "product_premoderation": true,
  "promotions": true,
  "wishlists": true
}

Campos da resposta

wishlistsboolean

Lista de desejos disponível.

promotionsboolean

A loja usa promoções.

bannersboolean

A loja usa banners.

blogboolean

A loja tem blog.

newsletterboolean

Assinatura de newsletter disponível.

live_chatboolean

Chat ao vivo disponível.

multi_vendorboolean

A loja é um marketplace com vários sellers (campo antigo; a regra atual está em allow_vendor_registration).

product_premoderationboolean

Produtos novos de sellers passam por aprovação do administrador antes de aparecer.

Segurança pública

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

Consulta as configurações públicas de segurança (reCAPTCHA e identidade de login)

Só o que o formulário de login e cadastro precisa: a chave pública do reCAPTCHA (a chave secreta nunca é exposta) e qual dado identifica o cliente no login.

Exemplo de requisição

bash

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

Resposta

200Segurança pública

json

{
  "login_identity": "email",
  "recaptcha_enabled": false,
  "recaptcha_site_key": ""
}

Campos da resposta

login_identitystring

emailphoneboth

Com qual dado o cliente entra: email, phone (telefone) ou both (cadastro pede os dois e o login aceita qualquer um). Qualquer valor desconhecido vira email.

recaptcha_enabledboolean

true quando a loja tem a chave pública e a secreta configuradas.

recaptcha_site_keystring

Chave pública do reCAPTCHA para o navegador. Vazia quando desligado.

Regras para sellers

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

Consulta as regras públicas para sellers

Regras que afetam a vitrine e os formulários de produto de sellers (lojistas).

Exemplo de requisição

bash

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

Resposta

200Regras para sellers

json

{
  "allow_vendor_registration": true,
  "display_product_vendor": true,
  "hidden_product_fields": [],
  "require_product_barcode": false,
  "unique_product_barcode": false,
  "vendors_per_page": 12
}

Campos da resposta

allow_vendor_registrationboolean

Novos sellers podem se cadastrar.

display_product_vendorboolean

Mostrar o nome do seller na página do produto.

vendors_per_pageinteger

Sellers por página na lista de lojas.

require_product_barcodeboolean

O cadastro de produto exige código de barras.

unique_product_barcodeboolean

Não pode haver dois produtos com o mesmo código de barras.

hidden_product_fieldsarray

Chaves de campos do formulário de produto que a loja escondeu. Sempre uma lista, nunca null.

Erros

Status	Quando	Corpo
404	Loja não identificada	`{"error":"tenant not found","message":"could not resolve storefront from request"}`
500	Falha ao ler a configuração	`{"error":"failed to get settings","detail":"..."}`