数据架构 · 折扣

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

附加字段: 否