資料架構
取得 — 分類 — 回應
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
附加欄位: 否