Dataskemaer · Rabatter

dataCampaignData Obligatorisk

Indholdet af et vellykket svar.

Eksempel: {"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 Obligatorisk

Svarmetadata.

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

Yderligere felter: Nej

dataArray <CampaignData > Obligatorisk

Indholdet af et vellykket svar.

Eksempel: []

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatorisk

Svarmetadata.

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

Yderligere felter: Nej

audienceStrengValgfrit

Kunder

Begrænsninger

enum

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

Standard: "all"

benefit_typeStrengValgfrit

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger

enum

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

Standard: "percentage"

category_idsArray <Streng> Valgfrit

Identifikatorer for tilknyttede kategorier.

maxItems: 1000

Begrænsninger · Array 1

pattern

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

codeStreng | nullValgfrit

Stabil maskinlæsbar kode.

Begrænsninger · Streng 1

pattern

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

Eksempel: "LEARN10"

combine_couponsBoolesk værdiValgfrit

Kombinér med andre koder

Standard: false

combine_promotionsBoolesk værdiValgfrit

Tillad denne kode på produkter med automatiske kampagner

Standard: false

customer_idsArray <Streng> Valgfrit

Kundeoplysninger registreret for denne ressource.

maxItems: 1000

Begrænsninger · Array 1

pattern

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

ends_atStreng | nullValgfrit

Aktiv indtil

Streng:format: "date-time"

free_shippingBoolesk værdiValgfrit

Gratis fragt

Standard: false

marketsArray <MarketData-Input > Obligatorisk

Markeder tilgængelige i butikkens kontekst.

minItems: 1maxItems: 1000

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

minimum_quantityHeltalValgfrit

Mindste antal varer i kurven

minimum: 1maximum: 2147483647

Standard: 1

nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

minLength: 1maxLength: 160

Eksempel: "Autumn guide offer"

per_customer_limitHeltalValgfrit

Grænse for anvendelser pr. kunde

minimum: -1maximum: 2147483647

Standard: -1

percentageStrengValgfrit

Procent

maxLength: 19

Begrænsninger

pattern

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

Standard: "10"

product_idsArray <Streng> Valgfrit

Identifikatorer for tilknyttede produkter.

maxItems: 1000

Begrænsninger · Array 1

pattern

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

product_scopeStrengValgfrit

Produkter

Begrænsninger

enum

["all", "selected"]

Standard: "all"

show_accountBoolesk værdiValgfrit

På kundekontoen

Standard: false

show_cartBoolesk værdiValgfrit

I kurven

Standard: false

show_productBoolesk værdiValgfrit

På produktsider

Standard: false

starts_atStreng | nullValgfrit

Aktiv fra

Streng:format: "date-time"

usage_limitHeltalValgfrit

Grænse for anvendelser

minimum: -1maximum: 2147483647

Standard: -1

Yderligere felter: Nej

audienceStrengValgfrit

Kunder

Begrænsninger

enum

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

Standard: "all"

benefit_typeStrengValgfrit

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger

enum

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

Standard: "percentage"

category_idsArray <Streng> Valgfrit

Identifikatorer for tilknyttede kategorier.

maxItems: 1000

Begrænsninger · Array 1

pattern

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

codeStreng | nullValgfrit

Stabil maskinlæsbar kode.

Begrænsninger · Streng 1

pattern

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

combine_couponsBoolesk værdiValgfrit

Kombinér med andre koder

Standard: false

combine_promotionsBoolesk værdiValgfrit

Tillad denne kode på produkter med automatiske kampagner

Standard: false

created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"

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

created_byCreatorData Obligatorisk

Oprettet af

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

customer_idsArray <Streng> Valgfrit

Kundeoplysninger registreret for denne ressource.

maxItems: 1000

Begrænsninger · Array 1

pattern

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

enabledBoolesk værdiObligatorisk

Om denne indstilling er aktiveret.

Eksempel: false

ends_atStreng | nullValgfrit

Aktiv indtil

Streng:format: "date-time"

free_shippingBoolesk værdiValgfrit

Gratis fragt

Standard: false

idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret.

Eksempel: "example-campaign"

kindStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger

enum

["coupon", "promotion"]

Eksempel: "coupon"

marketsArray <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Obligatorisk

Markeder tilgængelige i butikkens kontekst.

minItems: 1maxItems: 1000

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

minimum_quantityHeltalValgfrit

Mindste antal varer i kurven

minimum: 1maximum: 2147483647

Standard: 1

nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

minLength: 1maxLength: 160

Eksempel: "Autumn guide offer"

per_customer_limitHeltalValgfrit

Grænse for anvendelser pr. kunde

minimum: -1maximum: 2147483647

Standard: -1

percentageStrengValgfrit

Procent

maxLength: 19

Begrænsninger

pattern

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

Standard: "10"

product_idsArray <Streng> Valgfrit

Identifikatorer for tilknyttede produkter.

maxItems: 1000

Begrænsninger · Array 1

pattern

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

product_scopeStrengValgfrit

Produkter

Begrænsninger

enum

["all", "selected"]

Standard: "all"

show_accountBoolesk værdiValgfrit

På kundekontoen

Standard: false

show_cartBoolesk værdiValgfrit

I kurven

Standard: false

show_productBoolesk værdiValgfrit

På produktsider

Standard: false

starts_atStreng | nullValgfrit

Aktiv fra

Streng:format: "date-time"

updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"

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

usage_limitHeltalValgfrit

Grænse for anvendelser

minimum: -1maximum: 2147483647

Standard: -1

used_countHeltalObligatorisk

Antal anvendelser

Eksempel: 0

versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

enabledBoolesk værdiObligatorisk

Om denne indstilling er aktiveret.

Eksempel: false

expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1

Yderligere felter: Nej

audienceStrengValgfrit

Kunder

Begrænsninger

enum

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

Standard: "all"

benefit_typeStrengValgfrit

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger

enum

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

Standard: "percentage"

category_idsArray <Streng> Valgfrit

Identifikatorer for tilknyttede kategorier.

maxItems: 1000

Begrænsninger · Array 1

pattern

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

codeStreng | nullValgfrit

Stabil maskinlæsbar kode.

Begrænsninger · Streng 1

pattern

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

Eksempel: "LEARN10"

combine_couponsBoolesk værdiValgfrit

Kombinér med andre koder

Standard: false

combine_promotionsBoolesk værdiValgfrit

Tillad denne kode på produkter med automatiske kampagner

Standard: false

customer_idsArray <Streng> Valgfrit

Kundeoplysninger registreret for denne ressource.

maxItems: 1000

Begrænsninger · Array 1

pattern

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

ends_atStreng | nullValgfrit

Aktiv indtil

Streng:format: "date-time"

expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1

free_shippingBoolesk værdiValgfrit

Gratis fragt

Standard: false

marketsArray <MarketData-Input > Obligatorisk

Markeder tilgængelige i butikkens kontekst.

minItems: 1maxItems: 1000

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

minimum_quantityHeltalValgfrit

Mindste antal varer i kurven

minimum: 1maximum: 2147483647

Standard: 1

nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

minLength: 1maxLength: 160

Eksempel: "Autumn guide offer"

per_customer_limitHeltalValgfrit

Grænse for anvendelser pr. kunde

minimum: -1maximum: 2147483647

Standard: -1

percentageStrengValgfrit

Procent

maxLength: 19

Begrænsninger

pattern

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

Standard: "10"

product_idsArray <Streng> Valgfrit

Identifikatorer for tilknyttede produkter.

maxItems: 1000

Begrænsninger · Array 1

pattern

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

product_scopeStrengValgfrit

Produkter

Begrænsninger

enum

["all", "selected"]

Standard: "all"

show_accountBoolesk værdiValgfrit

På kundekontoen

Standard: false

show_cartBoolesk værdiValgfrit

I kurven

Standard: false

show_productBoolesk værdiValgfrit

På produktsider

Standard: false

starts_atStreng | nullValgfrit

Aktiv fra

Streng:format: "date-time"

usage_limitHeltalValgfrit

Grænse for anvendelser

minimum: -1maximum: 2147483647

Standard: -1

Yderligere felter: Nej

kindStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger

enum

["admin", "api"]

Eksempel: "admin"

labelStrengObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Editorial integration"

referenceStrengObligatorisk

Identifikator for den refererede entitet.

Eksempel: "learn-api-key"

Yderligere felter: Nej

currencyStrengObligatorisk

Valutakode for beløbet.

Begrænsninger

pattern

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

Eksempel: "PLN"

fixed_amountStrengValgfrit

Rabatbeløb

maxLength: 19

Begrænsninger

pattern

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

Standard: "0"

market_idStrengObligatorisk

Markedsidentifikator returneret af kontekstendepunktet.

Begrænsninger

pattern

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

Eksempel: "poland"

maximum_priceStreng | nullValgfrit

Højeste produktpris

Streng:maxLength: 19

Begrænsninger · Streng 1

pattern

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

minimum_priceStreng | nullValgfrit

Laveste produktpris

Streng:maxLength: 19

Begrænsninger · Streng 1

pattern

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

minimum_subtotalStrengValgfrit

Mindste kurveværdi

maxLength: 19

Begrænsninger

pattern

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

Standard: "0"

minor_unitsHeltalObligatorisk

Antal decimaler, som valutaen bruger.

minimum: 0maximum: 4

Eksempel: 2

Yderligere felter: Nej

currencyStrengObligatorisk

Valutakode for beløbet.

Begrænsninger

pattern

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

Eksempel: "PLN"

fixed_amountStrengValgfrit

Rabatbeløb

maxLength: 19

Begrænsninger

pattern

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

Standard: "0"

market_idStrengObligatorisk

Markedsidentifikator returneret af kontekstendepunktet.

Begrænsninger

pattern

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

Eksempel: "poland"

maximum_priceStreng | nullValgfrit

Højeste produktpris

Streng:maxLength: 19

Begrænsninger · Streng 1

pattern

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

minimum_priceStreng | nullValgfrit

Laveste produktpris

Streng:maxLength: 19

Begrænsninger · Streng 1

pattern

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

minimum_subtotalStrengValgfrit

Mindste kurveværdi

maxLength: 19

Begrænsninger

pattern

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

Standard: "0"

minor_unitsHeltalObligatorisk

Antal decimaler, som valutaen bruger.

minimum: 0maximum: 4

Eksempel: 0

Yderligere felter: Nej