VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Páginas de conteúdo

GETConsultar página

Devolve uma página de conteúdo pelo id, inclusive escondida ou em rascunho.

Devolve uma página completa, incluindo as escondidas e os rascunhos que a vitrine não mostra. Use para abrir a página no editor antes de alterá-la.

GET/api/v1/admin/pages/{id}Admin

Devolve uma página pelo id

Exige o privilégio manage_content ou view_content.

Parâmetros de caminho

iduuidobrigatório
Identificador da página.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/pages/cc37f047-702b-45c7-9f88-3e8d42e81011" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Página
json
{
  "id": "cc37f047-702b-45c7-9f88-3e8d42e81011",
  "title": "Política de Troca",
  "slug": "politica-de-troca",
  "body": "<p>Você pode trocar em até 7 dias.</p>",
  "status": "active",
  "page_type": "page",
  "position": 0,
  "id_path": "",
  "created_at": "2026-10-11T21:04:48.445487Z",
  "updated_at": "2026-10-11T21:04:48.445487Z",
  "page_id": "cc37f047-702b-45c7-9f88-3e8d42e81011",
  "page": "politica-de-troca",
  "page_title": "Política de Troca",
  "description": "<p>Você pode trocar em até 7 dias.</p>",
  "seo_name": "politica-de-troca",
  "timestamp": 1791752688,
  "updated_timestamp": 1791752688
}

Campos da resposta

iduuid
Identificador da página.
titlestring
Título, em texto puro (HTML é removido).
slugstring
Trecho da URL pública (/politica-de-troca). Único na loja.
bodystring
Conteúdo em HTML, já sanitizado: <script>, atributos on... e links javascript: são removidos.
statusstring
active, hidden ou draft. Veja o aviso sobre disabled.
page_typestring
page, blog ou link.
seo_titlestring
Título para buscadores. Ausente quando vazio.
seo_descriptionstring
Descrição para buscadores. Ausente quando vazia.
positioninteger
Ordem de exibição em menus. Menor aparece primeiro.
parent_iduuid
Página pai, quando a página faz parte de uma hierarquia. Ausente na raiz.
vendor_iduuid
Seller dono da página. Ausente quando a página é da loja inteira (marketplace).
created_atstring
Criação, RFC 3339 em UTC.
updated_atstring
Última alteração, RFC 3339 em UTC.

Erros

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"invalid or expired token"}
403O administrador não tem o privilégio exigido.{"error":"insufficient privileges","privilege_required_any":["manage_content","view_content"]}
404Não existe página com esse id, ou ela foi apagada.{"error":"page not found"}
500O id não é um UUID válido (a plataforma devolve 500, não 404).{"detail":"o valor \"zz\" não é um uuid válido. Envie o identificador completo, com os 36 caracteres e os hífens. Corrija o campo e reenvie.","error":"failed to update page"}
Campos repetidos

A resposta também traz campos que repetem outros valores (page_id, page, page_title, description, seo_name, timestamp, updated_timestamp). Eles repetem valores que já estão nos campos acima; em integrações novas use os campos principais.

Veja também

  • Listar páginas
  • Atualizar página
Anterior
Listar páginas
Próxima
Criar página
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também