Dataskjemaer · Rabatter

dataCampaignData Obligatorisk

Innholdet i 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"}

Ytterligere felt: Nei

dataArray <CampaignData > Obligatorisk

Innholdet i 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"}

Ytterligere felt: Nei

audienceStrengValgfritt

Kunder

Begrensninger

enum

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

Standard: "all"

benefit_typeStrengValgfritt

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger

enum

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

Standard: "percentage"

category_idsArray <Streng> Valgfritt

Identifikatorer for tilknyttede kategorier.

maxItems: 1000

Begrensninger · Array 1

pattern

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

codeStreng | nullValgfritt

Stabil maskinlesbar kode.

Begrensninger · Streng 1

pattern

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

Eksempel: "LEARN10"

combine_couponsBoolsk verdiValgfritt

Kombiner med andre koder

Standard: false

combine_promotionsBoolsk verdiValgfritt

Tillat denne koden på produkter med automatiske kampanjer

Standard: false

customer_idsArray <Streng> Valgfritt

Kundeinformasjon registrert for denne ressursen.

maxItems: 1000

Begrensninger · Array 1

pattern

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

ends_atStreng | nullValgfritt

Aktiv til

Streng:format: "date-time"

free_shippingBoolsk verdiValgfritt

Gratis frakt

Standard: false

marketsArray <MarketData-Input > Obligatorisk

Markeder tilgjengelige i butikkens kontekst.

minItems: 1maxItems: 1000

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

minimum_quantityHeltallValgfritt

Minste antall varer i handlekurven

minimum: 1maximum: 2147483647

Standard: 1

nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

minLength: 1maxLength: 160

Eksempel: "Autumn guide offer"

per_customer_limitHeltallValgfritt

Bruksgrense per kunde

minimum: -1maximum: 2147483647

Standard: -1

percentageStrengValgfritt

Prosent

maxLength: 19

Begrensninger

pattern

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

Standard: "10"

product_idsArray <Streng> Valgfritt

Identifikatorer for tilknyttede produkter.

maxItems: 1000

Begrensninger · Array 1

pattern

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

product_scopeStrengValgfritt

Produkter

Begrensninger

enum

["all", "selected"]

Standard: "all"

show_accountBoolsk verdiValgfritt

På kundekontoen

Standard: false

show_cartBoolsk verdiValgfritt

I handlekurven

Standard: false

show_productBoolsk verdiValgfritt

På produktsider

Standard: false

starts_atStreng | nullValgfritt

Aktiv fra

Streng:format: "date-time"

usage_limitHeltallValgfritt

Bruksgrense

minimum: -1maximum: 2147483647

Standard: -1

Ytterligere felt: Nei

audienceStrengValgfritt

Kunder

Begrensninger

enum

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

Standard: "all"

benefit_typeStrengValgfritt

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger

enum

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

Standard: "percentage"

category_idsArray <Streng> Valgfritt

Identifikatorer for tilknyttede kategorier.

maxItems: 1000

Begrensninger · Array 1

pattern

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

codeStreng | nullValgfritt

Stabil maskinlesbar kode.

Begrensninger · Streng 1

pattern

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

combine_couponsBoolsk verdiValgfritt

Kombiner med andre koder

Standard: false

combine_promotionsBoolsk verdiValgfritt

Tillat denne koden på produkter med automatiske kampanjer

Standard: false

created_atStrengObligatorisk

Opprettelsestidspunkt.

format: "date-time"

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

created_byCreatorData Obligatorisk

Opprettet av

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

customer_idsArray <Streng> Valgfritt

Kundeinformasjon registrert for denne ressursen.

maxItems: 1000

Begrensninger · Array 1

pattern

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

enabledBoolsk verdiObligatorisk

Om denne innstillingen er aktivert.

Eksempel: false

ends_atStreng | nullValgfritt

Aktiv til

Streng:format: "date-time"

free_shippingBoolsk verdiValgfritt

Gratis frakt

Standard: false

idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres.

Eksempel: "example-campaign"

kindStrengObligatorisk

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger

enum

["coupon", "promotion"]

Eksempel: "coupon"

marketsArray <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Obligatorisk

Markeder tilgjengelige i butikkens kontekst.

minItems: 1maxItems: 1000

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

minimum_quantityHeltallValgfritt

Minste antall varer i handlekurven

minimum: 1maximum: 2147483647

Standard: 1

nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

minLength: 1maxLength: 160

Eksempel: "Autumn guide offer"

per_customer_limitHeltallValgfritt

Bruksgrense per kunde

minimum: -1maximum: 2147483647

Standard: -1

percentageStrengValgfritt

Prosent

maxLength: 19

Begrensninger

pattern

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

Standard: "10"

product_idsArray <Streng> Valgfritt

Identifikatorer for tilknyttede produkter.

maxItems: 1000

Begrensninger · Array 1

pattern

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

product_scopeStrengValgfritt

Produkter

Begrensninger

enum

["all", "selected"]

Standard: "all"

show_accountBoolsk verdiValgfritt

På kundekontoen

Standard: false

show_cartBoolsk verdiValgfritt

I handlekurven

Standard: false

show_productBoolsk verdiValgfritt

På produktsider

Standard: false

starts_atStreng | nullValgfritt

