Esquemas de dados: Páginas CMS

Esquemas de dados: Páginas CMS. Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

Esquemas de dados

Metadados da resposta

AnalyticsPageMeta · Esquema · Esquemas de dados: Páginas CMS

paginationPagination Obrigatório: Metadados da paginação por cursor.

Exemplo: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Obrigatório: Período do relatório e seus limites.

Exemplo: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idTextoObrigatório: Identificador da solicitação; nos metadados da resposta identifica a requisição HTTP.

minLength: 1maxLength: 100

Exemplo: "example"

Campos adicionais: Não

Listar — Páginas CMS — Resposta

ApiResponse_list_PageSummaryData__ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

dataLista <PageSummaryData > Obrigatório: Exemplo de resposta · ApiResponse_list_PageSummaryData__.

Exemplo: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"market_scope":"all","number":"example","published":false,"slug":"example","title":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

Exemplo: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Campos adicionais: Não

Obter — Páginas CMS — Resposta

ApiResponse_PageDetailData_ · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

dataPageDetailData Obrigatório: Exemplo de resposta · PageDetailData.

Exemplo: {"body_html":"<p>Example</p>","created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"market_scope":"all","meta_description":"example","meta_keywords":["example"],"meta_title":"example","number":"example","published":false,"slug":"example","title":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obrigatório: Metadados da resposta.

Exemplo: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Campos adicionais: Não

Criar — Páginas CMS — Corpo da requisição

PageCreate · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

body_htmlTexto nullOpcional

Conteúdo da página em HTML.

Texto:maxLength: 100000

market_idsLista <Texto> Opcional

Identificadores dos mercados selecionados.

maxItems: 1000

Lista:minLength: 1maxLength: 63

market_scopeTextoOpcional

Indica se o recurso se aplica a todos os mercados ou apenas aos selecionados.

Restrições

enum: ["all", "selected"]

meta_descriptionTexto nullOpcional

Descrição para mecanismos de pesquisa no idioma selecionado.

Texto:maxLength: 160

meta_keywordsLista <Texto> nullOpcional

Palavras-chave para mecanismos de pesquisa no idioma selecionado.

Lista:maxItems: 20

Lista / Lista:maxLength: 60

meta_titleTexto nullOpcional

Título para mecanismos de pesquisa no idioma selecionado.

Texto:maxLength: 70

publishedBooleanoOpcional

Indica se o recurso está publicado.

Predefinido: false

slugTexto nullOpcional

Segmento do caminho da URL no idioma selecionado.

Texto:maxLength: 160

titleTextoObrigatório

Título no idioma selecionado.

minLength: 1maxLength: 300

Exemplo: "Example"

Campos adicionais: Não

Obter — Páginas CMS — Resposta

PageDetailData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

body_htmlTexto nullObrigatório

Conteúdo da página em HTML.

Exemplo: "<p>Example</p>"

created_atTextoObrigatório

Momento da criação.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. (PageDetailData).

Exemplo: "example"

is_availableBooleanoObrigatório

Indica se o item está disponível neste contexto.

Exemplo: true

market_scopeTextoObrigatório

Indica se o recurso se aplica a todos os mercados ou apenas aos selecionados.

Restrições

enum: ["all", "selected"]

Exemplo: "all"

meta_descriptionTexto nullObrigatório

Descrição para mecanismos de pesquisa no idioma selecionado.

Exemplo: "example"

meta_keywordsLista <Texto> nullObrigatório

Palavras-chave para mecanismos de pesquisa no idioma selecionado.

Exemplo: ["example"]

meta_titleTexto nullObrigatório

Título para mecanismos de pesquisa no idioma selecionado.

Exemplo: "example"

numberTextoObrigatório

Número do pedido ou da solicitação exibido ao utilizador.

Exemplo: "example"

publishedBooleanoObrigatório

Indica se o recurso está publicado.

Exemplo: false

slugTexto nullObrigatório

Segmento do caminho da URL no idioma selecionado.

Exemplo: "example"

titleTexto nullObrigatório

Título no idioma selecionado.

Exemplo: "example"

updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"

versionNúmero inteiroObrigatório

Versão do recurso utilizada para controlo de concorrência.

Exemplo: 1

Campos adicionais: Não

Listar — Páginas CMS — Resposta

PageSummaryData · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

created_atTextoObrigatório

Momento da criação.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"

idTextoObrigatório

Identificador do recurso; preserve-o conforme retornado. (PageSummaryData).

Exemplo: "example"

is_availableBooleanoObrigatório

Indica se o item está disponível neste contexto.

Exemplo: true

market_scopeTextoObrigatório

Indica se o recurso se aplica a todos os mercados ou apenas aos selecionados.

Restrições

enum: ["all", "selected"]

Exemplo: "all"

numberTextoObrigatório

Número do pedido ou da solicitação exibido ao utilizador.

Exemplo: "example"

publishedBooleanoObrigatório

Indica se o recurso está publicado.

Exemplo: false

slugTexto nullObrigatório

Segmento do caminho da URL no idioma selecionado.

Exemplo: "example"

titleTexto nullObrigatório

Título no idioma selecionado.

Exemplo: "example"

updated_atTextoObrigatório

Momento da atualização mais recente.

format: "date-time"

Exemplo: "2026-01-01T12:00:00Z"

versionNúmero inteiroObrigatório

Versão do recurso utilizada para controlo de concorrência.

Exemplo: 1

Campos adicionais: Não

Atualizar — Páginas CMS — Corpo da requisição

PageUpdate · Campos, tipos e restrições dos dados aceites ou devolvidos pela API.

body_htmlTexto nullOpcional

Conteúdo da página em HTML.

Texto:maxLength: 100000

expected_versionNúmero inteiroObrigatório

Versão lida antes da escrita; uma divergência rejeita a atualização.

minimum: 1maximum: 2147483647

Exemplo: 1

market_idsLista <Texto> Opcional

Identificadores dos mercados selecionados.

maxItems: 1000

Lista:minLength: 1maxLength: 63

market_scopeTextoOpcional

Indica se o recurso se aplica a todos os mercados ou apenas aos selecionados.

Restrições

enum: ["all", "selected"]

meta_descriptionTexto nullOpcional

Descrição para mecanismos de pesquisa no idioma selecionado.

Texto:maxLength: 160

meta_keywordsLista <Texto> nullOpcional

Palavras-chave para mecanismos de pesquisa no idioma selecionado.

Lista:maxItems: 20

Lista / Lista:maxLength: 60

meta_titleTexto nullOpcional

Título para mecanismos de pesquisa no idioma selecionado.

Texto:maxLength: 70

publishedBooleanoOpcional

Indica se o recurso está publicado.

slugTexto nullOpcional

Segmento do caminho da URL no idioma selecionado.

Texto:maxLength: 160

titleTexto nullOpcional

Título no idioma selecionado.

Texto:maxLength: 300

Exemplo: "Example"

Campos adicionais: Não