Dátové schémy · Zľavy

dataCampaignData Povinné

Obsah úspešnej odpovede.

Príklad: {"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 Povinné

Metaúdaje odpovede.

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

Ďalšie polia: Nie

dataPole <CampaignData > Povinné

Obsah úspešnej odpovede.

Príklad: []

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Povinné

Metaúdaje odpovede.

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

Ďalšie polia: Nie

audienceReťazecVoliteľné

Zákazníci

Obmedzenia

enum

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

Predvolená hodnota: "all"

benefit_typeReťazecVoliteľné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia

enum

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

Predvolená hodnota: "percentage"

category_idsPole <Reťazec> Voliteľné

Identifikátory súvisiacich kategórií.

maxItems: 1000

Obmedzenia · Pole 1

pattern

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

codeReťazec | nullVoliteľné

Stabilný strojovo čitateľný kód.

Obmedzenia · Reťazec 1

pattern

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

Príklad: "LEARN10"

combine_couponsLogická hodnotaVoliteľné

Kombinovať s ďalšími kódmi

Predvolená hodnota: false

combine_promotionsLogická hodnotaVoliteľné

Povoliť tento kód pre produkty s automatickými akciami

Predvolená hodnota: false

customer_idsPole <Reťazec> Voliteľné

Údaje zákazníka zaznamenané pri tomto zdroji.

maxItems: 1000

Obmedzenia · Pole 1

pattern

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

ends_atReťazec | nullVoliteľné

Aktívny do

Reťazec:format: "date-time"

free_shippingLogická hodnotaVoliteľné

Doprava zadarmo

Predvolená hodnota: false

marketsPole <MarketData-Input > Povinné

Trhy dostupné v kontexte obchodu.

minItems: 1maxItems: 1000

Príklad: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityCelé čísloVoliteľné

Minimálny počet kusov v košíku

minimum: 1maximum: 2147483647

Predvolená hodnota: 1

nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

minLength: 1maxLength: 160

Príklad: "Autumn guide offer"

per_customer_limitCelé čísloVoliteľné

Limit použití na zákazníka

minimum: -1maximum: 2147483647

Predvolená hodnota: -1

percentageReťazecVoliteľné

Percentuálna

maxLength: 19

Obmedzenia

pattern

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

Predvolená hodnota: "10"

product_idsPole <Reťazec> Voliteľné

Identifikátory súvisiacich produktov.

maxItems: 1000

Obmedzenia · Pole 1

pattern

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

product_scopeReťazecVoliteľné

Produkty

Obmedzenia

enum

["all", "selected"]

Predvolená hodnota: "all"

show_accountLogická hodnotaVoliteľné

V zákazníckom účte

Predvolená hodnota: false

show_cartLogická hodnotaVoliteľné

V košíku

Predvolená hodnota: false

show_productLogická hodnotaVoliteľné

Na stránkach produktov

Predvolená hodnota: false

starts_atReťazec | nullVoliteľné

Aktívny od

Reťazec:format: "date-time"

usage_limitCelé čísloVoliteľné

Limit použití

minimum: -1maximum: 2147483647

Predvolená hodnota: -1

Ďalšie polia: Nie

audienceReťazecVoliteľné

Zákazníci

Obmedzenia

enum

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

Predvolená hodnota: "all"

benefit_typeReťazecVoliteľné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia

enum

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

Predvolená hodnota: "percentage"

category_idsPole <Reťazec> Voliteľné

Identifikátory súvisiacich kategórií.

maxItems: 1000

Obmedzenia · Pole 1

pattern

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

codeReťazec | nullVoliteľné

Stabilný strojovo čitateľný kód.

Obmedzenia · Reťazec 1

pattern

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

combine_couponsLogická hodnotaVoliteľné

Kombinovať s ďalšími kódmi

Predvolená hodnota: false

combine_promotionsLogická hodnotaVoliteľné

Povoliť tento kód pre produkty s automatickými akciami

Predvolená hodnota: false

created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"

Príklad: "2026-10-07T10:00:00Z"

created_byCreatorData Povinné

Vytvoril

Príklad: {"kind":"admin","label":"Editorial integration","reference":"learn-api-key"}

customer_idsPole <Reťazec> Voliteľné

Údaje zákazníka zaznamenané pri tomto zdroji.

maxItems: 1000

Obmedzenia · Pole 1

pattern

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

enabledLogická hodnotaPovinné

Či je nastavenie zapnuté.

Príklad: false

ends_atReťazec | nullVoliteľné

Aktívny do

Reťazec:format: "date-time"

free_shippingLogická hodnotaVoliteľné

Doprava zadarmo

Predvolená hodnota: false

idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený.

Príklad: "example-campaign"

kindReťazecPovinné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia

enum

["coupon", "promotion"]

Príklad: "coupon"

marketsPole <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Povinné

Trhy dostupné v kontexte obchodu.

minItems: 1maxItems: 1000

Príklad: [{"currency":"PLN","market_id":"poland","minor_units":0}]

minimum_quantityCelé čísloVoliteľné

Minimálny počet kusov v košíku

minimum: 1maximum: 2147483647

Predvolená hodnota: 1

nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

minLength: 1maxLength: 160

Príklad: "Autumn guide offer"

per_customer_limitCelé čísloVoliteľné

Limit použití na zákazníka

minimum: -1maximum: 2147483647

Predvolená hodnota: -1

percentageReťazecVoliteľné

Percentuálna

maxLength: 19

Obmedzenia

pattern

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

Predvolená hodnota: "10"

product_idsPole <Reťazec> Voliteľné

Identifikátory súvisiacich produktov.

maxItems: 1000

Obmedzenia · Pole 1

pattern

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

product_scopeReťazecVoliteľné

Produkty

Obmedzenia

enum

["all", "selected"]

Predvolená hodnota: "all"

show_accountLogická hodnotaVoliteľné

V zákazníckom účte

Predvolená hodnota: false

show_cartLogická hodnotaVoliteľné

V košíku

Predvolená hodnota: false

show_productLogická hodnotaVoliteľné

Na stránkach produktov

Predvolená hodnota: false

starts_atReťazec | nullVoliteľné

Aktívny od

Reťazec:format: "date-time"

updated_atReťazecPovinné

Čas poslednej aktualizácie.

format: "date-time"

Príklad: "2026-10-07T10:00:00Z"

usage_limitCelé čísloVoliteľné

Limit použití

minimum: -1maximum: 2147483647

Predvolená hodnota: -1

used_countCelé čísloPovinné

Počet použití

Príklad: 0

versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

Ďalšie polia: Nie

enabledLogická hodnotaPovinné

Či je nastavenie zapnuté.

Príklad: false

expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1maximum: 9223372036854775807

Príklad: 1

Ďalšie polia: Nie

audienceReťazecVoliteľné

Zákazníci

Obmedzenia

enum

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

Predvolená hodnota: "all"

benefit_typeReťazecVoliteľné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia

enum

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

Predvolená hodnota: "percentage"

category_idsPole <Reťazec> Voliteľné

Identifikátory súvisiacich kategórií.

maxItems: 1000

Obmedzenia · Pole 1

pattern

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

codeReťazec | nullVoliteľné

Stabilný strojovo čitateľný kód.

Obmedzenia · Reťazec 1

pattern

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

Príklad: "LEARN10"

combine_couponsLogická hodnotaVoliteľné

Kombinovať s ďalšími kódmi

Predvolená hodnota: false

combine_promotionsLogická hodnotaVoliteľné

Povoliť tento kód pre produkty s automatickými akciami

Predvolená hodnota: false

customer_idsPole <Reťazec> Voliteľné

Údaje zákazníka zaznamenané pri tomto zdroji.

maxItems: 1000

Obmedzenia · Pole 1

pattern

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

ends_atReťazec | nullVoliteľné

Aktívny do

Reťazec:format: "date-time"

expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1maximum: 9223372036854775807

Príklad: 1

free_shippingLogická hodnotaVoliteľné

Doprava zadarmo

Predvolená hodnota: false

marketsPole <MarketData-Input > Povinné

Trhy dostupné v kontexte obchodu.

minItems: 1maxItems: 1000

Príklad: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityCelé čísloVoliteľné

Minimálny počet kusov v košíku

minimum: 1maximum: 2147483647

Predvolená hodnota: 1

nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

minLength: 1maxLength: 160

Príklad: "Autumn guide offer"

per_customer_limitCelé čísloVoliteľné

Limit použití na zákazníka

minimum: -1maximum: 2147483647

Predvolená hodnota: -1

percentageReťazecVoliteľné

Percentuálna

maxLength: 19

Obmedzenia

pattern

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

Predvolená hodnota: "10"

product_idsPole <Reťazec> Voliteľné

Identifikátory súvisiacich produktov.

maxItems: 1000

Obmedzenia · Pole 1

pattern

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

product_scopeReťazecVoliteľné

Produkty

Obmedzenia

enum

["all", "selected"]

Predvolená hodnota: "all"

show_accountLogická hodnotaVoliteľné

V zákazníckom účte

Predvolená hodnota: false

show_cartLogická hodnotaVoliteľné

V košíku

Predvolená hodnota: false

show_productLogická hodnotaVoliteľné

Na stránkach produktov

Predvolená hodnota: false

starts_atReťazec | nullVoliteľné

Aktívny od

Reťazec:format: "date-time"

usage_limitCelé čísloVoliteľné

Limit použití

minimum: -1maximum: 2147483647

Predvolená hodnota: -1

Ďalšie polia: Nie

kindReťazecPovinné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia

enum

["admin", "api"]

Príklad: "admin"

labelReťazecPovinné

Názov zdroja v príslušnom kontexte.

Príklad: "Editorial integration"

referenceReťazecPovinné

Identifikátor odkazovanej entity.

Príklad: "learn-api-key"

Ďalšie polia: Nie

currencyReťazecPovinné

Kód meny sumy.

Obmedzenia

pattern

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

Príklad: "PLN"

fixed_amountReťazecVoliteľné

Výška zľavy

maxLength: 19

Obmedzenia

pattern

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

Predvolená hodnota: "0"

market_idReťazecPovinné

Identifikátor trhu vrátený koncovým bodom kontextu.

Obmedzenia

pattern

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

Príklad: "poland"

maximum_priceReťazec | nullVoliteľné

Maximálna cena produktu

Reťazec:maxLength: 19

Obmedzenia · Reťazec 1

pattern

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

minimum_priceReťazec | nullVoliteľné

Minimálna cena produktu

Reťazec:maxLength: 19

Obmedzenia · Reťazec 1

pattern

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

minimum_subtotalReťazecVoliteľné

Minimálna hodnota košíka

maxLength: 19

Obmedzenia

pattern

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

Predvolená hodnota: "0"

minor_unitsCelé čísloPovinné

Počet desatinných miest používaných menou.

minimum: 0maximum: 4

Príklad: 2

Ďalšie polia: Nie

currencyReťazecPovinné

Kód meny sumy.

Obmedzenia

pattern

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

Príklad: "PLN"

fixed_amountReťazecVoliteľné

Výška zľavy

maxLength: 19

Obmedzenia

pattern

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

Predvolená hodnota: "0"

market_idReťazecPovinné

Identifikátor trhu vrátený koncovým bodom kontextu.

Obmedzenia

pattern

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

Príklad: "poland"

maximum_priceReťazec | nullVoliteľné

Maximálna cena produktu

Reťazec:maxLength: 19

Obmedzenia · Reťazec 1

pattern

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

minimum_priceReťazec | nullVoliteľné

Minimálna cena produktu

Reťazec:maxLength: 19

Obmedzenia · Reťazec 1

pattern

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

minimum_subtotalReťazecVoliteľné

Minimálna hodnota košíka

maxLength: 19

Obmedzenia

pattern

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

Predvolená hodnota: "0"

minor_unitsCelé čísloPovinné

Počet desatinných miest používaných menou.

minimum: 0maximum: 4

Príklad: 0

Ďalšie polia: Nie