Tietoskeemat · Alennukset

dataCampaignData Pakollinen

Onnistuneen vastauksen sisältö.

Esimerkki: {"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 Pakollinen

Vastauksen metatiedot.

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

Lisäkentät: Ei

dataTaulukko <CampaignData > Pakollinen

Onnistuneen vastauksen sisältö.

Esimerkki: []

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Pakollinen

Vastauksen metatiedot.

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

Lisäkentät: Ei

audienceMerkkijonoValinnainen

Asiakkaat

Rajoitukset

enum

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

Oletus: "all"

benefit_typeMerkkijonoValinnainen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum

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

Oletus: "percentage"

category_idsTaulukko <Merkkijono> Valinnainen

Liittyvien kategorioiden tunnisteet.

maxItems: 1000

Rajoitukset · Taulukko 1

pattern

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

codeMerkkijono | nullValinnainen

Vakaa koneellisesti luettava koodi.

Rajoitukset · Merkkijono 1

pattern

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

Esimerkki: "LEARN10"

combine_couponsTotuusarvoValinnainen

Yhdistä muihin koodeihin

Oletus: false

combine_promotionsTotuusarvoValinnainen

Salli tämä koodi automaattisten kampanjoiden tuotteille

Oletus: false

customer_idsTaulukko <Merkkijono> Valinnainen

Tälle resurssille kirjatut asiakastiedot.

maxItems: 1000

Rajoitukset · Taulukko 1

pattern

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

ends_atMerkkijono | nullValinnainen

Voimassa asti

Merkkijono:format: "date-time"

free_shippingTotuusarvoValinnainen

Ilmainen toimitus

Oletus: false

marketsTaulukko <MarketData-Input > Pakollinen

Kaupan kontekstissa käytettävissä olevat markkina-alueet.

minItems: 1maxItems: 1000

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

minimum_quantityKokonaislukuValinnainen

Ostoskorin tuotteiden vähimmäismäärä

minimum: 1maximum: 2147483647

Oletus: 1

nameMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

minLength: 1maxLength: 160

Esimerkki: "Autumn guide offer"

per_customer_limitKokonaislukuValinnainen

Asiakaskohtainen käyttöraja

minimum: -1maximum: 2147483647

Oletus: -1

percentageMerkkijonoValinnainen

Prosentti

maxLength: 19

Rajoitukset

pattern

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

Oletus: "10"

product_idsTaulukko <Merkkijono> Valinnainen

Liittyvien tuotteiden tunnisteet.

maxItems: 1000

Rajoitukset · Taulukko 1

pattern

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

product_scopeMerkkijonoValinnainen

Tuotteet

Rajoitukset

enum

["all", "selected"]

Oletus: "all"

show_accountTotuusarvoValinnainen

Asiakastilillä

Oletus: false

show_cartTotuusarvoValinnainen

Ostoskorissa

Oletus: false

show_productTotuusarvoValinnainen

Tuotesivuilla

Oletus: false

starts_atMerkkijono | nullValinnainen

Voimassa alkaen

Merkkijono:format: "date-time"

usage_limitKokonaislukuValinnainen

Käyttöraja

minimum: -1maximum: 2147483647

Oletus: -1

Lisäkentät: Ei

audienceMerkkijonoValinnainen

Asiakkaat

Rajoitukset

enum

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

Oletus: "all"

benefit_typeMerkkijonoValinnainen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum

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

Oletus: "percentage"

category_idsTaulukko <Merkkijono> Valinnainen

Liittyvien kategorioiden tunnisteet.

maxItems: 1000

Rajoitukset · Taulukko 1

pattern

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

codeMerkkijono | nullValinnainen

Vakaa koneellisesti luettava koodi.

Rajoitukset · Merkkijono 1

pattern

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

combine_couponsTotuusarvoValinnainen

Yhdistä muihin koodeihin

Oletus: false

combine_promotionsTotuusarvoValinnainen

Salli tämä koodi automaattisten kampanjoiden tuotteille

Oletus: false

created_atMerkkijonoPakollinen

Luontiajankohta.

format: "date-time"

Esimerkki: "2026-10-07T10:00:00Z"

created_byCreatorData Pakollinen

Luonut

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

customer_idsTaulukko <Merkkijono> Valinnainen

Tälle resurssille kirjatut asiakastiedot.

maxItems: 1000

Rajoitukset · Taulukko 1

pattern

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

enabledTotuusarvoPakollinen

Onko tämä asetus käytössä.

Esimerkki: false

ends_atMerkkijono | nullValinnainen

Voimassa asti

Merkkijono:format: "date-time"

free_shippingTotuusarvoValinnainen

Ilmainen toimitus

Oletus: false

idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa.

Esimerkki: "example-campaign"

kindMerkkijonoPakollinen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum

["coupon", "promotion"]

Esimerkki: "coupon"

marketsTaulukko <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Pakollinen

Kaupan kontekstissa käytettävissä olevat markkina-alueet.

minItems: 1maxItems: 1000

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

minimum_quantityKokonaislukuValinnainen

Ostoskorin tuotteiden vähimmäismäärä

minimum: 1maximum: 2147483647

Oletus: 1

nameMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

minLength: 1maxLength: 160

Esimerkki: "Autumn guide offer"

per_customer_limitKokonaislukuValinnainen

Asiakaskohtainen käyttöraja

minimum: -1maximum: 2147483647

Oletus: -1

percentageMerkkijonoValinnainen

Prosentti

maxLength: 19

Rajoitukset

pattern

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

Oletus: "10"

product_idsTaulukko <Merkkijono> Valinnainen

Liittyvien tuotteiden tunnisteet.

maxItems: 1000

Rajoitukset · Taulukko 1

pattern

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

product_scopeMerkkijonoValinnainen

Tuotteet

Rajoitukset

enum

["all", "selected"]

Oletus: "all"

show_accountTotuusarvoValinnainen

Asiakastilillä

Oletus: false

show_cartTotuusarvoValinnainen

Ostoskorissa

Oletus: false

show_productTotuusarvoValinnainen

Tuotesivuilla

Oletus: false

starts_atMerkkijono | nullValinnainen

Voimassa alkaen

Merkkijono:format: "date-time"

updated_atMerkkijonoPakollinen

Viimeisimmän päivityksen ajankohta.

format: "date-time"

Esimerkki: "2026-10-07T10:00:00Z"

usage_limitKokonaislukuValinnainen

Käyttöraja

minimum: -1maximum: 2147483647

Oletus: -1

used_countKokonaislukuPakollinen

Käyttökerrat

Esimerkki: 0

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

enabledTotuusarvoPakollinen

Onko tämä asetus käytössä.

Esimerkki: false

expected_versionKokonaislukuPakollinen

Ennen kirjoitusta luettu versio; ristiriita hylkää päivityksen.

minimum: 1maximum: 9223372036854775807

Esimerkki: 1

Lisäkentät: Ei

audienceMerkkijonoValinnainen

Asiakkaat

Rajoitukset

enum

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

Oletus: "all"

benefit_typeMerkkijonoValinnainen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum

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

Oletus: "percentage"

category_idsTaulukko <Merkkijono> Valinnainen

Liittyvien kategorioiden tunnisteet.

maxItems: 1000

Rajoitukset · Taulukko 1

pattern

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

codeMerkkijono | nullValinnainen

Vakaa koneellisesti luettava koodi.

Rajoitukset · Merkkijono 1

pattern

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

Esimerkki: "LEARN10"

combine_couponsTotuusarvoValinnainen

Yhdistä muihin koodeihin

Oletus: false

combine_promotionsTotuusarvoValinnainen

Salli tämä koodi automaattisten kampanjoiden tuotteille

Oletus: false

customer_idsTaulukko <Merkkijono> Valinnainen

Tälle resurssille kirjatut asiakastiedot.

maxItems: 1000

Rajoitukset · Taulukko 1

pattern

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

ends_atMerkkijono | nullValinnainen

Voimassa asti

Merkkijono:format: "date-time"

expected_versionKokonaislukuPakollinen

Ennen kirjoitusta luettu versio; ristiriita hylkää päivityksen.

minimum: 1maximum: 9223372036854775807

Esimerkki: 1

free_shippingTotuusarvoValinnainen

Ilmainen toimitus

Oletus: false

marketsTaulukko <MarketData-Input > Pakollinen

Kaupan kontekstissa käytettävissä olevat markkina-alueet.

minItems: 1maxItems: 1000

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

minimum_quantityKokonaislukuValinnainen

Ostoskorin tuotteiden vähimmäismäärä

minimum: 1maximum: 2147483647

Oletus: 1

nameMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

minLength: 1maxLength: 160

Esimerkki: "Autumn guide offer"

per_customer_limitKokonaislukuValinnainen

Asiakaskohtainen käyttöraja

minimum: -1maximum: 2147483647

Oletus: -1

percentageMerkkijonoValinnainen

Prosentti

maxLength: 19

Rajoitukset

pattern

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

Oletus: "10"

product_idsTaulukko <Merkkijono> Valinnainen

Liittyvien tuotteiden tunnisteet.

maxItems: 1000

Rajoitukset · Taulukko 1

pattern

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

product_scopeMerkkijonoValinnainen

Tuotteet

Rajoitukset

enum

["all", "selected"]

Oletus: "all"

show_accountTotuusarvoValinnainen

Asiakastilillä

Oletus: false

show_cartTotuusarvoValinnainen

Ostoskorissa

Oletus: false

show_productTotuusarvoValinnainen

Tuotesivuilla

Oletus: false

starts_atMerkkijono | nullValinnainen

Voimassa alkaen

Merkkijono:format: "date-time"

usage_limitKokonaislukuValinnainen

Käyttöraja

minimum: -1maximum: 2147483647

Oletus: -1

Lisäkentät: Ei

kindMerkkijonoPakollinen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum

["admin", "api"]

Esimerkki: "admin"

labelMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Editorial integration"

referenceMerkkijonoPakollinen

Viitatun entiteetin tunniste.

Esimerkki: "learn-api-key"

Lisäkentät: Ei

currencyMerkkijonoPakollinen

Summan valuuttakoodi.

Rajoitukset

pattern

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

Esimerkki: "PLN"

fixed_amountMerkkijonoValinnainen

Alennuksen määrä

maxLength: 19

Rajoitukset

pattern

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

Oletus: "0"

market_idMerkkijonoPakollinen

Kontekstipäätepisteen palauttama markkinatunniste.

Rajoitukset

pattern

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

Esimerkki: "poland"

maximum_priceMerkkijono | nullValinnainen

Tuotteen enimmäishinta

Merkkijono:maxLength: 19

Rajoitukset · Merkkijono 1

pattern

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

minimum_priceMerkkijono | nullValinnainen

Tuotteen vähimmäishinta

Merkkijono:maxLength: 19

Rajoitukset · Merkkijono 1

pattern

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

minimum_subtotalMerkkijonoValinnainen

Ostoskorin vähimmäisarvo

maxLength: 19

Rajoitukset

pattern

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

Oletus: "0"

minor_unitsKokonaislukuPakollinen

Valuutan käyttämien desimaalinumeroiden määrä.

minimum: 0maximum: 4

Esimerkki: 2

Lisäkentät: Ei

currencyMerkkijonoPakollinen

Summan valuuttakoodi.

Rajoitukset

pattern

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

Esimerkki: "PLN"

fixed_amountMerkkijonoValinnainen

Alennuksen määrä

maxLength: 19

Rajoitukset

pattern

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

Oletus: "0"

market_idMerkkijonoPakollinen

Kontekstipäätepisteen palauttama markkinatunniste.

Rajoitukset

pattern

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

Esimerkki: "poland"

maximum_priceMerkkijono | nullValinnainen

Tuotteen enimmäishinta

Merkkijono:maxLength: 19

Rajoitukset · Merkkijono 1

pattern

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

minimum_priceMerkkijono | nullValinnainen

Tuotteen vähimmäishinta

Merkkijono:maxLength: 19

Rajoitukset · Merkkijono 1

pattern

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

minimum_subtotalMerkkijonoValinnainen

Ostoskorin vähimmäisarvo

maxLength: 19

Rajoitukset

pattern

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

Oletus: "0"

minor_unitsKokonaislukuPakollinen

Valuutan käyttämien desimaalinumeroiden määrä.

minimum: 0maximum: 4

Esimerkki: 0

Lisäkentät: Ei