数据架构
ApiResponse_ProductFileListData_
ApiResponse_ProductFileListData_ · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
dataProductFileListData必填成功响应的数据。
metaContextPageMetaContextMetaPageMetaRequestMeta必填响应元数据。
附加字段: 否
ApiResponse_ReleaseListData_
ApiResponse_ReleaseListData_ · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
dataReleaseListData必填成功响应的数据。
metaContextPageMetaContextMetaPageMetaRequestMeta必填响应元数据。
附加字段: 否
ApiResponse_UploadData_
ApiResponse_UploadData_ · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
dataUploadData必填成功响应的数据。
metaContextPageMetaContextMetaPageMetaRequestMeta必填响应元数据。
附加字段: 否
ApiResponse[AudienceData]
ApiResponse_AudienceData_ · 读取访问规则和商品版本。首次发布时间保持不变。
dataAudienceData必填成功响应的数据。
metaContextPageMetaContextMetaPageMetaRequestMeta必填响应元数据。
附加字段: 否
获取列表 — 产品 — 响应
ApiResponse_list_ProductSummaryData__ · API 接收或返回的数据字段、类型和约束。
data数组 <ProductSummaryData> 必填响应示例 · ApiResponse_list_ProductSummaryData__.
metaContextPageMetaContextMetaPageMetaRequestMeta必填响应元数据。
附加字段: 否
获取 — 产品 — 响应
ApiResponse_ProductDetailData_ · API 接收或返回的数据字段、类型和约束。
dataProductDetailData必填响应示例 · ProductDetailData.
metaContextPageMetaContextMetaPageMetaRequestMeta必填响应元数据。
附加字段: 否
AudienceChange
AudienceChange · 选择符合条件的购买。所选订单必须包含已付款且未退款的此商品。
audienceAudienceSelection必填共享销售文件的明确访问规则。
expected_version整数必填写入前读取的版本;不匹配时拒绝更新。
minimum:1maximum:9223372036854775807
附加字段: 否
AudienceData
AudienceData · 读取访问规则和商品版本。首次发布时间保持不变。
anchor_at字符串必填首次发布时间,修改规则不会重置此时间。
format:"date-time"effective_at字符串必填此访问规则的发布时间。
format:"date-time"file_id字符串必填资源标识符;请保留返回的原值。 · file_id
file_version_id字符串必填不可变文件版本的ID。
historical_access_preserved布尔值可选缩小规则范围时,已授予的访问权限仍保留。
id字符串必填资源标识符;请保留返回的原值。
lookback_days整数 null必填首次发布前1–3650天,仅用于recent_and_new。
mode字符串必填共享销售文件的明确访问规则。 new_purchases / recent_and_new / selected / all_purchasers.
next_cursor字符串 null必填下一页续页值,或 null。
order_ids数组 <字符串> 必填包含此商品已付款且未退款购买的订单。
product_version整数必填用于并发控制的当前产品版本。
revision整数必填访问规则的连续修订号。
附加字段: 否
AudienceSelection
AudienceSelection · 选择符合条件的购买。所选订单必须包含已付款且未退款的此商品。
lookback_days整数 null可选首次发布前1–3650天,仅用于recent_and_new。
整数:minimum:1maximum:3650mode字符串必填共享销售文件的明确访问规则。 new_purchases / recent_and_new / selected / all_purchasers.
约束
enum["new_purchases", "recent_and_new", "selected", "all_purchasers"]
order_ids数组 <字符串> 可选包含此商品已付款且未退款购买的订单。
maxItems:1000约束 · 数组 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
附加字段: 否
所选上下文中的可用性信息
AvailabilityData · 架构 · 数据架构: 产品
available_from字符串 null必填开始可用的时间。
字符串:format:"date-time"available_until字符串 null必填结束可用的时间。
字符串:format:"date-time"is_available布尔值必填此项目在当前上下文中是否可用。
附加字段: 否
FileAssign
FileAssign · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
audienceAudienceSelectionnull可选共享销售文件的明确访问规则。
expected_version整数必填写入前读取的版本;不匹配时拒绝更新。
minimum:1maximum:9223372036854775807label字符串可选对应上下文中的资源名称。
maxLength:300upload_id字符串必填资源标识符;请保留返回的原值。 · upload_id
format:"uuid"
附加字段: 否
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。
currency字符串必填金额的币种代码。
约束
pattern"^[A-Z]{3}$"
minor_units整数必填币种使用的小数位数。
minimum:0maximum:4tax_included布尔值必填提交的价格是否含税。
附加字段: 否
价格表信息
PriceListData · 架构 · 数据架构: 产品
currency字符串必填金额的币种代码。
id字符串必填资源标识符;请保留返回的原值。 (PriceListData).
tax_included布尔值必填提交的价格是否含税。
version整数必填用于并发控制的资源版本。
附加字段: 否
创建 — 产品 — 请求体
ProductCreate · API 接收或返回的数据字段、类型和约束。
brand_id字符串 null可选品牌标识符。
字符串:minLength:1maxLength:63condition字符串可选产品状况。
约束
enum["new", "refurbished", "used", "returned", "display", "damaged"]
description字符串 null可选所选语言的描述。
字符串:maxLength:100000feature_value_ids数组 <字符串> 可选所选属性值的标识符。
maxItems:1000数组:minLength:1maxLength:63identifiersProductIdentifiersnull可选产品识别代码。
market_ids数组 <字符串> 可选所选市场的标识符。
maxItems:1000数组:minLength:1maxLength:63media_ids数组 <字符串> 可选已存在媒体资产的标识符。
maxItems:30数组:minLength:1maxLength:63meta_description字符串 null可选所选语言的搜索引擎描述。
字符串:maxLength:160meta_keywords数组 <字符串> null可选所选语言的搜索引擎关键词。
数组:maxItems:20数组 / 数组:maxLength:50meta_title字符串 null可选所选语言的搜索引擎标题。
字符串:maxLength:70name字符串必填对应上下文中的资源名称。
minLength:1maxLength:300pricingProductPrice可选价格配置及其并发控制版本。
primary_category_id字符串 null可选主要分类标识符。
字符串:minLength:1maxLength:63published布尔值可选资源是否已发布。
sku字符串必填库存单位代码。
minLength:1maxLength:100约束
pattern"^\\S+$"
slug字符串 null可选所选语言的 URL 路径段。
字符串:maxLength:160tax_category_id字符串 null可选税务类别标识符。
字符串:minLength:1maxLength:63variant_value_ids数组 <字符串> 可选所选变体值的标识符。
maxItems:250数组:minLength:1maxLength:63variants_enabled布尔值可选产品是否使用变体。
附加字段: 否
获取 — 产品 — 响应
ProductDetailData · API 接收或返回的数据字段、类型和约束。
availabilityAvailabilityData必填所选上下文中的可用性信息。
brand_id字符串 null必填品牌标识符。
condition字符串必填产品状况。
约束
enum["new", "refurbished", "used", "returned", "display", "damaged"]
created_at字符串必填创建时间。
format:"date-time"description字符串 null必填所选语言的描述。
features数组 <FeatureSelectionData> 必填产品属性。
id字符串必填资源标识符;请保留返回的原值。 (ProductDetailData).
identifiers对象附加字段: 字符串必填产品识别代码。
media数组 <ProductMediaData> 必填附加媒体信息。
meta_description字符串 null必填所选语言的搜索引擎描述。
meta_keywords数组 <字符串> null必填所选语言的搜索引擎关键词。
meta_title字符串 null必填所选语言的搜索引擎标题。
name字符串 null必填对应上下文中的资源名称。
number字符串必填面向用户的订单号或申请编号。
pricePriceDatanull必填所选上下文中的价格信息。
price_version整数必填用于并发控制的当前价格版本。
primary_category_id字符串 null必填主要分类标识符。
primary_media_id字符串 null必填主要媒体资产标识符。
published布尔值必填资源是否已发布。
sku字符串必填库存单位代码。
slug字符串 null必填所选语言的 URL 路径段。
tax_category_id字符串必填税务类别标识符。
updated_at字符串必填最近更新时间。
format:"date-time"variants_enabled布尔值必填产品是否使用变体。
version整数必填用于并发控制的资源版本。
附加字段: 否
ProductFileData
ProductFileData · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
categoryFileCategory必填文件类别: internal / customer_document / digital
created_at字符串必填创建时间。
format:"date-time"current_version_id字符串必填资源标识符;请保留返回的原值。 · current_version_id
format:"uuid"file_id字符串必填资源标识符;请保留返回的原值。 · file_id
format:"uuid"filename字符串必填文件
id字符串必填资源标识符;请保留返回的原值。
format:"uuid"label字符串必填对应上下文中的资源名称。
mime_type字符串必填媒体内容类型。
sha256字符串必填SHA-256 (hex, 64)
size_bytes整数必填大小(字节)
state字符串必填状态
version_number整数必填版本
附加字段: 否
ProductFileListData
ProductFileListData · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
files数组 <ProductFileData> 必填商品文件
product_version整数必填用于并发控制的当前产品版本。
附加字段: 否
产品识别代码
ProductIdentifiers · 架构 · 数据架构: 产品
ean字符串 null可选产品 EAN 标识符。
字符串:minLength:1maxLength:100isbn字符串 null可选ISBN 标识符。
字符串:minLength:1maxLength:100mpn字符串 null可选制造商零件编号。
字符串:minLength:1maxLength:100upc字符串 null可选产品 UPC 标识符。
字符串:minLength:1maxLength:100
附加字段: 否
附加媒体信息
ProductMediaData · 架构 · 数据架构: 产品
alt_text字符串 null必填图片替代文本。
id字符串必填资源标识符;请保留返回的原值。 (ProductMediaData).
is_primary布尔值必填是否为主要项目。
kind字符串必填由允许值说明的数据结构变体。
约束
enum["image", "video", "model_3d"]
mime_type字符串必填媒体内容类型。
position整数必填在有序集合中的位置。
url字符串 null必填资源 URL。
附加字段: 否
价格配置及其并发控制版本
ProductPrice · 架构 · 数据架构: 产品
amount字符串 null必填以 JSON 字符串编码的十进制金额;仅在允许时使用 null。
字符串:maxLength:19约束 · 字符串 1
pattern"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"
currency字符串必填金额的币种代码。
约束
pattern"^[A-Z]{3}$"
expected_price_list_version整数必填本次写入要求的、此前读取的价格表版本。
minimum:1maximum:9223372036854775807expected_version整数必填写入前读取的版本;不匹配时拒绝更新。
minimum:0maximum:9223372036854775807kind字符串必填由允许值说明的数据结构变体。
约束
enum["base", "market_fixed"]
price_list_id字符串必填价格表标识符。
minLength:1maxLength:63tax_included布尔值必填提交的价格是否含税。
附加字段: 否
获取列表 — 产品 — 响应
ProductSummaryData · API 接收或返回的数据字段、类型和约束。
availabilityAvailabilityData必填所选上下文中的可用性信息。
brand_id字符串 null必填品牌标识符。
condition字符串必填产品状况。
约束
enum["new", "refurbished", "used", "returned", "display", "damaged"]
created_at字符串必填创建时间。
format:"date-time"id字符串必填资源标识符;请保留返回的原值。 (ProductSummaryData).
name字符串 null必填对应上下文中的资源名称。
number字符串必填面向用户的订单号或申请编号。
pricePriceDatanull必填所选上下文中的价格信息。
price_version整数必填用于并发控制的当前价格版本。
primary_category_id字符串 null必填主要分类标识符。
primary_media_id字符串 null必填主要媒体资产标识符。
published布尔值必填资源是否已发布。
sku字符串必填库存单位代码。
slug字符串 null必填所选语言的 URL 路径段。
tax_category_id字符串必填税务类别标识符。
updated_at字符串必填最近更新时间。
format:"date-time"variants_enabled布尔值必填产品是否使用变体。
version整数必填用于并发控制的资源版本。
附加字段: 否
更新 — 产品 — 请求体
ProductUpdate · API 接收或返回的数据字段、类型和约束。
brand_id字符串 null可选品牌标识符。
字符串:minLength:1maxLength:63condition字符串可选产品状况。
约束
enum["new", "refurbished", "used", "returned", "display", "damaged"]
description字符串 null可选所选语言的描述。
字符串:maxLength:100000expected_variant_price_versions对象附加字段: 整数可选minimum:0maximum:9223372036854775807此前读取的价格版本,以变体标识符为键。
maxProperties:250约束
propertyNames{"maxLength": 63, "minLength": 1}
expected_version整数必填写入前读取的版本;不匹配时拒绝更新。
minimum:1maximum:9223372036854775807feature_value_ids数组 <字符串> 可选所选属性值的标识符。
maxItems:1000数组:minLength:1maxLength:63identifiersProductIdentifiersnull可选产品识别代码。
market_ids数组 <字符串> 可选所选市场的标识符。
maxItems:1000数组:minLength:1maxLength:63media_ids数组 <字符串> 可选已存在媒体资产的标识符。
maxItems:30数组:minLength:1maxLength:63meta_description字符串 null可选所选语言的搜索引擎描述。
字符串:maxLength:160meta_keywords数组 <字符串> null可选所选语言的搜索引擎关键词。
数组:maxItems:20数组 / 数组:maxLength:50meta_title字符串 null可选所选语言的搜索引擎标题。
字符串:maxLength:70name字符串 null可选对应上下文中的资源名称。
字符串:maxLength:300pricingProductPrice可选价格配置及其并发控制版本。
primary_category_id字符串 null可选主要分类标识符。
字符串:minLength:1maxLength:63published布尔值可选资源是否已发布。
sku字符串可选库存单位代码。
minLength:1maxLength:100约束
pattern"^\\S+$"
slug字符串 null可选所选语言的 URL 路径段。
字符串:maxLength:160tax_category_id字符串 null可选税务类别标识符。
字符串:minLength:1maxLength:63variant_value_ids数组 <字符串> 可选所选变体值的标识符。
maxItems:250数组:minLength:1maxLength:63variants_enabled布尔值可选产品是否使用变体。
附加字段: 否
ProductVersion
ProductVersion · 此操作已停用,返回409且不会修改数据。请通过接收对象选择,为每个数字文件单独设置访问权限。
expected_version整数必填写入前读取的版本;不匹配时拒绝更新。
minimum:1maximum:9223372036854775807
附加字段: 否
ReleaseData
ReleaseData · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
changelog字符串必填更新说明
files数组 <ReleaseFileData> 必填商品文件
id字符串必填资源标识符;请保留返回的原值。
format:"uuid"manifest_sha256字符串 null必填数字版本 · SHA-256
published_at字符串 null必填发布版本 · UTC
字符串:format:"date-time"release_sequence整数 null必填数字版本 · 在有序集合中的位置。
state字符串必填状态
version_label字符串必填版本
withdrawn_at字符串 null必填撤回销售 · UTC
字符串:format:"date-time"
附加字段: 否
ReleaseDraft
ReleaseDraft · 此操作已停用,返回409且不会修改数据。请通过接收对象选择,为每个数字文件单独设置访问权限。
changelog字符串可选更新说明
maxLength:20000expected_version整数必填写入前读取的版本;不匹配时拒绝更新。
minimum:1maximum:9223372036854775807version_ids数组 <字符串> 必填版本 · UUID[]
minItems:1maxItems:20数组:format:"uuid"version_label字符串必填版本
minLength:1maxLength:64
附加字段: 否
ReleaseFileData
ReleaseFileData · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
file_id字符串必填资源标识符;请保留返回的原值。 · file_id
format:"uuid"sort_order整数必填在有序集合中的位置。
version_id字符串必填资源标识符;请保留返回的原值。 · version_id
format:"uuid"
附加字段: 否
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"product_version整数必填用于并发控制的当前产品版本。
releases数组 <ReleaseData> 必填数字版本
update_days整数 null必填天数 (days; null)
update_mode字符串必填购买后对未来文件的访问权限: none / period / unlimited
update_months整数 null必填月数 (months; null)
附加字段: 否
UpdatePolicy
UpdatePolicy · 此操作已停用,返回409且不会修改数据。请通过接收对象选择,为每个数字文件单独设置访问权限。
days整数 null可选天数 (1–3650; mode=period; months=null)
整数:minimum:1maximum:3650expected_version整数必填写入前读取的版本;不匹配时拒绝更新。
minimum:1maximum:9223372036854775807mode字符串必填购买后对未来文件的访问权限: none / period / unlimited
约束
enum["none", "period", "unlimited"]
months整数 null可选月数 (1–120; mode=period; days=null)
整数:minimum:1maximum:120
附加字段: 否
UploadCreate
UploadCreate · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
filename字符串必填文件
minLength:1maxLength:255product_id字符串 null可选产品标识符。
约束 · 字符串 1
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
sha256字符串必填SHA-256 (hex, 64)
约束
pattern"^[0-9a-f]{64}$"
size_bytes整数必填大小(字节)
minimum:1maximum:262144000
附加字段: 否
UploadData
UploadData · API 接收或返回的数据字段、类型和约束。 创建 upload_id 后,以 multipart/form-data 上传文件,再关联到商品。下载需要 Bearer 令牌及 category 对应权限;响应直接包含文件字节,不使用公开地址或密码。mode=period 时,选择 days(1–3650)或原有的 months,不能同时指定。购买时保存访问条件;退款只撤销已退款订单项的访问权限。
categoryFileCategory必填文件类别: internal / customer_document / digital
expires_at字符串必填凭据到期的日期和时间。
format:"date-time"filename字符串必填文件
id字符串必填资源标识符;请保留返回的原值。
format:"uuid"product_id字符串 null必填产品标识符。
received_bytes整数必填正在上传… · 大小(字节)
sha256字符串必填SHA-256 (hex, 64)
size_bytes整数必填大小(字节)
status字符串必填此操作接受的状态。
附加字段: 否