Veri şemaları · İndirimler

dataCampaignData Zorunlu

Başarılı yanıtın verileri.

Örnek: {"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 Zorunlu

Yanıt üst verileri.

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

Ek alanlar: Hayır

dataDizi <CampaignData > Zorunlu

Başarılı yanıtın verileri.

Örnek: []

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Zorunlu

Yanıt üst verileri.

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

Ek alanlar: Hayır

audienceDizeİsteğe bağlı

Müşteriler

Kısıtlamalar

enum

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

Varsayılan: "all"

benefit_typeDizeİsteğe bağlı

İzin verilen değerlerle tanımlanan veri yapısı çeşidi.

Kısıtlamalar

enum

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

Varsayılan: "percentage"

category_idsDizi <Dize> İsteğe bağlı

İlgili kategorilerin tanımlayıcıları.

maxItems: 1000

Kısıtlamalar · Dizi 1

pattern

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

codeDize | nullİsteğe bağlı

Makine tarafından okunabilir, sabit kod.

Kısıtlamalar · Dize 1

pattern

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

Örnek: "LEARN10"

combine_couponsMantıksal değerİsteğe bağlı

Diğer kodlarla birleştir

Varsayılan: false

combine_promotionsMantıksal değerİsteğe bağlı

Bu kodun otomatik kampanyalı ürünlerde kullanılmasına izin ver

Varsayılan: false

customer_idsDizi <Dize> İsteğe bağlı

Bu kaynak için kaydedilen müşteri bilgileri.

maxItems: 1000

Kısıtlamalar · Dizi 1

pattern

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

ends_atDize | nullİsteğe bağlı

Bitiş

Dize:format: "date-time"

free_shippingMantıksal değerİsteğe bağlı

Ücretsiz kargo

Varsayılan: false

marketsDizi <MarketData-Input > Zorunlu

Mağaza bağlamında kullanılabilir pazarlar.

minItems: 1maxItems: 1000

Örnek: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityTam sayıİsteğe bağlı

Sepetteki minimum ürün adedi

minimum: 1maximum: 2147483647

Varsayılan: 1

nameDizeZorunlu

İlgili bağlamdaki kaynak adı.

minLength: 1maxLength: 160

Örnek: "Autumn guide offer"

per_customer_limitTam sayıİsteğe bağlı

Müşteri başına kullanım sınırı

minimum: -1maximum: 2147483647

Varsayılan: -1

percentageDizeİsteğe bağlı

Yüzde

maxLength: 19

Kısıtlamalar

pattern

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

Varsayılan: "10"

product_idsDizi <Dize> İsteğe bağlı

İlgili ürünlerin tanımlayıcıları.

maxItems: 1000

Kısıtlamalar · Dizi 1

pattern

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

product_scopeDizeİsteğe bağlı

Ürünler

Kısıtlamalar

enum

["all", "selected"]

Varsayılan: "all"

show_accountMantıksal değerİsteğe bağlı

Müşteri hesabında

Varsayılan: false

show_cartMantıksal değerİsteğe bağlı

Sepette

Varsayılan: false

show_productMantıksal değerİsteğe bağlı

Ürün sayfalarında

Varsayılan: false

starts_atDize | nullİsteğe bağlı

Başlangıç

Dize:format: "date-time"

usage_limitTam sayıİsteğe bağlı

Kullanım sınırı

minimum: -1maximum: 2147483647

Varsayılan: -1

Ek alanlar: Hayır

audienceDizeİsteğe bağlı

Müşteriler

Kısıtlamalar

enum

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

Varsayılan: "all"

benefit_typeDizeİsteğe bağlı

İzin verilen değerlerle tanımlanan veri yapısı çeşidi.

Kısıtlamalar

enum

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

Varsayılan: "percentage"

category_idsDizi <Dize> İsteğe bağlı

İlgili kategorilerin tanımlayıcıları.

maxItems: 1000

Kısıtlamalar · Dizi 1

pattern

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

codeDize | nullİsteğe bağlı

Makine tarafından okunabilir, sabit kod.

Kısıtlamalar · Dize 1

pattern

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

combine_couponsMantıksal değerİsteğe bağlı

Diğer kodlarla birleştir

Varsayılan: false

combine_promotionsMantıksal değerİsteğe bağlı

Bu kodun otomatik kampanyalı ürünlerde kullanılmasına izin ver

Varsayılan: false

created_atDizeZorunlu

Oluşturulma zamanı.

format: "date-time"

Örnek: "2026-10-07T10:00:00Z"

created_byCreatorData Zorunlu

Oluşturan

Örnek: {"kind":"admin","label":"Editorial integration","reference":"learn-api-key"}

customer_idsDizi <Dize> İsteğe bağlı

Bu kaynak için kaydedilen müşteri bilgileri.

maxItems: 1000

Kısıtlamalar · Dizi 1

pattern

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

enabledMantıksal değerZorunlu

Bu ayarın etkin olup olmadığı.

Örnek: false

ends_atDize | nullİsteğe bağlı

Bitiş

Dize:format: "date-time"

free_shippingMantıksal değerİsteğe bağlı

Ücretsiz kargo

Varsayılan: false

idDizeZorunlu

Kaynak tanımlayıcısı; döndürüldüğü biçimi koruyun.

Örnek: "example-campaign"

kindDizeZorunlu

İzin verilen değerlerle tanımlanan veri yapısı çeşidi.

Kısıtlamalar

enum

["coupon", "promotion"]

Örnek: "coupon"

marketsDizi <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Zorunlu

Mağaza bağlamında kullanılabilir pazarlar.

minItems: 1maxItems: 1000

Örnek: [{"currency":"PLN","market_id":"poland","minor_units":0}]

minimum_quantityTam sayıİsteğe bağlı

Sepetteki minimum ürün adedi

minimum: 1maximum: 2147483647

Varsayılan: 1

nameDizeZorunlu

İlgili bağlamdaki kaynak adı.

minLength: 1maxLength: 160

Örnek: "Autumn guide offer"

per_customer_limitTam sayıİsteğe bağlı

Müşteri başına kullanım sınırı

minimum: -1maximum: 2147483647

Varsayılan: -1

percentageDizeİsteğe bağlı

Yüzde

maxLength: 19

Kısıtlamalar

pattern

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

Varsayılan: "10"

product_idsDizi <Dize> İsteğe bağlı

İlgili ürünlerin tanımlayıcıları.

maxItems: 1000

Kısıtlamalar · Dizi 1

pattern

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

product_scopeDizeİsteğe bağlı

Ürünler

Kısıtlamalar

enum

["all", "selected"]

Varsayılan: "all"

show_accountMantıksal değerİsteğe bağlı

Müşteri hesabında

Varsayılan: false

show_cartMantıksal değerİsteğe bağlı

Sepette

Varsayılan: false

show_productMantıksal değerİsteğe bağlı

Ürün sayfalarında

Varsayılan: false

starts_atDize | nullİsteğe bağlı

Başlangıç

Dize:format: "date-time"

updated_atDizeZorunlu

Son güncelleme zamanı.

format: "date-time"

Örnek: "2026-10-07T10:00:00Z"

usage_limitTam sayıİsteğe bağlı

Kullanım sınırı

minimum: -1maximum: 2147483647

Varsayılan: -1

used_countTam sayıZorunlu

Kullanım sayısı

Örnek: 0

versionTam sayıZorunlu

Eşzamanlılık denetiminde kullanılan kaynak sürümü.

Örnek: 1

Ek alanlar: Hayır

enabledMantıksal değerZorunlu

Bu ayarın etkin olup olmadığı.

Örnek: false

expected_versionTam sayıZorunlu

Yazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.

minimum: 1maximum: 9223372036854775807

Örnek: 1

Ek alanlar: Hayır

audienceDizeİsteğe bağlı

Müşteriler

Kısıtlamalar

enum

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

Varsayılan: "all"

benefit_typeDizeİsteğe bağlı

İzin verilen değerlerle tanımlanan veri yapısı çeşidi.

Kısıtlamalar

enum

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

Varsayılan: "percentage"

category_idsDizi <Dize> İsteğe bağlı

İlgili kategorilerin tanımlayıcıları.

maxItems: 1000

Kısıtlamalar · Dizi 1

pattern

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

codeDize | nullİsteğe bağlı

Makine tarafından okunabilir, sabit kod.

Kısıtlamalar · Dize 1

pattern

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

Örnek: "LEARN10"

combine_couponsMantıksal değerİsteğe bağlı

Diğer kodlarla birleştir

Varsayılan: false

combine_promotionsMantıksal değerİsteğe bağlı

Bu kodun otomatik kampanyalı ürünlerde kullanılmasına izin ver

Varsayılan: false

customer_idsDizi <Dize> İsteğe bağlı

Bu kaynak için kaydedilen müşteri bilgileri.

maxItems: 1000

Kısıtlamalar · Dizi 1

pattern

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

ends_atDize | nullİsteğe bağlı

Bitiş

Dize:format: "date-time"

expected_versionTam sayıZorunlu

Yazmadan önce okunan sürüm; uyuşmazlık güncellemenin reddedilmesine yol açar.

minimum: 1maximum: 9223372036854775807

Örnek: 1

free_shippingMantıksal değerİsteğe bağlı

Ücretsiz kargo

Varsayılan: false

marketsDizi <MarketData-Input > Zorunlu

Mağaza bağlamında kullanılabilir pazarlar.

minItems: 1maxItems: 1000

Örnek: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityTam sayıİsteğe bağlı

Sepetteki minimum ürün adedi

minimum: 1maximum: 2147483647

Varsayılan: 1

nameDizeZorunlu

İlgili bağlamdaki kaynak adı.

minLength: 1maxLength: 160

Örnek: "Autumn guide offer"

per_customer_limitTam sayıİsteğe bağlı

Müşteri başına kullanım sınırı

minimum: -1maximum: 2147483647

Varsayılan: -1

percentageDizeİsteğe bağlı

Yüzde

maxLength: 19

Kısıtlamalar

pattern

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

Varsayılan: "10"

product_idsDizi <Dize> İsteğe bağlı

İlgili ürünlerin tanımlayıcıları.

maxItems: 1000

Kısıtlamalar · Dizi 1

pattern

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

product_scopeDizeİsteğe bağlı

Ürünler

Kısıtlamalar

enum

["all", "selected"]

Varsayılan: "all"

show_accountMantıksal değerİsteğe bağlı

Müşteri hesabında

Varsayılan: false

show_cartMantıksal değerİsteğe bağlı

Sepette

Varsayılan: false

show_productMantıksal değerİsteğe bağlı

Ürün sayfalarında

Varsayılan: false

starts_atDize | nullİsteğe bağlı

Başlangıç

Dize:format: "date-time"

usage_limitTam sayıİsteğe bağlı

Kullanım sınırı

minimum: -1maximum: 2147483647

Varsayılan: -1

Ek alanlar: Hayır

kindDizeZorunlu

İzin verilen değerlerle tanımlanan veri yapısı çeşidi.

Kısıtlamalar

enum

["admin", "api"]

Örnek: "admin"

labelDizeZorunlu

İlgili bağlamdaki kaynak adı.

Örnek: "Editorial integration"

referenceDizeZorunlu

Başvurulan varlığın tanımlayıcısı.

Örnek: "learn-api-key"

Ek alanlar: Hayır

currencyDizeZorunlu

Tutarın para birimi kodu.

Kısıtlamalar

pattern

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

Örnek: "PLN"

fixed_amountDizeİsteğe bağlı

İndirim tutarı

maxLength: 19

Kısıtlamalar

pattern

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

Varsayılan: "0"

market_idDizeZorunlu

Bağlam uç noktasının döndürdüğü pazar tanımlayıcısı.

Kısıtlamalar

pattern

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

Örnek: "poland"

maximum_priceDize | nullİsteğe bağlı

Maksimum ürün fiyatı

Dize:maxLength: 19

Kısıtlamalar · Dize 1

pattern

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

minimum_priceDize | nullİsteğe bağlı

Minimum ürün fiyatı

Dize:maxLength: 19

Kısıtlamalar · Dize 1

pattern

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

minimum_subtotalDizeİsteğe bağlı

Minimum sepet tutarı

maxLength: 19

Kısıtlamalar

pattern

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

Varsayılan: "0"

minor_unitsTam sayıZorunlu

Para biriminin kullandığı ondalık basamak sayısı.

minimum: 0maximum: 4

Örnek: 2

Ek alanlar: Hayır

currencyDizeZorunlu

Tutarın para birimi kodu.

Kısıtlamalar

pattern

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

Örnek: "PLN"

fixed_amountDizeİsteğe bağlı

İndirim tutarı

maxLength: 19

Kısıtlamalar

pattern

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

Varsayılan: "0"

market_idDizeZorunlu

Bağlam uç noktasının döndürdüğü pazar tanımlayıcısı.

Kısıtlamalar

pattern

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

Örnek: "poland"

maximum_priceDize | nullİsteğe bağlı

Maksimum ürün fiyatı

Dize:maxLength: 19

Kısıtlamalar · Dize 1

pattern

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

minimum_priceDize | nullİsteğe bağlı

Minimum ürün fiyatı

Dize:maxLength: 19

Kısıtlamalar · Dize 1

pattern

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

minimum_subtotalDizeİsteğe bağlı

Minimum sepet tutarı

maxLength: 19

Kısıtlamalar

pattern

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

Varsayılan: "0"

minor_unitsTam sayıZorunlu

Para biriminin kullandığı ondalık basamak sayısı.

minimum: 0maximum: 4

Örnek: 0

Ek alanlar: Hayır