データスキーマ · 割引

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

追加フィールド: いいえ