API legada/Referência completa/Vitrine /api/storefront

GETPáginas e menus

Lista as páginas de conteúdo da loja, lê uma página pelo slug e lista os menus de navegação.

Conteúdo institucional da loja: páginas (Sobre nós, Política de privacidade, Trocas e devoluções) e menus de navegação (cabeçalho, rodapé). São leituras públicas; quem edita esse conteúdo é o administrador da loja pelo painel.

Só aparecem páginas ativas e da própria loja: páginas criadas por sellers ficam de fora.

Listar páginas

GET/api/storefront/pagesPública

Listar páginas ativas

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1.

per_pageintegerpadrão: 20

Itens por página, de 1 a 100. Fora dessa faixa volta para 20.

page_typestring

Filtra pelo tipo da página (o tipo comum é page).

parent_iduuid

Somente as páginas filhas diretas desta página.

langstring

Idioma dos textos (pt-BR, en, es). Também vale Accept-Language.

Ler uma página

GET/api/storefront/pages/{slug}Pública

Ler uma página pelo slug

Devolve a página com o corpo em HTML. Para a política de privacidade, se a loja não escreveu a própria, a plataforma devolve o texto padrão preenchido com os dados da loja.

Parâmetros de caminho

slugstringobrigatório

Slug da página (sobre-nos).

Parâmetros de consulta

langstring

Idioma dos textos.

Listar menus

GET/api/storefront/menusPública

Listar os menus de navegação

Devolve os menus configurados (cada um com seu location, como footer_about). A resposta traz o menu, não os links: para os itens use a API de layout da vitrine.

Cabeçalhos

Authorizationstring

Opcional. Bearer vat_... com o escopo read_content, ou chave sfk_... com storefront:read.

Exemplo de requisição

bash

curl "$BASE_URL/api/storefront/pages?per_page=10"
curl "$BASE_URL/api/storefront/pages/sobre-nos"
curl "$BASE_URL/api/storefront/menus"

Resposta

200Página (lista tem o mesmo objeto dentro de pages)

json

{
  "id": "751d5a75-1165-4953-bd6c-09f9517ebc7a",
  "title": "Sobre Nós",
  "slug": "sobre-nos",
  "body": "<p><strong>Quem somos.</strong> Na nossa loja acreditamos que comprar online deve ser simples.</p>",
  "page_type": "page",
  "created_at": "2026-04-07T02:45:34.139094Z",
  "updated_at": "2026-06-18T20:15:07.543128Z"
}

200Lista de páginas

json

{ "pages": [ { "id": "751d5a75-1165-4953-bd6c-09f9517ebc7a", "title": "Sobre Nós", "slug": "sobre-nos", "page_type": "page" } ], "total": 21, "page": 1, "per_page": 1, "total_pages": 21 }

200Menus

json

{
  "menus": [
    {
      "id": "b4d75fb9-9e16-4efa-b15d-5b5547af37fb",
      "name": "Sobre Nós - Desktop",
      "location": "footer_about",
      "status": "A",
      "created_at": "2026-04-07T02:45:34.139094Z",
      "updated_at": "2026-06-18T20:15:07.543128Z",
      "is_served": true
    }
  ]
}

Campos da resposta

iduuid

Id da página ou do menu.

titlestring

Título da página. page_title repete o valor.

slugstring

Slug da página, usado na URL e na leitura. seo_name repete o valor.

bodystring

Corpo da página em HTML. Sanitize antes de injetar em outro site.

page_typestring

Tipo da página (page).

descriptionstring

Repete o body (HTML), por compatibilidade com a 1.0.

pages, total, page, per_page, total_pagesmixed

Envelope da lista de páginas. Cada item de pages tem os campos da página.

menus[].namestring

Nome do menu.

menus[].locationstring

Onde o menu aparece (footer_about, footer_contact...).

menus[].is_servedboolean

true se a vitrine usa este menu como o ativo para o location. Menus com false existem no cadastro mas não são exibidos.

Erros

Status	Quando	Corpo
403	Chave `sfk_` sem `storefront:read`, ou token `vat_` sem `read_content`, no `menus`	`{"error": "missing_scope", "required": "..."}`
404	Página inexistente ou inativa	`{"error": "page not found"}`
500	Falha ao ler	`{"error": "failed to list pages", ...}`

