Vai al contenuto
ShopentlyLearn

Schemi dei dati: Pagine CMS

Schemi dei dati: Pagine CMS. Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

Schemi dei dati

Metadati della risposta

AnalyticsPageMeta · Schema · Schemi dei dati: Pagine CMS
paginationPagination Obbligatorio

Metadati della paginazione a cursore.

Esempio: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Obbligatorio

Periodo di rendicontazione e relativi limiti temporali.

Esempio: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idStringaObbligatorio

Identificativo della richiesta; nei metadati della risposta identifica la richiesta HTTP.

minLength: 1maxLength: 100
Esempio: "example"

Campi aggiuntivi: No

Elenca — Pagine CMS — Risposta

ApiResponse_list_PageSummaryData__ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
dataArray <PageSummaryData > Obbligatorio

Esempio di risposta · ApiResponse_list_PageSummaryData__.

Esempio: [{"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 Obbligatorio

Metadati della risposta.

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

Campi aggiuntivi: No

Recupera — Pagine CMS — Risposta

ApiResponse_PageDetailData_ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
dataPageDetailData Obbligatorio

Esempio di risposta · PageDetailData.

Esempio: {"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 Obbligatorio

Metadati della risposta.

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

Campi aggiuntivi: No

Crea — Pagine CMS — Corpo della richiesta

PageCreate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
body_htmlStringa nullFacoltativo

Contenuto della pagina in HTML.

Stringa:maxLength: 100000
market_idsArray <Stringa> Facoltativo

Identificativi dei mercati selezionati.

maxItems: 1000
Array:minLength: 1maxLength: 63
market_scopeStringaFacoltativo

Indica se la risorsa si applica a tutti i mercati o a quelli selezionati.

Vincoli
enum
["all", "selected"]
meta_descriptionStringa nullFacoltativo

Descrizione per i motori di ricerca nella lingua selezionata.

Stringa:maxLength: 160
meta_keywordsArray <Stringa> nullFacoltativo

Parole chiave per i motori di ricerca nella lingua selezionata.

Array:maxItems: 20
Array / Array:maxLength: 60
meta_titleStringa nullFacoltativo

Titolo per i motori di ricerca nella lingua selezionata.

Stringa:maxLength: 70
publishedBooleanoFacoltativo

Indica se la risorsa è pubblicata.

Valore predefinito: false
slugStringa nullFacoltativo

Segmento del percorso URL nella lingua selezionata.

Stringa:maxLength: 160
titleStringaObbligatorio

Titolo nella lingua selezionata.

minLength: 1maxLength: 300
Esempio: "Example"

Campi aggiuntivi: No

Recupera — Pagine CMS — Risposta

PageDetailData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
body_htmlStringa nullObbligatorio

Contenuto della pagina in HTML.

Esempio: "<p>Example</p>"
created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. (PageDetailData).

Esempio: "example"
is_availableBooleanoObbligatorio

Indica se l’elemento è disponibile in questo contesto.

Esempio: true
market_scopeStringaObbligatorio

Indica se la risorsa si applica a tutti i mercati o a quelli selezionati.

Vincoli
enum
["all", "selected"]
Esempio: "all"
meta_descriptionStringa nullObbligatorio

Descrizione per i motori di ricerca nella lingua selezionata.

Esempio: "example"
meta_keywordsArray <Stringa> nullObbligatorio

Parole chiave per i motori di ricerca nella lingua selezionata.

Esempio: ["example"]
meta_titleStringa nullObbligatorio

Titolo per i motori di ricerca nella lingua selezionata.

Esempio: "example"
numberStringaObbligatorio

Numero dell’ordine o della richiesta destinato alle persone.

Esempio: "example"
publishedBooleanoObbligatorio

Indica se la risorsa è pubblicata.

Esempio: false
slugStringa nullObbligatorio

Segmento del percorso URL nella lingua selezionata.

Esempio: "example"
titleStringa nullObbligatorio

Titolo nella lingua selezionata.

Esempio: "example"
updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Elenca — Pagine CMS — Risposta

PageSummaryData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. (PageSummaryData).

Esempio: "example"
is_availableBooleanoObbligatorio

Indica se l’elemento è disponibile in questo contesto.

Esempio: true
market_scopeStringaObbligatorio

Indica se la risorsa si applica a tutti i mercati o a quelli selezionati.

Vincoli
enum
["all", "selected"]
Esempio: "all"
numberStringaObbligatorio

Numero dell’ordine o della richiesta destinato alle persone.

Esempio: "example"
publishedBooleanoObbligatorio

Indica se la risorsa è pubblicata.

Esempio: false
slugStringa nullObbligatorio

Segmento del percorso URL nella lingua selezionata.

Esempio: "example"
titleStringa nullObbligatorio

Titolo nella lingua selezionata.

Esempio: "example"
updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No

Aggiorna — Pagine CMS — Corpo della richiesta

PageUpdate · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
body_htmlStringa nullFacoltativo

Contenuto della pagina in HTML.

Stringa:maxLength: 100000
expected_versionInteroObbligatorio

Versione letta prima della scrittura; una differenza impedisce l’aggiornamento.

minimum: 1maximum: 2147483647
Esempio: 1
market_idsArray <Stringa> Facoltativo

Identificativi dei mercati selezionati.

maxItems: 1000
Array:minLength: 1maxLength: 63
market_scopeStringaFacoltativo

Indica se la risorsa si applica a tutti i mercati o a quelli selezionati.

Vincoli
enum
["all", "selected"]
meta_descriptionStringa nullFacoltativo

Descrizione per i motori di ricerca nella lingua selezionata.

Stringa:maxLength: 160
meta_keywordsArray <Stringa> nullFacoltativo

Parole chiave per i motori di ricerca nella lingua selezionata.

Array:maxItems: 20
Array / Array:maxLength: 60
meta_titleStringa nullFacoltativo

Titolo per i motori di ricerca nella lingua selezionata.

Stringa:maxLength: 70
publishedBooleanoFacoltativo

Indica se la risorsa è pubblicata.

slugStringa nullFacoltativo

Segmento del percorso URL nella lingua selezionata.

Stringa:maxLength: 160
titleStringa nullFacoltativo

Titolo nella lingua selezionata.

Stringa:maxLength: 300
Esempio: "Example"

Campi aggiuntivi: No