Acesso Comercial / Docs / Storefront / API
Ctrl K
OBJECT

PageElement

Elemento de página customizável que compõe layouts de páginas da loja.

Usado em: clientpageElements  |  PageElementchildren (recursivo)

Campos

CampoTipoDescrição
elementElement!Definição do elemento (tipo, propriedades, sub-elementos).
children[PageElement!]!Elementos filhos (estrutura recursiva em árvore).
propsString!Propriedades de configuração serializadas em JSON.

Element

CampoTipoDescrição
idID!ID global Relay do elemento.
typeString!Tipo do elemento (ex: "hero", "text", "image", "carousel").
propsJSON!Propriedades do elemento (formato varia por tipo).
subElements[Element!]!Sub-elementos aninhados.

Query

GraphQL
query GetPageElements($hostname: String!) {
  client(hostname: $hostname) {
    pages {
      slug
      elements {
        element {
          id
          type
          props
        }
        children {
          element {
            id
            type
            props
          }
          props
        }
        props
      }
    }
  }
}

Resposta

JSON
{
  "data": {
    "client": {
      "pages": [
        {
          "slug": "about",
          "elements": [
            {
              "element": {
                "id": "RWxlbWVudDphYmMx",
                "type": "hero",
                "props": {
                  "title": "Sobre nós",
                  "backgroundUrl": "https://..."
                }
              },
              "children": [],
              "props": "{}"
            }
          ]
        }
      ]
    }
  }
}