Adatsémák · Kedvezmények

Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

Adatsémák

ApiResponse[CampaignData]

ApiResponse_CampaignData_ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

dataCampaignData Kötelező: A sikeres válasz adatai.

Példa: {"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 Kötelező: A válasz metaadatai.

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

További mezők: Nem

ApiResponse[list[CampaignData]]

ApiResponse_list_CampaignData__ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

dataTömb <CampaignData > Kötelező: A sikeres válasz adatai.

Példa: []
metaContextPageMeta ContextMeta PageMeta RequestMeta Kötelező: A válasz metaadatai.

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

További mezők: Nem

CampaignCreate

CampaignCreate · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

audienceKarakterláncNem kötelező

Vásárlók

Korlátozások

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

Alapértelmezett: "all"

benefit_typeKarakterláncNem kötelező

Az adatstruktúra változata, a megengedett értékek szerint.

Korlátozások

enum: ["percentage", "fixed", "none"]

Alapértelmezett: "percentage"

category_idsTömb <Karakterlánc> Nem kötelező

A kapcsolódó kategóriák azonosítói.

maxItems: 1000

Korlátozások · Tömb 1

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

codeKarakterlánc nullNem kötelező

Stabil, géppel feldolgozható kód.

Korlátozások · Karakterlánc 1

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

Példa: "LEARN10"

combine_couponsLogikai értékNem kötelező

Összevonás más kódokkal

Alapértelmezett: false

combine_promotionsLogikai értékNem kötelező

A kód engedélyezése automatikus akcióban részt vevő termékeken

Alapértelmezett: false

customer_idsTömb <Karakterlánc> Nem kötelező

Az erőforráshoz rögzített ügyféladatok.

maxItems: 1000

Korlátozások · Tömb 1

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

ends_atKarakterlánc nullNem kötelező

Érvényes eddig

Karakterlánc:format: "date-time"

free_shippingLogikai értékNem kötelező

Ingyenes szállítás

Alapértelmezett: false

marketsTömb <MarketData-Input > Kötelező

Az áruház környezetében elérhető piacok.

minItems: 1maxItems: 1000

Példa: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityEgész számNem kötelező

Minimális darabszám a kosárban

minimum: 1maximum: 2147483647

Alapértelmezett: 1

nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

minLength: 1maxLength: 160

Példa: "Autumn guide offer"

per_customer_limitEgész számNem kötelező

Vásárlónkénti felhasználási korlát

minimum: -1maximum: 2147483647

Alapértelmezett: -1

percentageKarakterláncNem kötelező

Százalékos

maxLength: 19

Korlátozások

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

Alapértelmezett: "10"

product_idsTömb <Karakterlánc> Nem kötelező

A kapcsolódó termékek azonosítói.

maxItems: 1000

Korlátozások · Tömb 1

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

product_scopeKarakterláncNem kötelező

Termékek

Korlátozások

enum: ["all", "selected"]

Alapértelmezett: "all"

show_accountLogikai értékNem kötelező

A vásárlói fiókban

Alapértelmezett: false

show_cartLogikai értékNem kötelező

A kosárban

Alapértelmezett: false

show_productLogikai értékNem kötelező

A termékoldalakon

Alapértelmezett: false

starts_atKarakterlánc nullNem kötelező

Érvényes ettől

Karakterlánc:format: "date-time"

usage_limitEgész számNem kötelező

Felhasználási korlát

minimum: -1maximum: 2147483647

Alapértelmezett: -1

További mezők: Nem

CampaignData

CampaignData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

audienceKarakterláncNem kötelező

Vásárlók

Korlátozások

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

Alapértelmezett: "all"

benefit_typeKarakterláncNem kötelező

Az adatstruktúra változata, a megengedett értékek szerint.

Korlátozások

enum: ["percentage", "fixed", "none"]

Alapértelmezett: "percentage"

category_idsTömb <Karakterlánc> Nem kötelező

A kapcsolódó kategóriák azonosítói.

maxItems: 1000

Korlátozások · Tömb 1

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

codeKarakterlánc nullNem kötelező

Stabil, géppel feldolgozható kód.

Korlátozások · Karakterlánc 1

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

combine_couponsLogikai értékNem kötelező

Összevonás más kódokkal

Alapértelmezett: false

combine_promotionsLogikai értékNem kötelező

A kód engedélyezése automatikus akcióban részt vevő termékeken

Alapértelmezett: false

created_atKarakterláncKötelező

A létrehozás időpontja.

format: "date-time"

Példa: "2026-10-07T10:00:00Z"

created_byCreatorData Kötelező

Létrehozta

Példa: {"kind":"admin","label":"Editorial integration","reference":"learn-api-key"}

customer_idsTömb <Karakterlánc> Nem kötelező

Az erőforráshoz rögzített ügyféladatok.

maxItems: 1000

Korlátozások · Tömb 1

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

enabledLogikai értékKötelező

Jelzi, hogy a beállítás engedélyezett-e.

Példa: false

ends_atKarakterlánc nullNem kötelező

Érvényes eddig

Karakterlánc:format: "date-time"

free_shippingLogikai értékNem kötelező

Ingyenes szállítás

Alapértelmezett: false

idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg.

Példa: "example-campaign"

kindKarakterláncKötelező

Az adatstruktúra változata, a megengedett értékek szerint.

Korlátozások

enum: ["coupon", "promotion"]

Példa: "coupon"

marketsTömb <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Kötelező

Az áruház környezetében elérhető piacok.

minItems: 1maxItems: 1000

Példa: [{"currency":"PLN","market_id":"poland","minor_units":0}]

minimum_quantityEgész számNem kötelező

Minimális darabszám a kosárban

minimum: 1maximum: 2147483647

Alapértelmezett: 1

nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

minLength: 1maxLength: 160

Példa: "Autumn guide offer"

per_customer_limitEgész számNem kötelező

Vásárlónkénti felhasználási korlát

minimum: -1maximum: 2147483647

Alapértelmezett: -1

percentageKarakterláncNem kötelező

Százalékos

maxLength: 19

Korlátozások

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

Alapértelmezett: "10"

product_idsTömb <Karakterlánc> Nem kötelező

A kapcsolódó termékek azonosítói.

maxItems: 1000

Korlátozások · Tömb 1

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

product_scopeKarakterláncNem kötelező

Termékek

Korlátozások

enum: ["all", "selected"]

Alapértelmezett: "all"

show_accountLogikai értékNem kötelező

A vásárlói fiókban

Alapértelmezett: false

show_cartLogikai értékNem kötelező

A kosárban

Alapértelmezett: false

show_productLogikai értékNem kötelező

A termékoldalakon

Alapértelmezett: false

starts_atKarakterlánc nullNem kötelező

Érvényes ettől

Karakterlánc:format: "date-time"

updated_atKarakterláncKötelező

A legutóbbi módosítás időpontja.

format: "date-time"

Példa: "2026-10-07T10:00:00Z"

usage_limitEgész számNem kötelező

Felhasználási korlát

minimum: -1maximum: 2147483647

Alapértelmezett: -1

used_countEgész számKötelező

Felhasználások száma

Példa: 0

versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1

További mezők: Nem

CampaignStatus

CampaignStatus · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

enabledLogikai értékKötelező: Jelzi, hogy a beállítás engedélyezett-e.

Példa: false
expected_versionEgész számKötelező: Az írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.

minimum: 1maximum: 9223372036854775807

Példa: 1

További mezők: Nem

CampaignUpdate

CampaignUpdate · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

audienceKarakterláncNem kötelező

Vásárlók

Korlátozások

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

Alapértelmezett: "all"

benefit_typeKarakterláncNem kötelező

Az adatstruktúra változata, a megengedett értékek szerint.

Korlátozások

enum: ["percentage", "fixed", "none"]

Alapértelmezett: "percentage"

category_idsTömb <Karakterlánc> Nem kötelező

A kapcsolódó kategóriák azonosítói.

maxItems: 1000

Korlátozások · Tömb 1

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

codeKarakterlánc nullNem kötelező

Stabil, géppel feldolgozható kód.

Korlátozások · Karakterlánc 1

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

Példa: "LEARN10"

combine_couponsLogikai értékNem kötelező

Összevonás más kódokkal

Alapértelmezett: false

combine_promotionsLogikai értékNem kötelező

A kód engedélyezése automatikus akcióban részt vevő termékeken

Alapértelmezett: false

customer_idsTömb <Karakterlánc> Nem kötelező

Az erőforráshoz rögzített ügyféladatok.

maxItems: 1000

Korlátozások · Tömb 1

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

ends_atKarakterlánc nullNem kötelező

Érvényes eddig

Karakterlánc:format: "date-time"

expected_versionEgész számKötelező

Az írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.

minimum: 1maximum: 9223372036854775807

Példa: 1

free_shippingLogikai értékNem kötelező

Ingyenes szállítás

Alapértelmezett: false

marketsTömb <MarketData-Input > Kötelező

Az áruház környezetében elérhető piacok.

minItems: 1maxItems: 1000

Példa: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityEgész számNem kötelező

Minimális darabszám a kosárban

minimum: 1maximum: 2147483647

Alapértelmezett: 1

nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

minLength: 1maxLength: 160

Példa: "Autumn guide offer"

per_customer_limitEgész számNem kötelező

Vásárlónkénti felhasználási korlát

minimum: -1maximum: 2147483647

Alapértelmezett: -1

percentageKarakterláncNem kötelező

Százalékos

maxLength: 19

Korlátozások

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

Alapértelmezett: "10"

product_idsTömb <Karakterlánc> Nem kötelező

A kapcsolódó termékek azonosítói.

maxItems: 1000

Korlátozások · Tömb 1

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

product_scopeKarakterláncNem kötelező

Termékek

Korlátozások

enum: ["all", "selected"]

Alapértelmezett: "all"

show_accountLogikai értékNem kötelező

A vásárlói fiókban

Alapértelmezett: false

show_cartLogikai értékNem kötelező

A kosárban

Alapértelmezett: false

show_productLogikai értékNem kötelező

A termékoldalakon

Alapértelmezett: false

starts_atKarakterlánc nullNem kötelező

Érvényes ettől

Karakterlánc:format: "date-time"

usage_limitEgész számNem kötelező

Felhasználási korlát

minimum: -1maximum: 2147483647

Alapértelmezett: -1

További mezők: Nem

CreatorData

CreatorData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

kindKarakterláncKötelező

Az adatstruktúra változata, a megengedett értékek szerint.

Korlátozások

enum: ["admin", "api"]

Példa: "admin"

labelKarakterláncKötelező

Az erőforrás neve az adott környezetben.

Példa: "Editorial integration"

referenceKarakterláncKötelező

A hivatkozott entitás azonosítója.

Példa: "learn-api-key"

További mezők: Nem

MarketData

MarketData-Input · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

currencyKarakterláncKötelező

Az összeg pénznemkódja.

Korlátozások

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

Példa: "PLN"

fixed_amountKarakterláncNem kötelező

Kedvezmény összege

maxLength: 19

Korlátozások

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

Alapértelmezett: "0"

market_idKarakterláncKötelező

A környezetvégpont által visszaadott piacazonosító.

Korlátozások

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

Példa: "poland"

maximum_priceKarakterlánc nullNem kötelező

Maximális termékár

Karakterlánc:maxLength: 19

Korlátozások · Karakterlánc 1

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

minimum_priceKarakterlánc nullNem kötelező

Minimális termékár

Karakterlánc:maxLength: 19

Korlátozások · Karakterlánc 1

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

minimum_subtotalKarakterláncNem kötelező

Minimális kosárérték

maxLength: 19

Korlátozások

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

Alapértelmezett: "0"

minor_unitsEgész számKötelező

A pénznem által használt tizedesjegyek száma.

minimum: 0maximum: 4

Példa: 2

További mezők: Nem

MarketData

shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

currencyKarakterláncKötelező

Az összeg pénznemkódja.

Korlátozások

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

Példa: "PLN"

fixed_amountKarakterláncNem kötelező

Kedvezmény összege

maxLength: 19

Korlátozások

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

Alapértelmezett: "0"

market_idKarakterláncKötelező

A környezetvégpont által visszaadott piacazonosító.

Korlátozások

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

Példa: "poland"

maximum_priceKarakterlánc nullNem kötelező

Maximális termékár

Karakterlánc:maxLength: 19

Korlátozások · Karakterlánc 1

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

minimum_priceKarakterlánc nullNem kötelező

Minimális termékár

Karakterlánc:maxLength: 19

Korlátozások · Karakterlánc 1

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

minimum_subtotalKarakterláncNem kötelező

Minimális kosárérték

maxLength: 19

Korlátozások

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

Alapértelmezett: "0"

minor_unitsEgész számKötelező

A pénznem által használt tizedesjegyek száma.

minimum: 0maximum: 4

Példa: 0

További mezők: Nem