Esquemas de datos: Páginas CMS

Esquemas de datos: Páginas CMS. Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

Esquemas de datos

Metadatos de la respuesta

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

paginationPagination Obligatorio: Metadatos de la paginación por cursor.

Ejemplo: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Obligatorio: Periodo del informe y sus límites.

Ejemplo: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idCadena de textoObligatorio: Identificador de la solicitud; en los metadatos de respuesta identifica la solicitud HTTP.

minLength: 1maxLength: 100

Ejemplo: "example"

Campos adicionales: No

Listar — Páginas CMS — Respuesta

ApiResponse_list_PageSummaryData__ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataLista <PageSummaryData > Obligatorio: Ejemplo de respuesta · ApiResponse_list_PageSummaryData__.

Ejemplo: [{"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 Obligatorio: Metadatos de la respuesta.

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

Campos adicionales: No

Obtener — Páginas CMS — Respuesta

ApiResponse_PageDetailData_ · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

dataPageDetailData Obligatorio: Ejemplo de respuesta · PageDetailData.

Ejemplo: {"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 Obligatorio: Metadatos de la respuesta.

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

Campos adicionales: No

Crear — Páginas CMS — Cuerpo de la solicitud

PageCreate · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

body_htmlCadena de texto nullOpcional

Contenido de la página en HTML.

Cadena de texto:maxLength: 100000

market_idsLista <Cadena de texto> Opcional

Identificadores de los mercados seleccionados.

maxItems: 1000

Lista:minLength: 1maxLength: 63

market_scopeCadena de textoOpcional

Indica si el recurso se aplica a todos los mercados o solo a los seleccionados.

Restricciones

enum: ["all", "selected"]

meta_descriptionCadena de texto nullOpcional

Descripción para buscadores en el idioma seleccionado.

Cadena de texto:maxLength: 160

meta_keywordsLista <Cadena de texto> nullOpcional

Palabras clave para buscadores en el idioma seleccionado.

Lista:maxItems: 20

Lista / Lista:maxLength: 60

meta_titleCadena de texto nullOpcional

Título para buscadores en el idioma seleccionado.

Cadena de texto:maxLength: 70

publishedBooleanoOpcional

Indica si el recurso está publicado.

Valor predeterminado: false

slugCadena de texto nullOpcional

Segmento de la ruta URL en el idioma seleccionado.

Cadena de texto:maxLength: 160

titleCadena de textoObligatorio

Título en el idioma seleccionado.

minLength: 1maxLength: 300

Ejemplo: "Example"

Campos adicionales: No

Obtener — Páginas CMS — Respuesta

PageDetailData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

body_htmlCadena de texto nullObligatorio

Contenido de la página en HTML.

Ejemplo: "<p>Example</p>"

created_atCadena de textoObligatorio

Momento de creación.

format: "date-time"

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

idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. (PageDetailData).

Ejemplo: "example"

is_availableBooleanoObligatorio

Indica si el elemento está disponible en este contexto.

Ejemplo: true

market_scopeCadena de textoObligatorio

Indica si el recurso se aplica a todos los mercados o solo a los seleccionados.

Restricciones

enum: ["all", "selected"]

Ejemplo: "all"

meta_descriptionCadena de texto nullObligatorio

Descripción para buscadores en el idioma seleccionado.

Ejemplo: "example"

meta_keywordsLista <Cadena de texto> nullObligatorio

Palabras clave para buscadores en el idioma seleccionado.

Ejemplo: ["example"]

meta_titleCadena de texto nullObligatorio

Título para buscadores en el idioma seleccionado.

Ejemplo: "example"

numberCadena de textoObligatorio

Número de pedido o solicitud mostrado al usuario.

Ejemplo: "example"

publishedBooleanoObligatorio

Indica si el recurso está publicado.

Ejemplo: false

slugCadena de texto nullObligatorio

Segmento de la ruta URL en el idioma seleccionado.

Ejemplo: "example"

titleCadena de texto nullObligatorio

Título en el idioma seleccionado.

Ejemplo: "example"

updated_atCadena de textoObligatorio

Momento de la última actualización.

format: "date-time"

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

versionNúmero enteroObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

Campos adicionales: No

Listar — Páginas CMS — Respuesta

PageSummaryData · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

created_atCadena de textoObligatorio

Momento de creación.

format: "date-time"

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

idCadena de textoObligatorio

Identificador del recurso; consérvalo tal como se devuelve. (PageSummaryData).

Ejemplo: "example"

is_availableBooleanoObligatorio

Indica si el elemento está disponible en este contexto.

Ejemplo: true

market_scopeCadena de textoObligatorio

Indica si el recurso se aplica a todos los mercados o solo a los seleccionados.

Restricciones

enum: ["all", "selected"]

Ejemplo: "all"

numberCadena de textoObligatorio

Número de pedido o solicitud mostrado al usuario.

Ejemplo: "example"

publishedBooleanoObligatorio

Indica si el recurso está publicado.

Ejemplo: false

slugCadena de texto nullObligatorio

Segmento de la ruta URL en el idioma seleccionado.

Ejemplo: "example"

titleCadena de texto nullObligatorio

Título en el idioma seleccionado.

Ejemplo: "example"

updated_atCadena de textoObligatorio

Momento de la última actualización.

format: "date-time"

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

versionNúmero enteroObligatorio

Versión del recurso utilizada para controlar cambios simultáneos.

Ejemplo: 1

Campos adicionales: No

Actualizar — Páginas CMS — Cuerpo de la solicitud

PageUpdate · Campos, tipos y restricciones de los datos aceptados o devueltos por la API.

body_htmlCadena de texto nullOpcional

Contenido de la página en HTML.

Cadena de texto:maxLength: 100000

expected_versionNúmero enteroObligatorio

Versión leída antes de escribir; si no coincide, se rechaza la actualización.

minimum: 1maximum: 2147483647

Ejemplo: 1

market_idsLista <Cadena de texto> Opcional

Identificadores de los mercados seleccionados.

maxItems: 1000

Lista:minLength: 1maxLength: 63

market_scopeCadena de textoOpcional

Indica si el recurso se aplica a todos los mercados o solo a los seleccionados.

Restricciones

enum: ["all", "selected"]

meta_descriptionCadena de texto nullOpcional

Descripción para buscadores en el idioma seleccionado.

Cadena de texto:maxLength: 160

meta_keywordsLista <Cadena de texto> nullOpcional

Palabras clave para buscadores en el idioma seleccionado.

Lista:maxItems: 20

Lista / Lista:maxLength: 60

meta_titleCadena de texto nullOpcional

Título para buscadores en el idioma seleccionado.

Cadena de texto:maxLength: 70

publishedBooleanoOpcional

Indica si el recurso está publicado.

slugCadena de texto nullOpcional

Segmento de la ruta URL en el idioma seleccionado.

Cadena de texto:maxLength: 160

titleCadena de texto nullOpcional

Título en el idioma seleccionado.

Cadena de texto:maxLength: 300

Ejemplo: "Example"

Campos adicionales: No