資料架構 · 折扣

dataCampaignData 必填

成功回應的資料。

示例: {"created_at":"2026-10-07T10:00:00Z","created_by":{"kind":"admin","label":"Editorial integration","reference":"learn-api-key"},"enabled":false,"id":"example-campaign","kind":"coupon","markets":[{"currency":"PLN","market_id":"poland","minor_units":0}],"name":"Autumn guide offer","updated_at":"2026-10-07T10:00:00Z","used_count":0,"version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必填

回應元資料。

示例: {"locale":"example","market_code":"example","market_id":"poland","pagination":{"has_more":false,"limit":1,"next_cursor":null},"request_id":"learn-example-request"}

附加欄位: 否

data陣列 <CampaignData > 必填

成功回應的資料。

示例: []

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必填

回應元資料。

示例: {"locale":"example","market_code":"example","market_id":"poland","pagination":{"has_more":false,"limit":1,"next_cursor":null},"request_id":"learn-example-request"}

附加欄位: 否

audience字串選填

客戶

約束

enum

["all", "guest", "customer", "selected"]

預設值: "all"

benefit_type字串選填

由允許值說明的資料結構變體。

約束

enum

["percentage", "fixed", "none"]

預設值: "percentage"

category_ids陣列 <字串> 選填

相關分類的識別碼。

maxItems: 1000

約束 · 陣列 1

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

code字串 | null選填

穩定的機器可讀代碼。

約束 · 字串 1

pattern

"^[A-Za-z0-9]{6,16}$"

示例: "LEARN10"

combine_coupons布林值選填

與其他優惠碼疊加

預設值: false

combine_promotions布林值選填

允許此代碼用於已參加自動促銷的商品

預設值: false

customer_ids陣列 <字串> 選填

此資源記錄的客戶資訊。

maxItems: 1000

約束 · 陣列 1

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

ends_at字串 | null選填

失效時間

字串:format: "date-time"

free_shipping布林值選填

免運費

預設值: false

markets陣列 <MarketData-Input > 必填

商店上下文中可用的市場。

minItems: 1maxItems: 1000

示例: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantity整數選填

購物車最低商品數量

minimum: 1maximum: 2147483647

預設值: 1

name字串必填

對應上下文中的資源名稱。

minLength: 1maxLength: 160

示例: "Autumn guide offer"

per_customer_limit整數選填

每位客戶的使用次數上限

minimum: -1maximum: 2147483647

預設值: -1

percentage字串選填

百分比

maxLength: 19

約束

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

預設值: "10"

product_ids陣列 <字串> 選填

相關產品的識別碼。

maxItems: 1000

約束 · 陣列 1

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

product_scope字串選填

商品

約束

enum

["all", "selected"]

預設值: "all"

show_account布林值選填

在客戶帳戶中

預設值: false

show_cart布林值選填

在購物車中

預設值: false

show_product布林值選填

在商品頁面上

預設值: false

starts_at字串 | null選填

生效時間

字串:format: "date-time"

usage_limit整數選填

使用次數上限

minimum: -1maximum: 2147483647

預設值: -1

附加欄位: 否

audience字串選填

客戶

約束

enum

["all", "guest", "customer", "selected"]

預設值: "all"

benefit_type字串選填

由允許值說明的資料結構變體。

約束

enum

["percentage", "fixed", "none"]

預設值: "percentage"

category_ids陣列 <字串> 選填

相關分類的識別碼。

maxItems: 1000

約束 · 陣列 1

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

code字串 | null選填

穩定的機器可讀代碼。

約束 · 字串 1

pattern

"^[A-Za-z0-9]{6,16}$"

combine_coupons布林值選填

與其他優惠碼疊加

預設值: false

combine_promotions布林值選填

允許此代碼用於已參加自動促銷的商品

預設值: false

created_at字串必填

建立時間。

format: "date-time"

示例: "2026-10-07T10:00:00Z"

created_byCreatorData 必填

建立者

示例: {"kind":"admin","label":"Editorial integration","reference":"learn-api-key"}

customer_ids陣列 <字串> 選填

此資源記錄的客戶資訊。

maxItems: 1000

約束 · 陣列 1

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

enabled布林值必填

此設定是否啓用。

示例: false

ends_at字串 | null選填

失效時間

字串:format: "date-time"

free_shipping布林值選填

免運費

預設值: false

id字串必填

資源識別碼；請保留回傳的原值。

示例: "example-campaign"

kind字串必填

由允許值說明的資料結構變體。

約束

enum

["coupon", "promotion"]

示例: "coupon"

markets陣列 <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > 必填

商店上下文中可用的市場。

minItems: 1maxItems: 1000

示例: [{"currency":"PLN","market_id":"poland","minor_units":0}]

minimum_quantity整數選填

購物車最低商品數量

minimum: 1maximum: 2147483647

預設值: 1

name字串必填

對應上下文中的資源名稱。

minLength: 1maxLength: 160

示例: "Autumn guide offer"

per_customer_limit整數選填

每位客戶的使用次數上限

minimum: -1maximum: 2147483647

預設值: -1

percentage字串選填

百分比

maxLength: 19

約束

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

預設值: "10"

product_ids陣列 <字串> 選填

相關產品的識別碼。

maxItems: 1000

約束 · 陣列 1

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

product_scope字串選填

商品

約束

enum

["all", "selected"]

預設值: "all"

show_account布林值選填

在客戶帳戶中

預設值: false

show_cart布林值選填

在購物車中

預設值: false

show_product布林值選填

在商品頁面上

預設值: false

starts_at字串 | null選填

生效時間

字串:format: "date-time"

updated_at字串必填

最近更新時間。

format: "date-time"

示例: "2026-10-07T10:00:00Z"

usage_limit整數選填

使用次數上限

minimum: -1maximum: 2147483647

預設值: -1

used_count整數必填

已使用次數

示例: 0

version整數必填

用於並行控制的資源版本。

示例: 1

附加欄位: 否

enabled布林值必填

此設定是否啓用。

示例: false

expected_version整數必填

寫入前讀取的版本；不匹配時拒絕更新。

minimum: 1maximum: 9223372036854775807

示例: 1

附加欄位: 否

audience字串選填

客戶

約束

enum

["all", "guest", "customer", "selected"]

預設值: "all"

benefit_type字串選填

由允許值說明的資料結構變體。

約束

enum

["percentage", "fixed", "none"]

預設值: "percentage"

category_ids陣列 <字串> 選填

相關分類的識別碼。

maxItems: 1000

約束 · 陣列 1

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

code字串 | null選填

穩定的機器可讀代碼。

約束 · 字串 1

pattern

"^[A-Za-z0-9]{6,16}$"

示例: "LEARN10"

combine_coupons布林值選填

與其他優惠碼疊加

預設值: false

combine_promotions布林值選填

允許此代碼用於已參加自動促銷的商品

預設值: false

customer_ids陣列 <字串> 選填

此資源記錄的客戶資訊。

maxItems: 1000

約束 · 陣列 1

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

ends_at字串 | null選填

失效時間

字串:format: "date-time"

expected_version整數必填

寫入前讀取的版本；不匹配時拒絕更新。

minimum: 1maximum: 9223372036854775807

示例: 1

free_shipping布林值選填

免運費

預設值: false

markets陣列 <MarketData-Input > 必填

商店上下文中可用的市場。

minItems: 1maxItems: 1000

示例: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantity整數選填

購物車最低商品數量

minimum: 1maximum: 2147483647

預設值: 1

name字串必填

對應上下文中的資源名稱。

minLength: 1maxLength: 160

示例: "Autumn guide offer"

per_customer_limit整數選填

每位客戶的使用次數上限

minimum: -1maximum: 2147483647

預設值: -1

percentage字串選填

百分比

maxLength: 19

約束

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

預設值: "10"

product_ids陣列 <字串> 選填

相關產品的識別碼。

maxItems: 1000

約束 · 陣列 1

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

product_scope字串選填

商品

約束

enum

["all", "selected"]

預設值: "all"

show_account布林值選填

在客戶帳戶中

預設值: false

show_cart布林值選填

在購物車中

預設值: false

show_product布林值選填

在商品頁面上

預設值: false

starts_at字串 | null選填

生效時間

字串:format: "date-time"

usage_limit整數選填

使用次數上限

minimum: -1maximum: 2147483647

預設值: -1

附加欄位: 否

kind字串必填

由允許值說明的資料結構變體。

約束

enum

["admin", "api"]

示例: "admin"

label字串必填

對應上下文中的資源名稱。

示例: "Editorial integration"

reference字串必填

所引用實體的識別碼。

示例: "learn-api-key"

附加欄位: 否

currency字串必填

金額的幣種代碼。

約束

pattern

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

示例: "PLN"

fixed_amount字串選填

折扣金額

maxLength: 19

約束

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

預設值: "0"

market_id字串必填

上下文端點回傳的市場識別碼。

約束

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

示例: "poland"

maximum_price字串 | null選填

最高商品價格

字串:maxLength: 19

約束 · 字串 1

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

minimum_price字串 | null選填

最低商品價格

字串:maxLength: 19

約束 · 字串 1

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

minimum_subtotal字串選填

最低購物車金額

maxLength: 19

約束

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

預設值: "0"

minor_units整數必填

幣種使用的小數位數。

minimum: 0maximum: 4

示例: 2

附加欄位: 否

currency字串必填

金額的幣種代碼。

約束

pattern

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

示例: "PLN"

fixed_amount字串選填

折扣金額

maxLength: 19

約束

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

預設值: "0"

market_id字串必填

上下文端點回傳的市場識別碼。

約束

pattern

"^[a-z0-9][a-z0-9_-]{0,62}$"

示例: "poland"

maximum_price字串 | null選填

最高商品價格

字串:maxLength: 19

約束 · 字串 1

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

minimum_price字串 | null選填

最低商品價格

字串:maxLength: 19

約束 · 字串 1

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

minimum_subtotal字串選填

最低購物車金額

maxLength: 19

約束

pattern

"^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

預設值: "0"

minor_units整數必填

幣種使用的小數位數。

minimum: 0maximum: 4

示例: 0

附加欄位: 否