Datová schémata · Slevy

dataCampaignData Povinné

Obsah úspěšné odpovědi.

Pří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é

Metadata odpovědi.

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

Další pole: Ne

dataPole <CampaignData > Povinné

Obsah úspěšné odpovědi.

Příklad: []

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Povinné

Metadata odpovědi.

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

Další pole: Ne

audienceŘetězecVolitelné

Zákazníci

Omezení

enum

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

Výchozí hodnota: "all"

benefit_typeŘetězecVolitelné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení

enum

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

Výchozí hodnota: "percentage"

category_idsPole <Řetězec> Volitelné

Identifikátory souvisejících kategorií.

maxItems: 1000

Omezení · Pole 1

pattern

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

codeŘetězec | nullVolitelné

Stabilní strojově čitelný kód.

Omezení · Řetězec 1

pattern

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

Příklad: "LEARN10"

combine_couponsLogická hodnotaVolitelné

Kombinovat s dalšími kódy

Výchozí hodnota: false

combine_promotionsLogická hodnotaVolitelné

Povolit tento kód u produktů s automatickými akcemi

Výchozí hodnota: false

customer_idsPole <Řetězec> Volitelné

Údaje zákazníka zaznamenané u tohoto zdroje.

maxItems: 1000

Omezení · Pole 1

pattern

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

ends_atŘetězec | nullVolitelné

Aktivní do

Řetězec:format: "date-time"

free_shippingLogická hodnotaVolitelné

Doprava zdarma

Výchozí hodnota: false

marketsPole <MarketData-Input > Povinné

Trhy dostupné v kontextu obchodu.

minItems: 1maxItems: 1000

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

minimum_quantityCelé čísloVolitelné

Minimální počet kusů v košíku

minimum: 1maximum: 2147483647

Výchozí hodnota: 1

nameŘetězecPovinné

Název zdroje v příslušném kontextu.

minLength: 1maxLength: 160

Příklad: "Autumn guide offer"

per_customer_limitCelé čísloVolitelné

Limit použití na zákazníka

minimum: -1maximum: 2147483647

Výchozí hodnota: -1

percentageŘetězecVolitelné

Procentní

maxLength: 19

Omezení

pattern

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

Výchozí hodnota: "10"

product_idsPole <Řetězec> Volitelné

Identifikátory souvisejících produktů.

maxItems: 1000

Omezení · Pole 1

pattern

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

product_scopeŘetězecVolitelné

Produkty

Omezení

enum

["all", "selected"]

Výchozí hodnota: "all"

show_accountLogická hodnotaVolitelné

V zákaznickém účtu

Výchozí hodnota: false

show_cartLogická hodnotaVolitelné

V košíku

Výchozí hodnota: false

show_productLogická hodnotaVolitelné

Na stránkách produktů

Výchozí hodnota: false

starts_atŘetězec | nullVolitelné

Aktivní od

Řetězec:format: "date-time"

usage_limitCelé čísloVolitelné

Limit použití

minimum: -1maximum: 2147483647

Výchozí hodnota: -1

Další pole: Ne

audienceŘetězecVolitelné

Zákazníci

Omezení

enum

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

Výchozí hodnota: "all"

benefit_typeŘetězecVolitelné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení

enum

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

Výchozí hodnota: "percentage"

category_idsPole <Řetězec> Volitelné

Identifikátory souvisejících kategorií.

maxItems: 1000

Omezení · Pole 1

pattern

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

codeŘetězec | nullVolitelné

Stabilní strojově čitelný kód.

Omezení · Řetězec 1

pattern

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

combine_couponsLogická hodnotaVolitelné

Kombinovat s dalšími kódy

Výchozí hodnota: false

combine_promotionsLogická hodnotaVolitelné

Povolit tento kód u produktů s automatickými akcemi

Výchozí hodnota: false

created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"

Příklad: "2026-10-07T10:00:00Z"

created_byCreatorData Povinné

Vytvořil

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

customer_idsPole <Řetězec> Volitelné

Údaje zákazníka zaznamenané u tohoto zdroje.

maxItems: 1000

Omezení · Pole 1

pattern

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

enabledLogická hodnotaPovinné

Zda je nastavení zapnuto.

Příklad: false

ends_atŘetězec | nullVolitelné

Aktivní do

Řetězec:format: "date-time"

free_shippingLogická hodnotaVolitelné

Doprava zdarma

Výchozí hodnota: false

idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen.

Příklad: "example-campaign"

kindŘetězecPovinné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení

enum

["coupon", "promotion"]

Příklad: "coupon"

marketsPole <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Povinné

Trhy dostupné v kontextu obchodu.

minItems: 1maxItems: 1000

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

minimum_quantityCelé čísloVolitelné

Minimální počet kusů v košíku

minimum: 1maximum: 2147483647

Výchozí hodnota: 1

nameŘetězecPovinné

Název zdroje v příslušném kontextu.

minLength: 1maxLength: 160

Příklad: "Autumn guide offer"

per_customer_limitCelé čísloVolitelné

Limit použití na zákazníka

minimum: -1maximum: 2147483647

Výchozí hodnota: -1

percentageŘetězecVolitelné

Procentní

maxLength: 19

Omezení

pattern

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

Výchozí hodnota: "10"

product_idsPole <Řetězec> Volitelné

Identifikátory souvisejících produktů.

maxItems: 1000

Omezení · Pole 1

pattern

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

product_scopeŘetězecVolitelné

Produkty

Omezení

enum

["all", "selected"]

Výchozí hodnota: "all"

show_accountLogická hodnotaVolitelné

V zákaznickém účtu

Výchozí hodnota: false

show_cartLogická hodnotaVolitelné

V košíku

Výchozí hodnota: false

show_productLogická hodnotaVolitelné

Na stránkách produktů

