跳至內容
ShopentlyLearn
繁體中文

資料架構: 產品

資料架構: 產品. API 接收或傳回的資料欄位、類型和限制。

資料架構

取得清單 — 產品 — 回應

ApiResponse_list_ProductSummaryData__ · API 接收或傳回的資料欄位、類型和限制。
data陣列 <ProductSummaryData > 必填

回應示例 · ApiResponse_list_ProductSummaryData__.

示例: [{"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"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"}

附加欄位: 否

取得 — 產品 — 回應

ApiResponse_ProductDetailData_ · API 接收或傳回的資料欄位、類型和限制。
dataProductDetailData 必填

回應示例 · ProductDetailData.

示例: {"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","description":"example","features":[{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}],"id":"example","identifiers":{},"media":[{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}],"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta 必填

回應元資料。

示例: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

附加欄位: 否

所選上下文中的可用性資訊

AvailabilityData · 架構 · 資料架構: 產品
available_from字串 null必填

開始可用的時間。

字串:format: "date-time"
示例: null
available_until字串 null必填

結束可用的時間。

字串:format: "date-time"
示例: null
is_available布林值必填

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

示例: true

附加欄位: 否

所選上下文中的價格資訊

PriceData · 架構 · 資料架構: 產品
amount字串必填

以 JSON 字串編碼的十進位金額；僅在允許時使用 null。

示例: "0.00"
currency字串必填

金額的幣種代碼。

約束
pattern
"^[A-Z]{3}$"
示例: "PLN"
minor_units整數必填

幣種使用的小數位數。

minimum: 0maximum: 4
示例: 2
tax_included布林值必填

提交的價格是否含稅。

示例: true

附加欄位: 否

價格表資訊

PriceListData · 架構 · 資料架構: 產品
currency字串必填

金額的幣種代碼。

id字串必填

資源識別碼；請保留回傳的原值。 (PriceListData).

tax_included布林值必填

提交的價格是否含稅。

version整數必填

用於並行控制的資源版本。

附加欄位: 否

建立 — 產品 — 請求本文

ProductCreate · API 接收或傳回的資料欄位、類型和限制。
brand_id字串 null選填

品牌識別碼。

字串:minLength: 1maxLength: 63
condition字串選填

產品狀況。

約束
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
預設值: "new"
description字串 null選填

所選語言的描述。

字串:maxLength: 100000
feature_value_ids陣列 <字串> 選填

所選屬性值的識別碼。

maxItems: 1000
陣列:minLength: 1maxLength: 63
identifiersProductIdentifiers null選填

產品識別代碼。

market_ids陣列 <字串> 選填

所選市場的識別碼。

maxItems: 1000
陣列:minLength: 1maxLength: 63
media_ids陣列 <字串> 選填

已存在媒體資產的識別碼。

maxItems: 20
陣列:minLength: 1maxLength: 63
meta_description字串 null選填

所選語言的搜尋引擎描述。

字串:maxLength: 160
meta_keywords陣列 <字串> null選填

所選語言的搜尋引擎關鍵詞。

陣列:maxItems: 20
陣列 / 陣列:maxLength: 50
meta_title字串 null選填

所選語言的搜尋引擎標題。

字串:maxLength: 70
name字串必填

對應上下文中的資源名稱。

minLength: 1maxLength: 300
示例: "Example"
pricingProductPrice 選填

價格配置及其並行控制版本。

primary_category_id字串 null選填

主要分類識別碼。

字串:minLength: 1maxLength: 63
published布林值選填

資源是否已發佈。

預設值: false
sku字串必填

庫存單位代碼。

minLength: 1maxLength: 100
約束
pattern
"^\\S+$"
示例: "example"
slug字串 null選填

所選語言的 URL 路徑段。

字串:maxLength: 160
tax_category_id字串 null選填

稅務類別識別碼。

字串:minLength: 1maxLength: 63
variant_value_ids陣列 <字串> 選填

所選變體值的識別碼。

maxItems: 250
陣列:minLength: 1maxLength: 63
variants_enabled布林值選填

產品是否使用變體。

預設值: false

附加欄位: 否

取得 — 產品 — 回應

ProductDetailData · API 接收或傳回的資料欄位、類型和限制。
availabilityAvailabilityData 必填

所選上下文中的可用性資訊。

示例: {"available_from":null,"available_until":null,"is_available":true}
brand_id字串 null必填

品牌識別碼。

示例: null
condition字串必填

產品狀況。

約束
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
示例: "new"
created_at字串必填

建立時間。

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

所選語言的描述。

示例: "example"
features陣列 <FeatureSelectionData > 必填

產品屬性。

示例: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]
id字串必填

資源識別碼；請保留回傳的原值。 (ProductDetailData).

示例: "example"
identifiers物件附加欄位: 字串必填

產品識別代碼。

示例: {}
media陣列 <ProductMediaData > 必填

附加媒體資訊。

示例: [{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]
meta_description字串 null必填

所選語言的搜尋引擎描述。

示例: "example"
meta_keywords陣列 <字串> null必填

所選語言的搜尋引擎關鍵詞。

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

所選語言的搜尋引擎標題。

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

對應上下文中的資源名稱。

示例: "Example"
number字串必填

面向使用者的訂單號或申請編號。

示例: "example"
pricePriceData null必填

所選上下文中的價格資訊。

示例: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_version整數必填

用於並行控制的目前價格版本。

示例: 1
primary_category_id字串 null必填

主要分類識別碼。

示例: "example"
primary_media_id字串 null必填

主要媒體資產識別碼。

示例: "example"
published布林值必填

資源是否已發佈。

示例: false
sku字串必填

庫存單位代碼。

示例: "example"
slug字串 null必填

所選語言的 URL 路徑段。

示例: "example"
tax_category_id字串必填

稅務類別識別碼。

示例: "example"
updated_at字串必填

最近更新時間。

format: "date-time"
示例: "2026-01-01T12:00:00Z"
variants_enabled布林值必填

產品是否使用變體。

示例: false
version整數必填

用於並行控制的資源版本。

示例: 1

附加欄位: 否

產品識別代碼

ProductIdentifiers · 架構 · 資料架構: 產品
ean字串 null選填

產品 EAN 識別碼。

字串:minLength: 1maxLength: 100
isbn字串 null選填

ISBN 識別碼。

字串:minLength: 1maxLength: 100
mpn字串 null選填

製造商零件編號。

字串:minLength: 1maxLength: 100
upc字串 null選填

產品 UPC 識別碼。

字串:minLength: 1maxLength: 100

附加欄位: 否

附加媒體資訊

ProductMediaData · 架構 · 資料架構: 產品
alt_text字串 null必填

圖片替代文本。

示例: "example"
id字串必填

資源識別碼；請保留回傳的原值。 (ProductMediaData).

示例: "example"
is_primary布林值必填

是否為主要項目。

示例: true
kind字串必填

由允許值說明的資料結構變體。

約束
enum
["image", "video", "model_3d"]
示例: "image"
mime_type字串必填

媒體內容類型。

示例: "image/jpeg"
position整數必填

在有序集合中的位置。

示例: 1
url字串 null必填

資源 URL。

示例: "https://example.invalid/product.jpg"

附加欄位: 否

價格配置及其並行控制版本

ProductPrice · 架構 · 資料架構: 產品
amount字串 null必填

以 JSON 字串編碼的十進位金額；僅在允許時使用 null。

字串:maxLength: 19
約束 · 字串 1
pattern
"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
示例: "0.00"
currency字串必填

金額的幣種代碼。

約束
pattern
"^[A-Z]{3}$"
示例: "PLN"
expected_price_list_version整數必填

本次寫入要求的、此前讀取的價格表版本。

minimum: 1maximum: 9223372036854775807
示例: 1
expected_version整數必填

寫入前讀取的版本；不匹配時拒絕更新。

minimum: 0maximum: 9223372036854775807
示例: 0
kind字串必填

由允許值說明的資料結構變體。

約束
enum
["base", "market_fixed"]
示例: "base"
price_list_id字串必填

價格表識別碼。

minLength: 1maxLength: 63
示例: "example"
tax_included布林值必填

提交的價格是否含稅。

示例: true

附加欄位: 否

取得清單 — 產品 — 回應

ProductSummaryData · API 接收或傳回的資料欄位、類型和限制。
availabilityAvailabilityData 必填

所選上下文中的可用性資訊。

示例: {"available_from":null,"available_until":null,"is_available":true}
brand_id字串 null必填

品牌識別碼。

示例: null
condition字串必填

產品狀況。

約束
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
示例: "new"
created_at字串必填

建立時間。

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

資源識別碼；請保留回傳的原值。 (ProductSummaryData).

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

對應上下文中的資源名稱。

示例: "Example"
number字串必填

面向使用者的訂單號或申請編號。

示例: "example"
pricePriceData null必填

所選上下文中的價格資訊。

示例: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
price_version整數必填

用於並行控制的目前價格版本。

示例: 1
primary_category_id字串 null必填

主要分類識別碼。

示例: "example"
primary_media_id字串 null必填

主要媒體資產識別碼。

示例: "example"
published布林值必填

資源是否已發佈。

示例: false
sku字串必填

庫存單位代碼。

示例: "example"
slug字串 null必填

所選語言的 URL 路徑段。

示例: "example"
tax_category_id字串必填

稅務類別識別碼。

示例: "example"
updated_at字串必填

最近更新時間。

format: "date-time"
示例: "2026-01-01T12:00:00Z"
variants_enabled布林值必填

產品是否使用變體。

示例: false
version整數必填

用於並行控制的資源版本。

示例: 1

附加欄位: 否

更新 — 產品 — 請求本文

ProductUpdate · API 接收或傳回的資料欄位、類型和限制。
brand_id字串 null選填

品牌識別碼。

字串:minLength: 1maxLength: 63
condition字串選填

產品狀況。

約束
enum
["new", "refurbished", "used", "returned", "display", "damaged"]
description字串 null選填

所選語言的描述。

字串:maxLength: 100000
示例: null
expected_variant_price_versions物件附加欄位: 整數
minimum: 0maximum: 9223372036854775807
選填

此前讀取的價格版本，以變體識別碼為鍵。

maxProperties: 250
約束
propertyNames
{"maxLength": 63, "minLength": 1}
expected_version整數必填

寫入前讀取的版本；不匹配時拒絕更新。

minimum: 1maximum: 9223372036854775807
示例: 1
feature_value_ids陣列 <字串> 選填

所選屬性值的識別碼。

maxItems: 1000
陣列:minLength: 1maxLength: 63
identifiersProductIdentifiers null選填

產品識別代碼。

market_ids陣列 <字串> 選填

所選市場的識別碼。

maxItems: 1000
陣列:minLength: 1maxLength: 63
media_ids陣列 <字串> 選填

已存在媒體資產的識別碼。

maxItems: 20
陣列:minLength: 1maxLength: 63
meta_description字串 null選填

所選語言的搜尋引擎描述。

字串:maxLength: 160
meta_keywords陣列 <字串> null選填

所選語言的搜尋引擎關鍵詞。

陣列:maxItems: 20
陣列 / 陣列:maxLength: 50
meta_title字串 null選填

所選語言的搜尋引擎標題。

字串:maxLength: 70
name字串 null選填

對應上下文中的資源名稱。

字串:maxLength: 300
示例: null
pricingProductPrice 選填

價格配置及其並行控制版本。

示例: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}
primary_category_id字串 null選填

主要分類識別碼。

字串:minLength: 1maxLength: 63
published布林值選填

資源是否已發佈。

sku字串選填

庫存單位代碼。

minLength: 1maxLength: 100
約束
pattern
"^\\S+$"
示例: "example"
slug字串 null選填

所選語言的 URL 路徑段。

字串:maxLength: 160
tax_category_id字串 null選填

稅務類別識別碼。

字串:minLength: 1maxLength: 63
variant_value_ids陣列 <字串> 選填

所選變體值的識別碼。

maxItems: 250
陣列:minLength: 1maxLength: 63
variants_enabled布林值選填

產品是否使用變體。

附加欄位: 否