VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Layouts simples

Os layouts planos (lista de blocos por tipo de página) e como eles se diferenciam do layout avançado e do editor visual.

Um layout define quais blocos aparecem numa página da vitrine (logo, busca, vitrine de produtos, texto, rodapé...) e em que zona. Esta seção documenta o layout simples: um registro com uma lista plana de blocos guardada como JSON, criado para um tipo de página (homepage, product, category, vendor ou custom). É o modelo mais antigo da plataforma.

A vitrine atual não lê estes layouts

O código da vitrine marca este modelo como obsoleto: ela renderiza as páginas a partir do layout avançado (contêineres, linhas, colunas e blocos, em /api/v1/admin/advanced-layouts) e o editor visual trabalha sobre ele. Os layouts simples desta página continuam existindo e editáveis pela API, mas não são o que a vitrine usa para desenhar as páginas: mudar um bloco aqui não muda a página da loja. Use estas rotas apenas para integrações que já dependem delas. Os ids são diferentes: o id de um layout simples não serve nas rotas do editor visual.

Pontos-chave
  • O id do layout simples é um inteiro (por exemplo 11); o id de um bloco é um UUID em texto, gerado pelo servidor.
  • Todas as rotas exigem token de administrador com o privilégio manage_layouts.
  • Cada tipo de página pode ter vários layouts, mas só um é o padrão (is_default).
  • O servidor aceita qualquer texto em type e position de bloco: não há validação contra uma lista fechada.
  • A lista de blocos de um layout não pode passar de 1 MB de JSON.

Como funciona

  1. Crie o layout
    POST /api/v1/admin/layouts com name e, se quiser, page_type e a lista inicial de blocks.
  2. Monte os blocos
    Adicione, edite, remova e reordene blocos pelas rotas de blocos, ou substitua a lista inteira com PUT /api/v1/admin/layouts/{id}.
  3. Marque como padrão
    Use definir padrão para que seja o layout do tipo de página.

Conceitos-chave

Tipos de página

page_typePágina
homepagePágina inicial. Valor usado quando você não informa nenhum na criação.
productPágina de produto.
categoryPágina de categoria.
vendorPágina do vendedor (seller, o lojista de um marketplace).
customPágina personalizada.

Blocos e zonas

Um bloco tem type (o que ele é: logo, search_bar, text_html, recent_products, hero_banner...), position (a zona: header, main_top, main, main_bottom, sidebar_left, sidebar_right ou footer), order (a ordem dentro da zona, a partir de 0), title, config (objeto livre com as opções do bloco) e visible. As ordens são renumeradas em sequência 0, 1, 2 dentro de cada zona sempre que você remove ou reordena blocos.

Layout avançado: onde estão os blocos de verdade

Se você chamar uma destas rotas de bloco com o id de um layout avançado (o id da tela /admin/layouts/{id}/edit do painel), recebe 404 com a explicação e a rota equivalente do layout avançado.

Endpoints

MétodoCaminhoPara que serveAuth
GET/api/v1/admin/layoutsListar layoutsadmin
POST/api/v1/admin/layoutsCriar layoutadmin
GET/api/v1/admin/layouts/{id}Consultar layoutadmin
PUT/api/v1/admin/layouts/{id}Alterar layoutadmin
DELETE/api/v1/admin/layouts/{id}Excluir layoutadmin
POST/api/v1/admin/layouts/{id}/blocksAdicionar blocoadmin
PUT/api/v1/admin/layouts/{id}/blocks/{blockId}Alterar blocoadmin
DELETE/api/v1/admin/layouts/{id}/blocks/{blockId}Remover blocoadmin
POST/api/v1/admin/layouts/{id}/blocks/reorderReordenar blocosadmin
POST/api/v1/admin/layouts/{id}/cloneDuplicar layoutadmin
POST/api/v1/admin/layouts/{id}/set-defaultDefinir padrãoadmin

Erros comuns

  • Achar que mudar o layout simples muda a loja. Não muda: veja o aviso acima.
  • Usar o id do editor visual (ou de um layout avançado) aqui. Retorna 404 em consultar e nas rotas de bloco; em alterar, excluir, duplicar e definir padrão o erro vem como 500.
  • Enviar blocks no PUT achando que é parcial. O campo blocks substitui a lista inteira.
  • PUT sem nenhum campo. Retorna 500 no fields to update.
  • Mandar id não numérico. Retorna 400 invalid layout id.
  • Esperar lista vazia como []. Quando nada atende ao filtro a lista vem como "layouts": null.

Próximos passos

Layouts
Listar, criar, alterar e excluir.
Blocos
Adicionar, editar, remover e reordenar.
Editor visual
O fluxo atual de edição da vitrine, com rascunho.
Anterior
Editar design com a VI
Próxima
Layouts
Nesta página
  • Como funciona
  • Conceitos-chave
  • Tipos de página
  • Blocos e zonas
  • Layout avançado: onde estão os blocos de verdade
  • Endpoints
  • Erros comuns
  • Próximos passos