跳至内容
ShopentlyLearn

数据架构: 产品

数据架构: 产品. API 接收或返回的数据字段、类型和约束。

数据架构

ApiResponse_ProductFileListData_

ApiResponse_ProductFileListData_ · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
dataProductFileListData 必填

成功响应的数据。

示例: {"files":[{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}],"product_version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta 必填

响应元数据。

示例: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

附加字段: 否

ApiResponse_ReleaseListData_

ApiResponse_ReleaseListData_ · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
dataReleaseListData 必填

成功响应的数据。

示例: {"current_release_id":"00000000-0000-4000-8000-000000000001","product_version":2,"releases":[{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}],"update_days":365,"update_mode":"period","update_months":null}
metaContextPageMeta ContextMeta PageMeta RequestMeta 必填

响应元数据。

示例: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example"}

附加字段: 否

ApiResponse_UploadData_

ApiResponse_UploadData_ · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
dataUploadData 必填

成功响应的数据。

示例: {"category":"digital","expires_at":"2026-01-01T12:00:00Z","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","product_id":"example","received_bytes":46,"sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta 必填

响应元数据。

示例: {"request_id":"example"}

附加字段: 否

ApiResponse[AudienceData]

ApiResponse_AudienceData_ · 读取访问规则和商品版本。首次发布时间保持不变。
dataAudienceData 必填

成功响应的数据。

示例: {"anchor_at":"2026-11-03T12:00:00Z","effective_at":"2026-11-03T12:00:00Z","file_id":"00000000-0000-4000-8000-000000000007","file_version_id":"00000000-0000-4000-8000-000000000010","historical_access_preserved":true,"id":"00000000-0000-4000-8000-000000000009","lookback_days":null,"mode":"all_purchasers","next_cursor":null,"order_ids":[],"product_version":3,"revision":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta 必填

响应元数据。

示例: {"request_id":"example-request"}

附加字段: 否

获取列表 — 产品 — 响应

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

附加字段: 否

AudienceChange

AudienceChange · 选择符合条件的购买。所选订单必须包含已付款且未退款的此商品。
audienceAudienceSelection 必填

共享销售文件的明确访问规则。

示例: {"mode":"all_purchasers"}
expected_version整数必填

写入前读取的版本;不匹配时拒绝更新。

minimum: 1maximum: 9223372036854775807
示例: 1

附加字段: 否

AudienceData

AudienceData · 读取访问规则和商品版本。首次发布时间保持不变。
anchor_at字符串必填

首次发布时间,修改规则不会重置此时间。

format: "date-time"
示例: "2026-11-03T12:00:00Z"
effective_at字符串必填

此访问规则的发布时间。

format: "date-time"
示例: "2026-11-03T12:00:00Z"
file_id字符串必填

资源标识符;请保留返回的原值。 · file_id

示例: "00000000-0000-4000-8000-000000000007"
file_version_id字符串必填

不可变文件版本的ID。

示例: "00000000-0000-4000-8000-000000000010"
historical_access_preserved布尔值可选

缩小规则范围时,已授予的访问权限仍保留。

默认值: true示例: true
id字符串必填

资源标识符;请保留返回的原值。

示例: "00000000-0000-4000-8000-000000000009"
lookback_days整数 null必填

首次发布前1–3650天,仅用于recent_and_new。

示例: null
mode字符串必填

共享销售文件的明确访问规则。 new_purchases / recent_and_new / selected / all_purchasers.

示例: "all_purchasers"
next_cursor字符串 null必填

下一页续页值,或 null。

示例: null
order_ids数组 <字符串> 必填

包含此商品已付款且未退款购买的订单。

示例: []
product_version整数必填

用于并发控制的当前产品版本。

示例: 3
revision整数必填

访问规则的连续修订号。

示例: 1

附加字段: 否

AudienceSelection

AudienceSelection · 选择符合条件的购买。所选订单必须包含已付款且未退款的此商品。
lookback_days整数 null可选

首次发布前1–3650天,仅用于recent_and_new。

整数:minimum: 1maximum: 3650
mode字符串必填

共享销售文件的明确访问规则。 new_purchases / recent_and_new / selected / all_purchasers.

约束
enum
["new_purchases", "recent_and_new", "selected", "all_purchasers"]
示例: "new_purchases"
order_ids数组 <字符串> 可选

包含此商品已付款且未退款购买的订单。

maxItems: 1000
约束 · 数组 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
默认值: []

附加字段: 否

所选上下文中的可用性信息

AvailabilityData · 架构 · 数据架构: 产品
available_from字符串 null必填

开始可用的时间。

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

结束可用的时间。

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

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

示例: true

附加字段: 否

FileAssign

FileAssign · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
audienceAudienceSelection null可选

共享销售文件的明确访问规则。

示例: {"mode":"new_purchases"}
expected_version整数必填

写入前读取的版本;不匹配时拒绝更新。

minimum: 1maximum: 9223372036854775807
示例: 1
label字符串可选

对应上下文中的资源名称。

maxLength: 300
默认值: ""
upload_id字符串必填

资源标识符;请保留返回的原值。 · upload_id

format: "uuid"
示例: "00000000-0000-4000-8000-000000000001"

附加字段: 否

FileCategory

FileCategory · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
字符串
约束
enum
["internal", "customer_document", "digital"]

附加字段: 是

所选上下文中的价格信息

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: 30
数组: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

附加字段: 否

ProductFileData

ProductFileData · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
categoryFileCategory 必填

文件类别: internal / customer_document / digital

示例: "digital"
created_at字符串必填

创建时间。

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

资源标识符;请保留返回的原值。 · current_version_id

format: "uuid"
示例: "00000000-0000-4000-8000-000000000001"
file_id字符串必填

资源标识符;请保留返回的原值。 · file_id

format: "uuid"
示例: "00000000-0000-4000-8000-000000000001"
filename字符串必填

文件

示例: "manual.pdf"
id字符串必填

资源标识符;请保留返回的原值。

format: "uuid"
示例: "00000000-0000-4000-8000-000000000001"
label字符串必填

对应上下文中的资源名称。

示例: "Manual"
mime_type字符串必填

媒体内容类型。

示例: "application/pdf"
sha256字符串必填

SHA-256 (hex, 64)

示例: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytes整数必填

大小(字节)

示例: 46
state字符串必填

状态

示例: "active"
version_number整数必填

版本

示例: 1

附加字段: 否

ProductFileListData

ProductFileListData · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
files数组 <ProductFileData > 必填

商品文件

示例: [{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}]
product_version整数必填

用于并发控制的当前产品版本。

示例: 2

附加字段: 否

产品识别代码

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: 30
数组:minLength: 1maxLength: 63
meta_description字符串 null可选

所选语言的搜索引擎描述。

字符串:maxLength: 160
meta_keywords数组 <字符串> null可选

所选语言的搜索引擎关键词。

数组:maxItems: 20
数组 / 数组:maxLength: 50
meta_title字符串 null可选

所选语言的搜索引擎标题。

字符串:maxLength: 70
name字符串 null可选

对应上下文中的资源名称。

字符串:maxLength: 300
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布尔值可选

产品是否使用变体。

附加字段: 否

ProductVersion

ProductVersion · 此操作已停用,返回409且不会修改数据。请通过接收对象选择,为每个数字文件单独设置访问权限。
expected_version整数必填

写入前读取的版本;不匹配时拒绝更新。

minimum: 1maximum: 9223372036854775807
示例: 1

附加字段: 否

ReleaseData

ReleaseData · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
changelog字符串必填

更新说明

示例: "Manual update"
files数组 <ReleaseFileData > 必填

商品文件

示例: [{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}]
id字符串必填

资源标识符;请保留返回的原值。

format: "uuid"
示例: "00000000-0000-4000-8000-000000000001"
manifest_sha256字符串 null必填

数字版本 · SHA-256

示例: "1111111111111111111111111111111111111111111111111111111111111111"
published_at字符串 null必填

发布版本 · UTC

字符串:format: "date-time"
示例: null
release_sequence整数 null必填

数字版本 · 在有序集合中的位置。

示例: null
state字符串必填

状态

示例: "active"
version_label字符串必填

版本

示例: "1.0"
withdrawn_at字符串 null必填

撤回销售 · UTC

字符串:format: "date-time"
示例: null

附加字段: 否

ReleaseDraft

ReleaseDraft · 此操作已停用,返回409且不会修改数据。请通过接收对象选择,为每个数字文件单独设置访问权限。
changelog字符串可选

更新说明

maxLength: 20000
默认值: ""
expected_version整数必填

写入前读取的版本;不匹配时拒绝更新。

minimum: 1maximum: 9223372036854775807
示例: 1
version_ids数组 <字符串> 必填

版本 · UUID[]

minItems: 1maxItems: 20
数组:format: "uuid"
示例: ["00000000-0000-4000-8000-000000000001"]
version_label字符串必填

版本

minLength: 1maxLength: 64
示例: "1.0"

附加字段: 否

ReleaseFileData

ReleaseFileData · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
file_id字符串必填

资源标识符;请保留返回的原值。 · file_id

format: "uuid"
示例: "00000000-0000-4000-8000-000000000001"
sort_order整数必填

在有序集合中的位置。

示例: 0
version_id字符串必填

资源标识符;请保留返回的原值。 · version_id

format: "uuid"
示例: "00000000-0000-4000-8000-000000000001"

附加字段: 否

ReleaseListData

ReleaseListData · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
current_release_id字符串 null必填

资源标识符;请保留返回的原值。 · current_release_id

字符串:format: "uuid"
示例: "00000000-0000-4000-8000-000000000001"
product_version整数必填

用于并发控制的当前产品版本。

示例: 2
releases数组 <ReleaseData > 必填

数字版本

示例: [{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}]
update_days整数 null必填

天数 (days; null)

示例: 365
update_mode字符串必填

购买后对未来文件的访问权限: none / period / unlimited

示例: "period"
update_months整数 null必填

月数 (months; null)

示例: null

附加字段: 否

UpdatePolicy

UpdatePolicy · 此操作已停用,返回409且不会修改数据。请通过接收对象选择,为每个数字文件单独设置访问权限。
days整数 null可选

天数 (1–3650; mode=period; months=null)

整数:minimum: 1maximum: 3650
示例: 365
expected_version整数必填

写入前读取的版本;不匹配时拒绝更新。

minimum: 1maximum: 9223372036854775807
示例: 1
mode字符串必填

购买后对未来文件的访问权限: none / period / unlimited

约束
enum
["none", "period", "unlimited"]
示例: "period"
months整数 null可选

月数 (1–120; mode=period; days=null)

整数:minimum: 1maximum: 120
示例: null

附加字段: 否

UploadCreate

UploadCreate · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
filename字符串必填

文件

minLength: 1maxLength: 255
示例: "manual.pdf"
product_id字符串 null可选

产品标识符。

约束 · 字符串 1
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
示例: "example"
sha256字符串必填

SHA-256 (hex, 64)

约束
pattern
"^[0-9a-f]{64}$"
示例: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytes整数必填

大小(字节)

minimum: 1maximum: 262144000
示例: 46

附加字段: 否

UploadData

UploadData · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
categoryFileCategory 必填

文件类别: internal / customer_document / digital

示例: "digital"
expires_at字符串必填

凭据到期的日期和时间。

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

文件

示例: "manual.pdf"
id字符串必填

资源标识符;请保留返回的原值。

format: "uuid"
示例: "00000000-0000-4000-8000-000000000001"
product_id字符串 null必填

产品标识符。

示例: "example"
received_bytes整数必填

正在上传… · 大小(字节)

示例: 46
sha256字符串必填

SHA-256 (hex, 64)

示例: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytes整数必填

大小(字节)

示例: 46
status字符串必填

此操作接受的状态。

示例: "ready"

附加字段: 否