Treci la conținut
ShopentlyLearn

Scheme de date: Pagini CMS

Scheme de date: Pagini CMS. Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

Scheme de date

Metadatele răspunsului

AnalyticsPageMeta · Schemă · Scheme de date: Pagini CMS
paginationPagination Obligatoriu

Metadatele paginării prin cursor.

Exemplu: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Obligatoriu

Perioada de raportare și limitele acesteia.

Exemplu: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idȘir de caractereObligatoriu

Identificatorul solicitării; în metadatele răspunsului identifică cererea HTTP.

minLength: 1maxLength: 100
Exemplu: "example"

Câmpuri suplimentare: Nu

Listează — Pagini CMS — Răspuns

ApiResponse_list_PageSummaryData__ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
dataTablou <PageSummaryData > Obligatoriu

Exemplu de răspuns · ApiResponse_list_PageSummaryData__.

Exemplu: [{"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 Obligatoriu

Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

Obține — Pagini CMS — Răspuns

ApiResponse_PageDetailData_ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
dataPageDetailData Obligatoriu

Exemplu de răspuns · PageDetailData.

Exemplu: {"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 Obligatoriu

Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

Creează — Pagini CMS — Corpul cererii

PageCreate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
body_htmlȘir de caractere nullOpțional

Conținutul paginii în HTML.

Șir de caractere:maxLength: 100000
market_idsTablou <Șir de caractere> Opțional

Identificatorii piețelor selectate.

maxItems: 1000
Tablou:minLength: 1maxLength: 63
market_scopeȘir de caractereOpțional

Indică dacă resursa se aplică tuturor piețelor sau numai celor selectate.

Restricții
enum
["all", "selected"]
meta_descriptionȘir de caractere nullOpțional

Descriere pentru motoarele de căutare, în limba selectată.

Șir de caractere:maxLength: 160
meta_keywordsTablou <Șir de caractere> nullOpțional

Cuvinte-cheie pentru motoarele de căutare, în limba selectată.

Tablou:maxItems: 20
Tablou / Tablou:maxLength: 60
meta_titleȘir de caractere nullOpțional

Titlu pentru motoarele de căutare, în limba selectată.

Șir de caractere:maxLength: 70
publishedValoare booleanăOpțional

Indică dacă resursa este publicată.

Valoare implicită: false
slugȘir de caractere nullOpțional

Segmentul căii URL în limba selectată.

Șir de caractere:maxLength: 160
titleȘir de caractereObligatoriu

Titlul în limba selectată.

minLength: 1maxLength: 300
Exemplu: "Example"

Câmpuri suplimentare: Nu

Obține — Pagini CMS — Răspuns

PageDetailData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
body_htmlȘir de caractere nullObligatoriu

Conținutul paginii în HTML.

Exemplu: "<p>Example</p>"
created_atȘir de caractereObligatoriu

Momentul creării.

format: "date-time"
Exemplu: "2026-01-01T12:00:00Z"
idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (PageDetailData).

Exemplu: "example"
is_availableValoare booleanăObligatoriu

Indică dacă articolul este disponibil în acest context.

Exemplu: true
market_scopeȘir de caractereObligatoriu

Indică dacă resursa se aplică tuturor piețelor sau numai celor selectate.

Restricții
enum
["all", "selected"]
Exemplu: "all"
meta_descriptionȘir de caractere nullObligatoriu

Descriere pentru motoarele de căutare, în limba selectată.

Exemplu: "example"
meta_keywordsTablou <Șir de caractere> nullObligatoriu

Cuvinte-cheie pentru motoarele de căutare, în limba selectată.

Exemplu: ["example"]
meta_titleȘir de caractere nullObligatoriu

Titlu pentru motoarele de căutare, în limba selectată.

Exemplu: "example"
numberȘir de caractereObligatoriu

Numărul comenzii sau al solicitării, destinat utilizatorilor.

Exemplu: "example"
publishedValoare booleanăObligatoriu

Indică dacă resursa este publicată.

Exemplu: false
slugȘir de caractere nullObligatoriu

Segmentul căii URL în limba selectată.

Exemplu: "example"
titleȘir de caractere nullObligatoriu

Titlul în limba selectată.

Exemplu: "example"
updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"
Exemplu: "2026-01-01T12:00:00Z"
versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

Câmpuri suplimentare: Nu

Listează — Pagini CMS — Răspuns

PageSummaryData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
created_atȘir de caractereObligatoriu

Momentul creării.

format: "date-time"
Exemplu: "2026-01-01T12:00:00Z"
idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (PageSummaryData).

Exemplu: "example"
is_availableValoare booleanăObligatoriu

Indică dacă articolul este disponibil în acest context.

Exemplu: true
market_scopeȘir de caractereObligatoriu

Indică dacă resursa se aplică tuturor piețelor sau numai celor selectate.

Restricții
enum
["all", "selected"]
Exemplu: "all"
numberȘir de caractereObligatoriu

Numărul comenzii sau al solicitării, destinat utilizatorilor.

Exemplu: "example"
publishedValoare booleanăObligatoriu

Indică dacă resursa este publicată.

Exemplu: false
slugȘir de caractere nullObligatoriu

Segmentul căii URL în limba selectată.

Exemplu: "example"
titleȘir de caractere nullObligatoriu

Titlul în limba selectată.

Exemplu: "example"
updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"
Exemplu: "2026-01-01T12:00:00Z"
versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

Câmpuri suplimentare: Nu

Actualizează — Pagini CMS — Corpul cererii

PageUpdate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
body_htmlȘir de caractere nullOpțional

Conținutul paginii în HTML.

Șir de caractere:maxLength: 100000
expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 2147483647
Exemplu: 1
market_idsTablou <Șir de caractere> Opțional

Identificatorii piețelor selectate.

maxItems: 1000
Tablou:minLength: 1maxLength: 63
market_scopeȘir de caractereOpțional

Indică dacă resursa se aplică tuturor piețelor sau numai celor selectate.

Restricții
enum
["all", "selected"]
meta_descriptionȘir de caractere nullOpțional

Descriere pentru motoarele de căutare, în limba selectată.

Șir de caractere:maxLength: 160
meta_keywordsTablou <Șir de caractere> nullOpțional

Cuvinte-cheie pentru motoarele de căutare, în limba selectată.

Tablou:maxItems: 20
Tablou / Tablou:maxLength: 60
meta_titleȘir de caractere nullOpțional

Titlu pentru motoarele de căutare, în limba selectată.

Șir de caractere:maxLength: 70
publishedValoare booleanăOpțional

Indică dacă resursa este publicată.

slugȘir de caractere nullOpțional

Segmentul căii URL în limba selectată.

Șir de caractere:maxLength: 160
titleȘir de caractere nullOpțional

Titlul în limba selectată.

Șir de caractere:maxLength: 300
Exemplu: "Example"

Câmpuri suplimentare: Nu