Veja também

GETPáginas e menus

Lista as páginas de conteúdo da loja, lê uma página pelo slug e lista os menus de navegação.

Só aparecem páginas ativas e da própria loja: páginas criadas por sellers ficam de fora.

Listar páginas

GET/api/storefront/pagesPública

Listar páginas ativas

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1.

per_pageintegerpadrão: 20

Itens por página, de 1 a 100. Fora dessa faixa volta para 20.

page_typestring

Filtra pelo tipo da página (o tipo comum é page).

parent_iduuid

Somente as páginas filhas diretas desta página.

langstring

Idioma dos textos (pt-BR, en, es). Também vale Accept-Language.

Ler uma página

GET/api/storefront/pages/{slug}Pública

Ler uma página pelo slug

Devolve a página com o corpo em HTML. Para a política de privacidade, se a loja não escreveu a própria, a plataforma devolve o texto padrão preenchido com os dados da loja.

Parâmetros de caminho

slugstringobrigatório

Slug da página (sobre-nos).

Parâmetros de consulta

langstring

Idioma dos textos.

Listar menus

GET/api/storefront/menusPública

Listar os menus de navegação

Devolve os menus configurados (cada um com seu location, como footer_about). A resposta traz o menu, não os links: para os itens use a API de layout da vitrine.

Cabeçalhos

Authorizationstring

Opcional. Bearer vat_... com o escopo read_content, ou chave sfk_... com storefront:read.

Exemplo de requisição

bash

curl "$BASE_URL/api/storefront/pages?per_page=10"
curl "$BASE_URL/api/storefront/pages/sobre-nos"
curl "$BASE_URL/api/storefront/menus"

Resposta

200Página (lista tem o mesmo objeto dentro de pages)

json

{
  "id": "751d5a75-1165-4953-bd6c-09f9517ebc7a",
  "title": "Sobre Nós",
  "slug": "sobre-nos",
  "body": "<p><strong>Quem somos.</strong> Na nossa loja acreditamos que comprar online deve ser simples.</p>",
  "page_type": "page",
  "created_at": "2026-04-07T02:45:34.139094Z",
  "updated_at": "2026-06-18T20:15:07.543128Z"
}

200Lista de páginas

json

{ "pages": [ { "id": "751d5a75-1165-4953-bd6c-09f9517ebc7a", "title": "Sobre Nós", "slug": "sobre-nos", "page_type": "page" } ], "total": 21, "page": 1, "per_page": 1, "total_pages": 21 }

200Menus

json

{
  "menus": [
    {
      "id": "b4d75fb9-9e16-4efa-b15d-5b5547af37fb",
      "name": "Sobre Nós - Desktop",
      "location": "footer_about",
      "status": "A",
      "created_at": "2026-04-07T02:45:34.139094Z",
      "updated_at": "2026-06-18T20:15:07.543128Z",
      "is_served": true
    }
  ]
}

Campos da resposta

iduuid

Id da página ou do menu.

titlestring

Título da página. page_title repete o valor.

slugstring

Slug da página, usado na URL e na leitura. seo_name repete o valor.

bodystring

Corpo da página em HTML. Sanitize antes de injetar em outro site.

page_typestring

Tipo da página (page).

descriptionstring

Repete o body (HTML), por compatibilidade com a 1.0.

pages, total, page, per_page, total_pagesmixed

Envelope da lista de páginas. Cada item de pages tem os campos da página.

menus[].namestring

Nome do menu.

menus[].locationstring

Onde o menu aparece (footer_about, footer_contact...).

menus[].is_servedboolean

true se a vitrine usa este menu como o ativo para o location. Menus com false existem no cadastro mas não são exibidos.

Erros

Status	Quando	Corpo
403	Chave `sfk_` sem `storefront:read`, ou token `vat_` sem `read_content`, no `menus`	`{"error": "missing_scope", "required": "..."}`
404	Página inexistente ou inativa	`{"error": "page not found"}`
500	Falha ao ler	`{"error": "failed to list pages", ...}`