Výchozí hodnota: false

starts_atŘetězec | nullVolitelné

Aktivní od

Řetězec:format: "date-time"

updated_atŘetězecPovinné

Čas poslední aktualizace.

format: "date-time"

Příklad: "2026-10-07T10:00:00Z"

usage_limitCelé čísloVolitelné

Limit použití

minimum: -1maximum: 2147483647

Výchozí hodnota: -1

used_countCelé čísloPovinné

Počet použití

Příklad: 0

versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

Další pole: Ne

enabledLogická hodnotaPovinné

Zda je nastavení zapnuto.

Příklad: false

expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1maximum: 9223372036854775807

Příklad: 1

Další pole: Ne

audienceŘetězecVolitelné

Zákazníci

Omezení

enum

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

Výchozí hodnota: "all"

benefit_typeŘetězecVolitelné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení

enum

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

Výchozí hodnota: "percentage"

category_idsPole <Řetězec> Volitelné

Identifikátory souvisejících kategorií.

maxItems: 1000

Omezení · Pole 1

pattern

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

codeŘetězec | nullVolitelné

Stabilní strojově čitelný kód.

Omezení · Řetězec 1

pattern

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

Příklad: "LEARN10"

combine_couponsLogická hodnotaVolitelné

Kombinovat s dalšími kódy

Výchozí hodnota: false

combine_promotionsLogická hodnotaVolitelné

Povolit tento kód u produktů s automatickými akcemi

Výchozí hodnota: false

customer_idsPole <Řetězec> Volitelné

Údaje zákazníka zaznamenané u tohoto zdroje.

maxItems: 1000

Omezení · Pole 1

pattern

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

ends_atŘetězec | nullVolitelné

Aktivní do

Řetězec:format: "date-time"

expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1maximum: 9223372036854775807

Příklad: 1

free_shippingLogická hodnotaVolitelné

Doprava zdarma

Výchozí hodnota: false

marketsPole <MarketData-Input > Povinné

Trhy dostupné v kontextu obchodu.

minItems: 1maxItems: 1000

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

minimum_quantityCelé čísloVolitelné

Minimální počet kusů v košíku

minimum: 1maximum: 2147483647

Výchozí hodnota: 1

nameŘetězecPovinné

Název zdroje v příslušném kontextu.

minLength: 1maxLength: 160

Příklad: "Autumn guide offer"

per_customer_limitCelé čísloVolitelné

Limit použití na zákazníka

minimum: -1maximum: 2147483647

Výchozí hodnota: -1

percentageŘetězecVolitelné

Procentní

maxLength: 19

Omezení

pattern

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

Výchozí hodnota: "10"

product_idsPole <Řetězec> Volitelné

Identifikátory souvisejících produktů.

maxItems: 1000

Omezení · Pole 1

pattern

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

product_scopeŘetězecVolitelné

Produkty

Omezení

enum

["all", "selected"]

Výchozí hodnota: "all"

show_accountLogická hodnotaVolitelné

V zákaznickém účtu

Výchozí hodnota: false

show_cartLogická hodnotaVolitelné

V košíku

Výchozí hodnota: false

show_productLogická hodnotaVolitelné

Na stránkách produktů

Výchozí hodnota: false

starts_atŘetězec | nullVolitelné

Aktivní od

Řetězec:format: "date-time"

usage_limitCelé čísloVolitelné

Limit použití

minimum: -1maximum: 2147483647

Výchozí hodnota: -1

Další pole: Ne

kindŘetězecPovinné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení

enum

["admin", "api"]

Příklad: "admin"

labelŘetězecPovinné

Název zdroje v příslušném kontextu.

Příklad: "Editorial integration"

referenceŘetězecPovinné

Identifikátor odkazované entity.

Příklad: "learn-api-key"

Další pole: Ne

currencyŘetězecPovinné

Kód měny částky.

Omezení

pattern

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

Příklad: "PLN"

fixed_amountŘetězecVolitelné

Výše slevy

maxLength: 19

Omezení

pattern

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

Výchozí hodnota: "0"

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

Omezení

pattern

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

Příklad: "poland"

maximum_priceŘetězec | nullVolitelné

Maximální cena produktu

Řetězec:maxLength: 19

Omezení · Řetězec 1

pattern

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

minimum_priceŘetězec | nullVolitelné

Minimální cena produktu

Řetězec:maxLength: 19

Omezení · Řetězec 1

pattern

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

minimum_subtotalŘetězecVolitelné

Minimální hodnota košíku

maxLength: 19

Omezení

pattern

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

Výchozí hodnota: "0"

minor_unitsCelé čísloPovinné

Počet desetinných míst používaných měnou.

minimum: 0maximum: 4

Příklad: 2

Další pole: Ne

currencyŘetězecPovinné

Kód měny částky.

Omezení

pattern

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

Příklad: "PLN"

fixed_amountŘetězecVolitelné

Výše slevy

maxLength: 19

Omezení

pattern

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

Výchozí hodnota: "0"

market_idŘetězecPovinné

Identifikátor trhu vrácený koncovým bodem kontextu.

Omezení

pattern

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

Příklad: "poland"

maximum_priceŘetězec | nullVolitelné

Maximální cena produktu

Řetězec:maxLength: 19

Omezení · Řetězec 1

pattern

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

minimum_priceŘetězec | nullVolitelné

Minimální cena produktu

Řetězec:maxLength: 19

Omezení · Řetězec 1

pattern

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

minimum_subtotalŘetězecVolitelné

Minimální hodnota košíku

maxLength: 19

Omezení

pattern

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

Výchozí hodnota: "0"

minor_unitsCelé čísloPovinné

Počet desetinných míst používaných měnou.

minimum: 0maximum: 4

Příklad: 0

Další pole: Ne