İçeriğe atla
ShopentlyLearn

Veri şemaları: CMS sayfaları

Veri şemaları: CMS sayfaları. API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.

Veri şemaları

Yanıt üst verileri

AnalyticsPageMeta · Şema · Veri şemaları: CMS sayfaları
paginationPagination Zorunlu

İmleç tabanlı sayfalamanın üst verileri.

Örnek: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Zorunlu

Raporlama dönemi ve sınırları.

Örnek: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idDizeZorunlu

Talep tanımlayıcısı; yanıt üst verilerinde HTTP isteğini tanımlar.

minLength: 1maxLength: 100
Örnek: "example"

Ek alanlar: Hayır

Listele — CMS sayfaları — Yanıt

ApiResponse_list_PageSummaryData__ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
dataDizi <PageSummaryData > Zorunlu

Yanıt örneği · ApiResponse_list_PageSummaryData__.

Örnek: [{"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 Zorunlu

Yanıt üst verileri.

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

Ek alanlar: Hayır

Getir — CMS sayfaları — Yanıt

ApiResponse_PageDetailData_ · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
dataPageDetailData Zorunlu

Yanıt örneği · PageDetailData.

Örnek: {"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 Zorunlu

Yanıt üst verileri.

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

Ek alanlar: Hayır

Oluştur — CMS sayfaları — İstek gövdesi

PageCreate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
body_htmlDize nullİsteğe bağlı

HTML biçiminde sayfa içeriği.

Dize:maxLength: 100000
market_idsDizi <Dize> İsteğe bağlı

Seçilen pazarların tanımlayıcıları.

maxItems: 1000
Dizi:minLength: 1maxLength: 63
market_scopeDizeİsteğe bağlı

Kaynağın tüm pazarlara mı, seçilen pazarlara mı uygulandığı.

Kısıtlamalar
enum
["all", "selected"]
meta_descriptionDize nullİsteğe bağlı

Seçilen dilde arama motoru açıklaması.

Dize:maxLength: 160
meta_keywordsDizi <Dize> nullİsteğe bağlı

Seçilen dilde arama motoru anahtar kelimeleri.

Dizi:maxItems: 20
Dizi / Dizi:maxLength: 60
meta_titleDize nullİsteğe bağlı

Seçilen dilde arama motoru başlığı.

Dize:maxLength: 70
publishedMantıksal değerİsteğe bağlı

Kaynağın yayımlanıp yayımlanmadığı.

Varsayılan: false
slugDize nullİsteğe bağlı

Seçilen dilde URL yolu parçası.

Dize:maxLength: 160
titleDizeZorunlu

Seçilen dilde başlık.

minLength: 1maxLength: 300
Örnek: "Example"

Ek alanlar: Hayır

Getir — CMS sayfaları — Yanıt

PageDetailData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
body_htmlDize nullZorunlu

HTML biçiminde sayfa içeriği.

Örnek: "<p>Example</p>"
created_atDizeZorunlu

Oluşturulma zamanı.

format: "date-time"
Örnek: "2026-01-01T12:00:00Z"
idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. (PageDetailData).

Örnek: "example"
is_availableMantıksal değerZorunlu

Öğenin bu bağlamda kullanılabilir olup olmadığı.

Örnek: true
market_scopeDizeZorunlu

Kaynağın tüm pazarlara mı, seçilen pazarlara mı uygulandığı.

Kısıtlamalar
enum
["all", "selected"]
Örnek: "all"
meta_descriptionDize nullZorunlu

Seçilen dilde arama motoru açıklaması.

Örnek: "example"
meta_keywordsDizi <Dize> nullZorunlu

Seçilen dilde arama motoru anahtar kelimeleri.

Örnek: ["example"]
meta_titleDize nullZorunlu

Seçilen dilde arama motoru başlığı.

Örnek: "example"
numberDizeZorunlu

Kullanıcıya gösterilen sipariş veya talep numarası.

Örnek: "example"
publishedMantıksal değerZorunlu

Kaynağın yayımlanıp yayımlanmadığı.

Örnek: false
slugDize nullZorunlu

Seçilen dilde URL yolu parçası.

Örnek: "example"
titleDize nullZorunlu

Seçilen dilde başlık.

Örnek: "example"
updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"
Örnek: "2026-01-01T12:00:00Z"
versionTam sayıZorunlu

Eşzamanlılık denetiminde kullanılan kaynak sürümü.

Örnek: 1

Ek alanlar: Hayır

Listele — CMS sayfaları — Yanıt

PageSummaryData · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
created_atDizeZorunlu

Oluşturulma zamanı.

format: "date-time"
Örnek: "2026-01-01T12:00:00Z"
idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun. (PageSummaryData).

Örnek: "example"
is_availableMantıksal değerZorunlu

Öğenin bu bağlamda kullanılabilir olup olmadığı.

Örnek: true
market_scopeDizeZorunlu

Kaynağın tüm pazarlara mı, seçilen pazarlara mı uygulandığı.

Kısıtlamalar
enum
["all", "selected"]
Örnek: "all"
numberDizeZorunlu

Kullanıcıya gösterilen sipariş veya talep numarası.

Örnek: "example"
publishedMantıksal değerZorunlu

Kaynağın yayımlanıp yayımlanmadığı.

Örnek: false
slugDize nullZorunlu

Seçilen dilde URL yolu parçası.

Örnek: "example"
titleDize nullZorunlu

Seçilen dilde başlık.

Örnek: "example"
updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"
Örnek: "2026-01-01T12:00:00Z"
versionTam sayıZorunlu

Eşzamanlılık denetiminde kullanılan kaynak sürümü.

Örnek: 1

Ek alanlar: Hayır

Güncelle — CMS sayfaları — İstek gövdesi

PageUpdate · API'nin kabul ettiği veya döndürdüğü verilerin alanları, türleri ve kısıtlamaları.
body_htmlDize nullİsteğe bağlı

HTML biçiminde sayfa içeriği.

Dize:maxLength: 100000
expected_versionTam sayıZorunlu

Yazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.

minimum: 1maximum: 2147483647
Örnek: 1
market_idsDizi <Dize> İsteğe bağlı

Seçilen pazarların tanımlayıcıları.

maxItems: 1000
Dizi:minLength: 1maxLength: 63
market_scopeDizeİsteğe bağlı

Kaynağın tüm pazarlara mı, seçilen pazarlara mı uygulandığı.

Kısıtlamalar
enum
["all", "selected"]
meta_descriptionDize nullİsteğe bağlı

Seçilen dilde arama motoru açıklaması.

Dize:maxLength: 160
meta_keywordsDizi <Dize> nullİsteğe bağlı

Seçilen dilde arama motoru anahtar kelimeleri.

Dizi:maxItems: 20
Dizi / Dizi:maxLength: 60
meta_titleDize nullİsteğe bağlı

Seçilen dilde arama motoru başlığı.

Dize:maxLength: 70
publishedMantıksal değerİsteğe bağlı

Kaynağın yayımlanıp yayımlanmadığı.

slugDize nullİsteğe bağlı

Seçilen dilde URL yolu parçası.

Dize:maxLength: 160
titleDize nullİsteğe bağlı

Seçilen dilde başlık.

Dize:maxLength: 300
Örnek: "Example"

Ek alanlar: Hayır