跳至内容
ShopentlyLearn

数据架构: 分类

数据架构: 分类. API 接收或返回的数据字段、类型和约束。

数据架构

获取 — 分类 — 响应

ApiResponse_CategoryDetailData_ · API 接收或返回的数据字段、类型和约束。
dataCategoryDetailData 必填

响应示例 · CategoryDetailData.

示例: {"created_at":"2026-01-01T12:00:00Z","description":"example","id":"example","introduction":"example","is_available":true,"is_visible":false,"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","parent_id":null,"slug":"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"}

附加字段: 否

获取列表 — 分类 — 响应

ApiResponse_list_CategorySummaryData__ · API 接收或返回的数据字段、类型和约束。
data数组 <CategorySummaryData > 必填

响应示例 · ApiResponse_list_CategorySummaryData__.

示例: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"is_visible":false,"name":"Example","number":"example","parent_id":null,"slug":"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"}

附加字段: 否

创建 — 分类 — 请求体

CategoryCreate · API 接收或返回的数据字段、类型和约束。
description字符串 null可选

所选语言的描述。

字符串:maxLength: 50000
introduction字符串 null可选

所选语言的介绍文本。

字符串:maxLength: 5000
is_visible布尔值可选

资源是否可见。

默认值: false
market_ids数组 <字符串> 可选

所选市场的标识符。

maxItems: 1000
数组:minLength: 1maxLength: 63
meta_description字符串 null可选

所选语言的搜索引擎描述。

字符串:maxLength: 160
meta_keywords数组 <字符串> null可选

所选语言的搜索引擎关键词。

数组:maxItems: 20
数组 / 数组:maxLength: 50
meta_title字符串 null可选

所选语言的搜索引擎标题。

字符串:maxLength: 70
name字符串必填

对应上下文中的资源名称。

minLength: 1maxLength: 200
示例: "Example"
parent_id字符串 null可选

父分类标识符。

字符串:minLength: 1maxLength: 63
slug字符串 null可选

所选语言的 URL 路径段。

字符串:maxLength: 160

附加字段: 否

获取 — 分类 — 响应

CategoryDetailData · API 接收或返回的数据字段、类型和约束。
created_at字符串必填

创建时间。

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

所选语言的描述。

示例: "example"
id字符串必填

资源标识符;请保留返回的原值。 (CategoryDetailData).

示例: "example"
introduction字符串 null必填

所选语言的介绍文本。

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

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

示例: true
is_visible布尔值必填

资源是否可见。

示例: false
meta_description字符串 null必填

所选语言的搜索引擎描述。

示例: "example"
meta_keywords数组 <字符串> null必填

所选语言的搜索引擎关键词。

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

所选语言的搜索引擎标题。

示例: "example"
name字符串 null必填

对应上下文中的资源名称。

示例: "Example"
number字符串必填

面向用户的订单号或申请编号。

示例: "example"
parent_id字符串 null必填

父分类标识符。

示例: null
slug字符串 null必填

所选语言的 URL 路径段。

示例: "example"
updated_at字符串必填

最近更新时间。

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

用于并发控制的资源版本。

示例: 1

附加字段: 否

获取列表 — 分类 — 响应

CategorySummaryData · API 接收或返回的数据字段、类型和约束。
created_at字符串必填

创建时间。

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

资源标识符;请保留返回的原值。 (CategorySummaryData).

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

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

示例: true
is_visible布尔值必填

资源是否可见。

示例: false
name字符串 null必填

对应上下文中的资源名称。

示例: "Example"
number字符串必填

面向用户的订单号或申请编号。

示例: "example"
parent_id字符串 null必填

父分类标识符。

示例: null
slug字符串 null必填

所选语言的 URL 路径段。

示例: "example"
updated_at字符串必填

最近更新时间。

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

用于并发控制的资源版本。

示例: 1

附加字段: 否

更新 — 分类 — 请求体

CategoryUpdate · API 接收或返回的数据字段、类型和约束。
description字符串 null可选

所选语言的描述。

字符串:maxLength: 50000
expected_version整数必填

写入前读取的版本;不匹配时拒绝更新。

minimum: 1maximum: 9223372036854775807
示例: 1
introduction字符串 null可选

所选语言的介绍文本。

字符串:maxLength: 5000
is_visible布尔值可选

资源是否可见。

market_ids数组 <字符串> 可选

所选市场的标识符。

maxItems: 1000
数组:minLength: 1maxLength: 63
meta_description字符串 null可选

所选语言的搜索引擎描述。

字符串:maxLength: 160
meta_keywords数组 <字符串> null可选

所选语言的搜索引擎关键词。

数组:maxItems: 20
数组 / 数组:maxLength: 50
meta_title字符串 null可选

所选语言的搜索引擎标题。

字符串:maxLength: 70
name字符串 null可选

对应上下文中的资源名称。

字符串:maxLength: 200
示例: "Example"
parent_id字符串 null可选

父分类标识符。

字符串:minLength: 1maxLength: 63
slug字符串 null可选

所选语言的 URL 路径段。

字符串:maxLength: 160

附加字段: 否