跳至内容
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"

附加字段: 否