数据架构: 产品

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"}

附加字段: 否

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"}

附加字段: 否

available_from字符串 | null必填

开始可用的时间。

字符串:format: "date-time"

示例: null

available_until字符串 | null必填

结束可用的时间。

字符串:format: "date-time"

示例: null

is_available布尔值必填

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

示例: true

附加字段: 否

amount字符串必填

以 JSON 字符串编码的十进制金额；仅在允许时使用 null。

示例: "0.00"

currency字符串必填

金额的币种代码。

约束

pattern

"^[A-Z]{3}$"

示例: "PLN"

minor_units整数必填

币种使用的小数位数。

minimum: 0maximum: 4

示例: 2

tax_included布尔值必填

提交的价格是否含税。

示例: true

附加字段: 否

currency字符串必填

金额的币种代码。

id字符串必填

资源标识符；请保留返回的原值。 (PriceListData).

tax_included布尔值必填

提交的价格是否含税。

version整数必填

用于并发控制的资源版本。

附加字段: 否

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

附加字段: 否

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

附加字段: 否

ean字符串 | null可选

产品 EAN 标识符。

字符串:minLength: 1maxLength: 100

isbn字符串 | null可选

ISBN 标识符。

字符串:minLength: 1maxLength: 100

mpn字符串 | null可选

制造商零件编号。

字符串:minLength: 1maxLength: 100

upc字符串 | null可选

产品 UPC 标识符。

字符串:minLength: 1maxLength: 100

附加字段: 否

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"

附加字段: 否

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

附加字段: 否

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

附加字段: 否

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布尔值可选

产品是否使用变体。

附加字段: 否