跳至內容
ShopentlyLearn
繁體中文

資料架構: 變體與選項

資料架構: 變體與選項. API 接收或傳回的資料欄位、類型和限制。

資料架構

取得清單 · 商品變體 — 變體與選項 — 回應

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

回應示例 · ApiResponse_list_ProductVariantData__.

示例: [{"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"example"}],"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_list_VariantOptionData__ · API 接收或傳回的資料欄位、類型和限制。
data陣列 <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > 必填

回應示例 · ApiResponse_list_VariantOptionData__.

示例: [{"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","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_list_VariantValueData__ · API 接收或傳回的資料欄位、類型和限制。
data陣列 <VariantValueData > 必填

回應示例 · ApiResponse_list_VariantValueData__.

示例: [{"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","updated_at":"2026-01-01T12:00:00Z","value":"example","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_ProductVariantData_ · API 接收或傳回的資料欄位、類型和限制。
dataProductVariantData 必填

回應示例 · ProductVariantData.

示例: {"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"example"}],"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta 必填

回應元資料。

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

附加欄位: 否

取得 · 選項 — 變體與選項 — 回應

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

回應示例 · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

示例: {"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta 必填

回應元資料。

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

附加欄位: 否

取得 · 選項值 — 變體與選項 — 回應

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

回應示例 · VariantValueData.

示例: {"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","updated_at":"2026-01-01T12:00:00Z","value":"example","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta 必填

回應元資料。

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

附加欄位: 否

取得 · 選項 — 變體與選項 — 回應

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · API 接收或傳回的資料欄位、類型和限制。
created_at字串必填

建立時間。

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

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

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

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

示例: "Example"
number字串必填

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

示例: "example"
position整數必填

在有序集合中的位置。

示例: 1
selection_type字串必填

允許的屬性值選擇模式。

約束
enum
["button", "dropdown"]
示例: "button"
updated_at字串必填

最近更新時間。

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

字典值的呈現方式。

約束
enum
["text", "color", "image"]
示例: "text"
version整數必填

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

示例: 1

附加欄位: 否

取得 · 商品變體 — 變體與選項 — 回應

ProductVariantData · API 接收或傳回的資料欄位、類型和限制。
active布林值必填

資源是否處於活動狀態。

示例: true
created_at字串必填

建立時間。

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

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

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

是否為預設選項。

示例: true
media_ids陣列 <字串> 必填

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

示例: ["example"]
position整數必填

在有序集合中的位置。

示例: 1
pricingVariantPricingData 必填

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

示例: {"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1}
primary_media_id字串 null必填

主要媒體資產識別碼。

示例: "example"
product_id字串必填

產品識別碼。

示例: "example"
sku字串必填

庫存單位代碼。

示例: "example"
updated_at字串必填

最近更新時間。

format: "date-time"
示例: "2026-01-01T12:00:00Z"
values陣列 <VariantChoiceData > 必填

字典值。

示例: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
version整數必填

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

示例: 1

附加欄位: 否

字典值

VariantChoiceData · 架構 · 資料架構: 變體與選項
option_id字串必填

變體選項識別碼。

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

變體選項名稱。

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

由所在架構描述的值。

示例: "example"
value_id字串必填

字典值識別碼。

示例: "example"

附加欄位: 否

建立 · 商品變體 — 變體與選項 — 請求本文

VariantCreate · API 接收或傳回的資料欄位、類型和限制。
active布林值選填

資源是否處於活動狀態。

預設值: true
expected_version整數必填

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

minimum: 1maximum: 9223372036854775807
示例: 1
is_default布林值選填

是否為預設選項。

media_ids陣列 <字串> 選填

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

maxItems: 20
陣列:minLength: 1maxLength: 63
pricingVariantPrice 選填

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

sku字串選填

庫存單位代碼。

minLength: 1maxLength: 100
約束
pattern
"^\\S+$"
value_ids陣列 <字串> 必填

字典值的識別碼。

minItems: 1maxItems: 250
陣列:minLength: 1maxLength: 63
示例: ["example"]

附加欄位: 否

建立 · 選項 — 變體與選項 — 請求本文

VariantOptionCreate · API 接收或傳回的資料欄位、類型和限制。
name字串必填

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

minLength: 1maxLength: 120
約束
pattern
"^[^\\x00]*$"
示例: "Example"
selection_type字串選填

允許的屬性值選擇模式。

約束
enum
["button", "dropdown"]
預設值: "button"
value_presentation_type字串選填

字典值的呈現方式。

約束
enum
["text", "color", "image"]
預設值: "text"

附加欄位: 否

更新 · 選項 — 變體與選項 — 請求本文

VariantOptionUpdate · API 接收或傳回的資料欄位、類型和限制。
expected_version整數必填

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

minimum: 1maximum: 9223372036854775807
示例: 1
name字串 null選填

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

字串:minLength: 1maxLength: 120
約束 · 字串 1
pattern
"^[^\\x00]*$"
示例: "Example"
selection_type字串選填

允許的屬性值選擇模式。

約束
enum
["button", "dropdown"]
value_presentation_type字串選填

字典值的呈現方式。

約束
enum
["text", "color", "image"]

附加欄位: 否

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

VariantPrice · 架構 · 資料架構: 變體與選項
amount字串 null必填

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

字串:maxLength: 20
約束 · 字串 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_product_version整數必填

本次寫入要求的、此前讀取的產品版本。

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

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

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

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

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

價格表識別碼。

minLength: 1maxLength: 63
示例: "example"

附加欄位: 否

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

VariantPricingData · 架構 · 資料架構: 變體與選項
base_adjustmentMoneyData 必填

相對於基準價格的調整。

示例: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData null必填

所選市場的價格。

示例: null
pricePriceData null必填

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

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

用於並行控制的目前產品版本。

示例: 1
version整數必填

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

示例: 1

附加欄位: 否

更新 · 商品變體 — 變體與選項 — 請求本文

VariantUpdate · API 接收或傳回的資料欄位、類型和限制。
active布林值選填

資源是否處於活動狀態。

expected_version整數必填

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

minimum: 1maximum: 9223372036854775807
示例: 1
is_default布林值選填

是否為預設選項。

media_ids陣列 <字串> 選填

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

maxItems: 20
陣列:minLength: 1maxLength: 63
pricingVariantPrice 選填

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

示例: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_product_version":1,"expected_version":0,"kind":"base_adjustment","price_list_id":"example"}
sku字串選填

庫存單位代碼。

minLength: 1maxLength: 100
約束
pattern
"^\\S+$"
示例: "example"

附加欄位: 否

建立 · 選項值 — 變體與選項 — 請求本文

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

以十六進位代碼表示的顏色。

約束 · 字串 1
pattern
"^#[0-9A-Fa-f]{6}$"
expected_version整數必填

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

minimum: 1maximum: 9223372036854775807
示例: 1
value字串必填

由所在架構描述的值。

minLength: 1maxLength: 180
約束
pattern
"^[^\\x00]*$"
示例: "Example"

附加欄位: 否

取得 · 選項值 — 變體與選項 — 回應

VariantValueData · API 接收或傳回的資料欄位、類型和限制。
color_hex字串 null必填

以十六進位代碼表示的顏色。

示例: "#008855"
created_at字串必填

建立時間。

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

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

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

所選圖片資產的識別碼。

示例: null
number字串必填

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

示例: "example"
option_id字串必填

變體選項識別碼。

示例: "example"
position整數必填

在有序集合中的位置。

示例: 1
sku_code字串必填

庫存單位代碼。

示例: "example"
updated_at字串必填

最近更新時間。

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

由所在架構描述的值。

示例: "example"
version整數必填

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

示例: 1

附加欄位: 否

更新 · 選項值 — 變體與選項 — 請求本文

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

以十六進位代碼表示的顏色。

約束 · 字串 1
pattern
"^#[0-9A-Fa-f]{6}$"
expected_version整數必填

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

minimum: 1maximum: 9223372036854775807
示例: 1
value字串 null選填

由所在架構描述的值。

字串:minLength: 1maxLength: 180
約束 · 字串 1
pattern
"^[^\\x00]*$"
示例: "Example"

附加欄位: 否