跳至內容
ShopentlyLearn

資料架構: CMS 頁面

資料架構: CMS 頁面. API 接收或傳回的資料欄位、類型和限制。

資料架構

回應元資料

AnalyticsPageMeta · 架構 · 資料架構: CMS 頁面
paginationPagination 必填

遊標分頁元資料。

示例: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData 必填

報告期及其邊界。

示例: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_id字串必填

申請識別碼;在回應元資料中表示 HTTP 請求識別碼。

minLength: 1maxLength: 100
示例: "example"

附加欄位: 否

取得清單 — CMS 頁面 — 回應

ApiResponse_list_PageSummaryData__ · API 接收或傳回的資料欄位、類型和限制。
data陣列 <PageSummaryData > 必填

回應示例 · ApiResponse_list_PageSummaryData__.

示例: [{"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 必填

回應元資料。

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

附加欄位: 否

取得 — CMS 頁面 — 回應

ApiResponse_PageDetailData_ · API 接收或傳回的資料欄位、類型和限制。
dataPageDetailData 必填

回應示例 · PageDetailData.

示例: {"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 必填

回應元資料。

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

附加欄位: 否

建立 — CMS 頁面 — 請求本文

PageCreate · API 接收或傳回的資料欄位、類型和限制。
body_html字串 null選填

頁面的 HTML 內容。

字串:maxLength: 100000
market_ids陣列 <字串> 選填

所選市場的識別碼。

maxItems: 1000
陣列:minLength: 1maxLength: 63
market_scope字串選填

資源適用於全部市場還是指定市場。

約束
enum
["all", "selected"]
meta_description字串 null選填

所選語言的搜尋引擎描述。

字串:maxLength: 160
meta_keywords陣列 <字串> null選填

所選語言的搜尋引擎關鍵詞。

陣列:maxItems: 20
陣列 / 陣列:maxLength: 60
meta_title字串 null選填

所選語言的搜尋引擎標題。

字串:maxLength: 70
published布林值選填

資源是否已發佈。

預設值: false
slug字串 null選填

所選語言的 URL 路徑段。

字串:maxLength: 160
title字串必填

所選語言的標題。

minLength: 1maxLength: 300
示例: "Example"

附加欄位: 否

取得 — CMS 頁面 — 回應

PageDetailData · API 接收或傳回的資料欄位、類型和限制。
body_html字串 null必填

頁面的 HTML 內容。

示例: "<p>Example</p>"
created_at字串必填

建立時間。

format: "date-time"
示例: "2026-01-01T12:00:00Z"
id字串必填

資源識別碼;請保留回傳的原值。 (PageDetailData).

示例: "example"
is_available布林值必填

此項目在目前上下文中是否可用。

示例: true
market_scope字串必填

資源適用於全部市場還是指定市場。

約束
enum
["all", "selected"]
示例: "all"
meta_description字串 null必填

所選語言的搜尋引擎描述。

示例: "example"
meta_keywords陣列 <字串> null必填

所選語言的搜尋引擎關鍵詞。

示例: ["example"]
meta_title字串 null必填

所選語言的搜尋引擎標題。

示例: "example"
number字串必填

面向使用者的訂單號或申請編號。

示例: "example"
published布林值必填

資源是否已發佈。

示例: false
slug字串 null必填

所選語言的 URL 路徑段。

示例: "example"
title字串 null必填

所選語言的標題。

示例: "example"
updated_at字串必填

最近更新時間。

format: "date-time"
示例: "2026-01-01T12:00:00Z"
version整數必填

用於並行控制的資源版本。

示例: 1

附加欄位: 否

取得清單 — CMS 頁面 — 回應

PageSummaryData · API 接收或傳回的資料欄位、類型和限制。
created_at字串必填

建立時間。

format: "date-time"
示例: "2026-01-01T12:00:00Z"
id字串必填

資源識別碼;請保留回傳的原值。 (PageSummaryData).

示例: "example"
is_available布林值必填

此項目在目前上下文中是否可用。

示例: true
market_scope字串必填

資源適用於全部市場還是指定市場。

約束
enum
["all", "selected"]
示例: "all"
number字串必填

面向使用者的訂單號或申請編號。

示例: "example"
published布林值必填

資源是否已發佈。

示例: false
slug字串 null必填

所選語言的 URL 路徑段。

示例: "example"
title字串 null必填

所選語言的標題。

示例: "example"
updated_at字串必填

最近更新時間。

format: "date-time"
示例: "2026-01-01T12:00:00Z"
version整數必填

用於並行控制的資源版本。

示例: 1

附加欄位: 否

更新 — CMS 頁面 — 請求本文

PageUpdate · API 接收或傳回的資料欄位、類型和限制。
body_html字串 null選填

頁面的 HTML 內容。

字串:maxLength: 100000
expected_version整數必填

寫入前讀取的版本;不匹配時拒絕更新。

minimum: 1maximum: 2147483647
示例: 1
market_ids陣列 <字串> 選填

所選市場的識別碼。

maxItems: 1000
陣列:minLength: 1maxLength: 63
market_scope字串選填

資源適用於全部市場還是指定市場。

約束
enum
["all", "selected"]
meta_description字串 null選填

所選語言的搜尋引擎描述。

字串:maxLength: 160
meta_keywords陣列 <字串> null選填

所選語言的搜尋引擎關鍵詞。

陣列:maxItems: 20
陣列 / 陣列:maxLength: 60
meta_title字串 null選填

所選語言的搜尋引擎標題。

字串:maxLength: 70
published布林值選填

資源是否已發佈。

slug字串 null選填

所選語言的 URL 路徑段。

字串:maxLength: 160
title字串 null選填

所選語言的標題。

字串:maxLength: 300
示例: "Example"

附加欄位: 否