資料架構
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字串必填此操作接受的狀態。
附加欄位: 否