API legada/Referência completa/API 4.0 (app móvel)

Páginas do app

Devolve as páginas montadas para o app (promoções, coleções, institucional), cada uma com suas seções já preenchidas.

Uma página do app é uma tela que a loja monta no painel sem precisar publicar uma nova versão do aplicativo: uma coleção de inverno, uma página de promoção, um guia de compra. Cada página tem seções (carrossel de banners, lista de produtos, lista de categorias, texto) e a plataforma preenche os itens das seções de produtos, categorias e banners com os dados atuais.

Estas rotas são anônimas e só funcionam quando a loja liga o recurso de páginas do app. Com o recurso desligado, a resposta é 403 {"error":"module_disabled","module":"mobile-pages"}.

GET/api/4.0/sra_mobile_pagesPública

Listar páginas do app

Devolve as páginas ativas, da primeira para a última (position). Por padrão sem as seções, para a lista ser leve.

Parâmetros de consulta

homeboolean

1true

Só as páginas marcadas para aparecer na home (show_in_home). Já inclui as seções.

with_sectionsboolean

1

Inclui as seções de cada página.

slugstring

Devolve só a página com este slug (no lugar da lista).

channelstring

sitevenddor_appclient_app

Canal, para escolher os banners das seções de carrossel. Sem ele, só entram banners sem restrição de canal.

devicestringpadrão: mobile

mobiletabletdesktop

Dispositivo, para os banners.

GET/api/4.0/sra_mobile_pages/{id}Pública

Ler uma página do app

Devolve uma página com as seções. Mesmo formato da lista: a página vem dentro de pages, num vetor de um item.

Parâmetros de caminho

idstringobrigatório

Slug da página (só páginas ativas) ou UUID.

Parâmetros de consulta

channelstring

sitevenddor_appclient_app

Canal dos banners.

devicestringpadrão: mobile

mobiletabletdesktop

Dispositivo dos banners.

Exemplo de requisição

bash

curl "$BASE_URL/api/4.0/sra_mobile_pages/colecao-de-inverno?channel=venddor_app&device=mobile"

Resposta

200Página do app

json

{
  "pages": [
    {
      "id": "0c9d6a7e-5d6e-4b0a-9d2c-2f4f9f3b7c11",
      "page_id": "0c9d6a7e-5d6e-4b0a-9d2c-2f4f9f3b7c11",
      "slug": "colecao-de-inverno",
      "status": "A",
      "position": 1,
      "show_in_home": true,
      "storefront_id": "",
      "title": "Coleção de inverno",
      "description": "Casacos, cachecóis e mais.",
      "sections": [
        {
          "id": "5f2d1e1c-8c8f-4c1b-a1f5-0b0f3a9d7e22",
          "section_id": "5f2d1e1c-8c8f-4c1b-a1f5-0b0f3a9d7e22",
          "type": "product_list",
          "position": 0,
          "status": "A",
          "settings": {},
          "content": { "title": "Mais vendidos", "items": [ { "product_id": "1585658495", "product": "Caneca Esmaltada 350ml", "price": 52.9 } ] }
        }
      ]
    }
  ]
}

Campos da resposta

pages[].idstring

Id (UUID) da página. page_id repete o mesmo valor.

pages[].slugstring

Identificador curto da página, usado no caminho.

pages[].statusstring

A quando ativa.

pages[].positioninteger

Ordem entre as páginas.

pages[].show_in_homeboolean

Se a página deve aparecer na home do app.

pages[].storefront_idstring

Vitrine a que a página pertence. Pode ser vazio.

pages[].titlestring

Título.

pages[].descriptionstring

Descrição.

pages[].sectionsarray

Seções ativas, em ordem. Vazio na lista simples.

pages[].sections[].idstring

Id (UUID) da seção. section_id repete o mesmo valor.

pages[].sections[].typestring

Tipo da seção. product_list, category_list e banner_carousel têm content.items preenchido pela plataforma. Os demais tipos devolvem o content como foi salvo.

pages[].sections[].positioninteger

Ordem da seção.

pages[].sections[].settingsobject

Reservado. Sempre {}.

pages[].sections[].contentobject

Configuração da seção e, nos três tipos acima, items com os cartões de produto, categorias ou banners atuais.

Erros

