Datascheman · Rabatter

dataCampaignData Obligatoriskt

Innehållet i ett lyckat svar.

Exempel: {"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 Obligatoriskt

Metadata för svaret.

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

Ytterligare fält: Nej

dataArray <CampaignData > Obligatoriskt

Innehållet i ett lyckat svar.

Exempel: []

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatoriskt

Metadata för svaret.

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

Ytterligare fält: Nej

audienceSträngValfritt

Kunder

Begränsningar

enum

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

Standardvärde: "all"

benefit_typeSträngValfritt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar

enum

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

Standardvärde: "percentage"

category_idsArray <Sträng> Valfritt

Identifierare för relaterade kategorier.

maxItems: 1000

Begränsningar · Array 1

pattern

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

codeSträng | nullValfritt

Stabil maskinläsbar kod.

Begränsningar · Sträng 1

pattern

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

Exempel: "LEARN10"

combine_couponsBooleskt värdeValfritt

Kombinera med andra koder

Standardvärde: false

combine_promotionsBooleskt värdeValfritt

Tillåt denna kod på produkter med automatiska kampanjer

Standardvärde: false

customer_idsArray <Sträng> Valfritt

Kunduppgifter registrerade för resursen.

maxItems: 1000

Begränsningar · Array 1

pattern

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

ends_atSträng | nullValfritt

Aktiv till

Sträng:format: "date-time"

free_shippingBooleskt värdeValfritt

Fri frakt

Standardvärde: false

marketsArray <MarketData-Input > Obligatoriskt

Marknader som är tillgängliga i butikens kontext.

minItems: 1maxItems: 1000

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

minimum_quantityHeltalValfritt

Minsta antal artiklar i varukorgen

minimum: 1maximum: 2147483647

Standardvärde: 1

nameSträngObligatoriskt

Resursens namn i aktuell kontext.

minLength: 1maxLength: 160

Exempel: "Autumn guide offer"

per_customer_limitHeltalValfritt

Användningsgräns per kund

minimum: -1maximum: 2147483647

Standardvärde: -1

percentageSträngValfritt

Procent

maxLength: 19

Begränsningar

pattern

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

Standardvärde: "10"

product_idsArray <Sträng> Valfritt

Identifierare för relaterade produkter.

maxItems: 1000

Begränsningar · Array 1

pattern

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

product_scopeSträngValfritt

Produkter

Begränsningar

enum

["all", "selected"]

Standardvärde: "all"

show_accountBooleskt värdeValfritt

På kundkontot

Standardvärde: false

show_cartBooleskt värdeValfritt

I varukorgen

Standardvärde: false

show_productBooleskt värdeValfritt

På produktsidor

Standardvärde: false

starts_atSträng | nullValfritt

Aktiv från

Sträng:format: "date-time"

usage_limitHeltalValfritt

Användningsgräns

minimum: -1maximum: 2147483647

Standardvärde: -1

Ytterligare fält: Nej

audienceSträngValfritt

Kunder

Begränsningar

enum

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

Standardvärde: "all"

benefit_typeSträngValfritt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar

enum

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

Standardvärde: "percentage"

category_idsArray <Sträng> Valfritt

Identifierare för relaterade kategorier.

maxItems: 1000

Begränsningar · Array 1

pattern

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

codeSträng | nullValfritt

Stabil maskinläsbar kod.

Begränsningar · Sträng 1

pattern

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

combine_couponsBooleskt värdeValfritt

Kombinera med andra koder

Standardvärde: false

combine_promotionsBooleskt värdeValfritt

Tillåt denna kod på produkter med automatiska kampanjer

Standardvärde: false

created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"

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

created_byCreatorData Obligatoriskt

Skapad av

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

customer_idsArray <Sträng> Valfritt

Kunduppgifter registrerade för resursen.

maxItems: 1000

Begränsningar · Array 1

pattern

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

enabledBooleskt värdeObligatoriskt

Anger om inställningen är aktiverad.

Exempel: false

ends_atSträng | nullValfritt

Aktiv till

Sträng:format: "date-time"

free_shippingBooleskt värdeValfritt

Fri frakt

Standardvärde: false

idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras.

Exempel: "example-campaign"

kindSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar

enum

["coupon", "promotion"]

Exempel: "coupon"

marketsArray <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Obligatoriskt

Marknader som är tillgängliga i butikens kontext.

minItems: 1maxItems: 1000

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

minimum_quantityHeltalValfritt

Minsta antal artiklar i varukorgen

minimum: 1maximum: 2147483647

Standardvärde: 1

nameSträngObligatoriskt

Resursens namn i aktuell kontext.

minLength: 1maxLength: 160

Exempel: "Autumn guide offer"

per_customer_limitHeltalValfritt

Användningsgräns per kund

minimum: -1maximum: 2147483647

Standardvärde: -1

percentageSträngValfritt

Procent

maxLength: 19

Begränsningar

pattern

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

Standardvärde: "10"

product_idsArray <Sträng> Valfritt

Identifierare för relaterade produkter.

maxItems: 1000

Begränsningar · Array 1

pattern

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

product_scopeSträngValfritt

Produkter

Begränsningar

enum

["all", "selected"]

Standardvärde: "all"

show_accountBooleskt värdeValfritt

På kundkontot

Standardvärde: false

show_cartBooleskt värdeValfritt

I varukorgen

Standardvärde: false

show_productBooleskt värdeValfritt

På produktsidor

Standardvärde: false

starts_atSträng | nullValfritt

Aktiv från

Sträng:format: "date-time"

updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"

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

usage_limitHeltalValfritt

Användningsgräns

minimum: -1maximum: 2147483647

Standardvärde: -1

used_countHeltalObligatoriskt

Antal användningar

Exempel: 0

versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

enabledBooleskt värdeObligatoriskt

Anger om inställningen är aktiverad.

Exempel: false

expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807

Exempel: 1

Ytterligare fält: Nej

audienceSträngValfritt

Kunder

Begränsningar

enum

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

Standardvärde: "all"

benefit_typeSträngValfritt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar

enum

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

Standardvärde: "percentage"

category_idsArray <Sträng> Valfritt

Identifierare för relaterade kategorier.

maxItems: 1000

Begränsningar · Array 1

pattern

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

codeSträng | nullValfritt

Stabil maskinläsbar kod.

Begränsningar · Sträng 1

pattern

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

Exempel: "LEARN10"

combine_couponsBooleskt värdeValfritt

Kombinera med andra koder

Standardvärde: false

combine_promotionsBooleskt värdeValfritt

Tillåt denna kod på produkter med automatiska kampanjer

Standardvärde: false

customer_idsArray <Sträng> Valfritt

Kunduppgifter registrerade för resursen.

maxItems: 1000

Begränsningar · Array 1

pattern

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

ends_atSträng | nullValfritt

Aktiv till

Sträng:format: "date-time"

expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 9223372036854775807

Exempel: 1

free_shippingBooleskt värdeValfritt

Fri frakt

Standardvärde: false

marketsArray <MarketData-Input > Obligatoriskt

Marknader som är tillgängliga i butikens kontext.

minItems: 1maxItems: 1000

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

minimum_quantityHeltalValfritt

Minsta antal artiklar i varukorgen

minimum: 1maximum: 2147483647

Standardvärde: 1

nameSträngObligatoriskt

Resursens namn i aktuell kontext.

minLength: 1maxLength: 160

Exempel: "Autumn guide offer"

per_customer_limitHeltalValfritt

Användningsgräns per kund

minimum: -1maximum: 2147483647

Standardvärde: -1

percentageSträngValfritt

Procent

maxLength: 19

Begränsningar

pattern

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

Standardvärde: "10"

product_idsArray <Sträng> Valfritt

Identifierare för relaterade produkter.

maxItems: 1000

Begränsningar · Array 1

pattern

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

product_scopeSträngValfritt

Produkter

Begränsningar

enum

["all", "selected"]

Standardvärde: "all"

show_accountBooleskt värdeValfritt

På kundkontot

Standardvärde: false

show_cartBooleskt värdeValfritt

I varukorgen

Standardvärde: false

show_productBooleskt värdeValfritt

På produktsidor

Standardvärde: false

starts_atSträng | nullValfritt

Aktiv från

Sträng:format: "date-time"

usage_limitHeltalValfritt

Användningsgräns

minimum: -1maximum: 2147483647

Standardvärde: -1

Ytterligare fält: Nej

kindSträngObligatoriskt

Variant av datastrukturen, enligt dess tillåtna värden.

Begränsningar

enum

["admin", "api"]

Exempel: "admin"

labelSträngObligatoriskt

Resursens namn i aktuell kontext.

Exempel: "Editorial integration"

referenceSträngObligatoriskt

Identifierare för den refererade entiteten.

Exempel: "learn-api-key"

Ytterligare fält: Nej

currencySträngObligatoriskt

Valutakod för beloppet.

Begränsningar

pattern

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

Exempel: "PLN"

fixed_amountSträngValfritt

Rabattbelopp

maxLength: 19

Begränsningar

pattern

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

Standardvärde: "0"

market_idSträngObligatoriskt

Marknadsidentifierare returnerad av kontextendpointen.

Begränsningar

pattern

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

Exempel: "poland"

maximum_priceSträng | nullValfritt

Högsta produktpris

Sträng:maxLength: 19

Begränsningar · Sträng 1

pattern

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

minimum_priceSträng | nullValfritt

Lägsta produktpris

Sträng:maxLength: 19

Begränsningar · Sträng 1

pattern

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

minimum_subtotalSträngValfritt

Minsta varukorgsvärde

maxLength: 19

Begränsningar

pattern

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

Standardvärde: "0"

minor_unitsHeltalObligatoriskt

Antal decimaler som används för valutan.

minimum: 0maximum: 4

Exempel: 2

Ytterligare fält: Nej

currencySträngObligatoriskt

Valutakod för beloppet.

Begränsningar

pattern

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

Exempel: "PLN"

fixed_amountSträngValfritt

Rabattbelopp

maxLength: 19

Begränsningar

pattern

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

Standardvärde: "0"

market_idSträngObligatoriskt

Marknadsidentifierare returnerad av kontextendpointen.

Begränsningar

pattern

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

Exempel: "poland"

maximum_priceSträng | nullValfritt

Högsta produktpris

Sträng:maxLength: 19

Begränsningar · Sträng 1

pattern

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

minimum_priceSträng | nullValfritt

Lägsta produktpris

Sträng:maxLength: 19

Begränsningar · Sträng 1

pattern

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

minimum_subtotalSträngValfritt

Minsta varukorgsvärde

maxLength: 19

Begränsningar

pattern

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

Standardvärde: "0"

minor_unitsHeltalObligatoriskt

Antal decimaler som används för valutan.

minimum: 0maximum: 4

Exempel: 0

Ytterligare fält: Nej