跳至內容
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

附加欄位: 否