Status	Quando	Corpo
403	Recurso de páginas do app desligado na loja	`{"error":"module_disabled","module":"mobile-pages"}`
404	Página inexistente (ou slug de página inativa)	`{"error":"mobile page not found"}`
500	Falha ao ler	`{"error":"failed to load mobile page","detail":"..."}`

Veja também

Páginas do app

Devolve as páginas montadas para o app (promoções, coleções, institucional), cada uma com suas seções já preenchidas.

Estas rotas são anônimas e só funcionam quando a loja liga o recurso de páginas do app. Com o recurso desligado, a resposta é 403 {"error":"module_disabled","module":"mobile-pages"}.

GET/api/4.0/sra_mobile_pagesPública

Listar páginas do app

Devolve as páginas ativas, da primeira para a última (position). Por padrão sem as seções, para a lista ser leve.

Parâmetros de consulta

homeboolean

1true

Só as páginas marcadas para aparecer na home (show_in_home). Já inclui as seções.

with_sectionsboolean

1

Inclui as seções de cada página.

slugstring

Devolve só a página com este slug (no lugar da lista).

channelstring

sitevenddor_appclient_app

Canal, para escolher os banners das seções de carrossel. Sem ele, só entram banners sem restrição de canal.

devicestringpadrão: mobile

mobiletabletdesktop

Dispositivo, para os banners.

GET/api/4.0/sra_mobile_pages/{id}Pública

Ler uma página do app

Devolve uma página com as seções. Mesmo formato da lista: a página vem dentro de pages, num vetor de um item.

Parâmetros de caminho

idstringobrigatório

Slug da página (só páginas ativas) ou UUID.

Parâmetros de consulta

channelstring

sitevenddor_appclient_app

Canal dos banners.

devicestringpadrão: mobile

mobiletabletdesktop

Dispositivo dos banners.

Exemplo de requisição

bash

curl "$BASE_URL/api/4.0/sra_mobile_pages/colecao-de-inverno?channel=venddor_app&device=mobile"

Resposta

200Página do app

json

{
  "pages": [
    {
      "id": "0c9d6a7e-5d6e-4b0a-9d2c-2f4f9f3b7c11",
      "page_id": "0c9d6a7e-5d6e-4b0a-9d2c-2f4f9f3b7c11",
      "slug": "colecao-de-inverno",
      "status": "A",
      "position": 1,
      "show_in_home": true,
      "storefront_id": "",
      "title": "Coleção de inverno",
      "description": "Casacos, cachecóis e mais.",
      "sections": [
        {
          "id": "5f2d1e1c-8c8f-4c1b-a1f5-0b0f3a9d7e22",
          "section_id": "5f2d1e1c-8c8f-4c1b-a1f5-0b0f3a9d7e22",
          "type": "product_list",
          "position": 0,
          "status": "A",
          "settings": {},
          "content": { "title": "Mais vendidos", "items": [ { "product_id": "1585658495", "product": "Caneca Esmaltada 350ml", "price": 52.9 } ] }
        }
      ]
    }
  ]
}

Campos da resposta

pages[].idstring

Id (UUID) da página. page_id repete o mesmo valor.

pages[].slugstring

Identificador curto da página, usado no caminho.

pages[].statusstring

A quando ativa.

pages[].positioninteger

Ordem entre as páginas.

pages[].show_in_homeboolean

Se a página deve aparecer na home do app.

pages[].storefront_idstring

Vitrine a que a página pertence. Pode ser vazio.

pages[].titlestring

Título.

pages[].descriptionstring

Descrição.

pages[].sectionsarray

Seções ativas, em ordem. Vazio na lista simples.

pages[].sections[].idstring

Id (UUID) da seção. section_id repete o mesmo valor.

pages[].sections[].typestring

Tipo da seção. product_list, category_list e banner_carousel têm content.items preenchido pela plataforma. Os demais tipos devolvem o content como foi salvo.

pages[].sections[].positioninteger

Ordem da seção.

pages[].sections[].settingsobject

Reservado. Sempre {}.

pages[].sections[].contentobject

Configuração da seção e, nos três tipos acima, items com os cartões de produto, categorias ou banners atuais.

Erros

Status	Quando	Corpo
403	Recurso de páginas do app desligado na loja	`{"error":"module_disabled","module":"mobile-pages"}`
404	Página inexistente (ou slug de página inativa)	`{"error":"mobile page not found"}`
500	Falha ao ler	`{"error":"failed to load mobile page","detail":"..."}`