数据架构
获取 — 分类 — 响应
ApiResponse_CategoryDetailData_ · API 接收或返回的数据字段、类型和约束。
dataCategoryDetailData必填响应示例 · CategoryDetailData.
metaContextPageMetaContextMetaPageMetaRequestMeta必填响应元数据。
附加字段: 否
获取列表 — 分类 — 响应
ApiResponse_list_CategorySummaryData__ · API 接收或返回的数据字段、类型和约束。
data数组 <CategorySummaryData> 必填响应示例 · ApiResponse_list_CategorySummaryData__.
metaContextPageMetaContextMetaPageMetaRequestMeta必填响应元数据。
附加字段: 否
创建 — 分类 — 请求体
CategoryCreate · API 接收或返回的数据字段、类型和约束。
description字符串 null可选所选语言的描述。
字符串:maxLength:50000introduction字符串 null可选所选语言的介绍文本。
字符串:maxLength:5000is_visible布尔值可选资源是否可见。
market_ids数组 <字符串> 可选所选市场的标识符。
maxItems:1000数组:minLength:1maxLength:63meta_description字符串 null可选所选语言的搜索引擎描述。
字符串:maxLength:160meta_keywords数组 <字符串> null可选所选语言的搜索引擎关键词。
数组:maxItems:20数组 / 数组:maxLength:50meta_title字符串 null可选所选语言的搜索引擎标题。
字符串:maxLength:70name字符串必填对应上下文中的资源名称。
minLength:1maxLength:200parent_id字符串 null可选父分类标识符。
字符串:minLength:1maxLength:63slug字符串 null可选所选语言的 URL 路径段。
字符串:maxLength:160
附加字段: 否
获取 — 分类 — 响应
CategoryDetailData · API 接收或返回的数据字段、类型和约束。
created_at字符串必填创建时间。
format:"date-time"description字符串 null必填所选语言的描述。
id字符串必填资源标识符;请保留返回的原值。 (CategoryDetailData).
introduction字符串 null必填所选语言的介绍文本。
is_available布尔值必填此项目在当前上下文中是否可用。
is_visible布尔值必填资源是否可见。
meta_description字符串 null必填所选语言的搜索引擎描述。
meta_keywords数组 <字符串> null必填所选语言的搜索引擎关键词。
meta_title字符串 null必填所选语言的搜索引擎标题。
name字符串 null必填对应上下文中的资源名称。
number字符串必填面向用户的订单号或申请编号。
parent_id字符串 null必填父分类标识符。
slug字符串 null必填所选语言的 URL 路径段。
updated_at字符串必填最近更新时间。
format:"date-time"version整数必填用于并发控制的资源版本。
附加字段: 否
获取列表 — 分类 — 响应
CategorySummaryData · API 接收或返回的数据字段、类型和约束。
created_at字符串必填创建时间。
format:"date-time"id字符串必填资源标识符;请保留返回的原值。 (CategorySummaryData).
is_available布尔值必填此项目在当前上下文中是否可用。
is_visible布尔值必填资源是否可见。
name字符串 null必填对应上下文中的资源名称。
number字符串必填面向用户的订单号或申请编号。
parent_id字符串 null必填父分类标识符。
slug字符串 null必填所选语言的 URL 路径段。
updated_at字符串必填最近更新时间。
format:"date-time"version整数必填用于并发控制的资源版本。
附加字段: 否
更新 — 分类 — 请求体
CategoryUpdate · API 接收或返回的数据字段、类型和约束。
description字符串 null可选所选语言的描述。
字符串:maxLength:50000expected_version整数必填写入前读取的版本;不匹配时拒绝更新。
minimum:1maximum:9223372036854775807introduction字符串 null可选所选语言的介绍文本。
字符串:maxLength:5000is_visible布尔值可选资源是否可见。
market_ids数组 <字符串> 可选所选市场的标识符。
maxItems:1000数组:minLength:1maxLength:63meta_description字符串 null可选所选语言的搜索引擎描述。
字符串:maxLength:160meta_keywords数组 <字符串> null可选所选语言的搜索引擎关键词。
数组:maxItems:20数组 / 数组:maxLength:50meta_title字符串 null可选所选语言的搜索引擎标题。
字符串:maxLength:70name字符串 null可选对应上下文中的资源名称。
字符串:maxLength:200parent_id字符串 null可选父分类标识符。
字符串:minLength:1maxLength:63slug字符串 null可选所选语言的 URL 路径段。
字符串:maxLength:160
附加字段: 否