Aktiv fra

Streng:format: "date-time"

updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"

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

usage_limitHeltallValgfritt

Bruksgrense

minimum: -1maximum: 2147483647

Standard: -1

used_countHeltallObligatorisk

Antall ganger brukt

Eksempel: 0

versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

enabledBoolsk verdiObligatorisk

Om denne innstillingen er aktivert.

Eksempel: false

expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1

Ytterligere felt: Nei

audienceStrengValgfritt

Kunder

Begrensninger

enum

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

Standard: "all"

benefit_typeStrengValgfritt

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger

enum

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

Standard: "percentage"

category_idsArray <Streng> Valgfritt

Identifikatorer for tilknyttede kategorier.

maxItems: 1000

Begrensninger · Array 1

pattern

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

codeStreng | nullValgfritt

Stabil maskinlesbar kode.

Begrensninger · Streng 1

pattern

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

Eksempel: "LEARN10"

combine_couponsBoolsk verdiValgfritt

Kombiner med andre koder

Standard: false

combine_promotionsBoolsk verdiValgfritt

Tillat denne koden på produkter med automatiske kampanjer

Standard: false

customer_idsArray <Streng> Valgfritt

Kundeinformasjon registrert for denne ressursen.

maxItems: 1000

Begrensninger · Array 1

pattern

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

ends_atStreng | nullValgfritt

Aktiv til

Streng:format: "date-time"

expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1

free_shippingBoolsk verdiValgfritt

Gratis frakt

Standard: false

marketsArray <MarketData-Input > Obligatorisk

Markeder tilgjengelige i butikkens kontekst.

minItems: 1maxItems: 1000

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

minimum_quantityHeltallValgfritt

Minste antall varer i handlekurven

minimum: 1maximum: 2147483647

Standard: 1

nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

minLength: 1maxLength: 160

Eksempel: "Autumn guide offer"

per_customer_limitHeltallValgfritt

Bruksgrense per kunde

minimum: -1maximum: 2147483647

Standard: -1

percentageStrengValgfritt

Prosent

maxLength: 19

Begrensninger

pattern

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

Standard: "10"

product_idsArray <Streng> Valgfritt

Identifikatorer for tilknyttede produkter.

maxItems: 1000

Begrensninger · Array 1

pattern

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

product_scopeStrengValgfritt

Produkter

Begrensninger

enum

["all", "selected"]

Standard: "all"

show_accountBoolsk verdiValgfritt

På kundekontoen

Standard: false

show_cartBoolsk verdiValgfritt

I handlekurven

Standard: false

show_productBoolsk verdiValgfritt

På produktsider

Standard: false

starts_atStreng | nullValgfritt

Aktiv fra

Streng:format: "date-time"

usage_limitHeltallValgfritt

Bruksgrense

minimum: -1maximum: 2147483647

Standard: -1

Ytterligere felt: Nei

kindStrengObligatorisk

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger

enum

["admin", "api"]

Eksempel: "admin"

labelStrengObligatorisk

Ressursens navn i den relevante konteksten.

Eksempel: "Editorial integration"

referenceStrengObligatorisk

Identifikator for den refererte entiteten.

Eksempel: "learn-api-key"

Ytterligere felt: Nei

currencyStrengObligatorisk

Valutakode for beløpet.

Begrensninger

pattern

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

Eksempel: "PLN"

fixed_amountStrengValgfritt

Rabattbeløp

maxLength: 19

Begrensninger

pattern

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

Standard: "0"

market_idStrengObligatorisk

Markedsidentifikator returnert av kontekstendepunktet.

Begrensninger

pattern

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

Eksempel: "poland"

maximum_priceStreng | nullValgfritt

Høyeste produktpris

Streng:maxLength: 19

Begrensninger · Streng 1

pattern

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

minimum_priceStreng | nullValgfritt

Laveste produktpris

Streng:maxLength: 19

Begrensninger · Streng 1

pattern

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

minimum_subtotalStrengValgfritt

Minste handlekurvverdi

maxLength: 19

Begrensninger

pattern

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

Standard: "0"

minor_unitsHeltallObligatorisk

Antall desimalsifre valutaen bruker.

minimum: 0maximum: 4

Eksempel: 2

Ytterligere felt: Nei

currencyStrengObligatorisk

Valutakode for beløpet.

Begrensninger

pattern

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

Eksempel: "PLN"

fixed_amountStrengValgfritt

Rabattbeløp

maxLength: 19

Begrensninger

pattern

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

Standard: "0"

market_idStrengObligatorisk

Markedsidentifikator returnert av kontekstendepunktet.

Begrensninger

pattern

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

Eksempel: "poland"

maximum_priceStreng | nullValgfritt

Høyeste produktpris

Streng:maxLength: 19

Begrensninger · Streng 1

pattern

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

minimum_priceStreng | nullValgfritt

Laveste produktpris

Streng:maxLength: 19

Begrensninger · Streng 1

pattern

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

minimum_subtotalStrengValgfritt

Minste handlekurvverdi

maxLength: 19

Begrensninger

pattern

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

Standard: "0"

minor_unitsHeltallObligatorisk

Antall desimalsifre valutaen bruker.

minimum: 0maximum: 4

Eksempel: 0

Ytterligere felt: Nei