跳至内容
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"

附加字段: 否