Datenschemas · Rabatte

Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

Datenschemas

ApiResponse[CampaignData]

ApiResponse_CampaignData_ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataCampaignData Erforderlich: Nutzdaten einer erfolgreichen Antwort.

Beispiel: {"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 Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

ApiResponse[list[CampaignData]]

ApiResponse_list_CampaignData__ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataArray <CampaignData > Erforderlich: Nutzdaten einer erfolgreichen Antwort.

Beispiel: []
metaContextPageMeta ContextMeta PageMeta RequestMeta Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

CampaignCreate

CampaignCreate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

audienceZeichenfolgeOptional

Kunden

Einschränkungen

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

Standardwert: "all"

benefit_typeZeichenfolgeOptional

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen

enum: ["percentage", "fixed", "none"]

Standardwert: "percentage"

category_idsArray <Zeichenfolge> Optional

Kennungen der zugehörigen Kategorien.

maxItems: 1000

Einschränkungen · Array 1

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

codeZeichenfolge nullOptional

Stabiler maschinenlesbarer Code.

Einschränkungen · Zeichenfolge 1

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

Beispiel: "LEARN10"

combine_couponsBoolescher WertOptional

Mit anderen Codes kombinieren

Standardwert: false

combine_promotionsBoolescher WertOptional

Diesen Code für Produkte mit automatischen Aktionen zulassen

Standardwert: false

customer_idsArray <Zeichenfolge> Optional

Für diese Ressource gespeicherte Kundendaten.

maxItems: 1000

Einschränkungen · Array 1

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

ends_atZeichenfolge nullOptional

Aktiv bis

Zeichenfolge:format: "date-time"

free_shippingBoolescher WertOptional

Kostenloser Versand

Standardwert: false

marketsArray <MarketData-Input > Erforderlich

Im Shop-Kontext verfügbare Märkte.

minItems: 1maxItems: 1000

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

minimum_quantityGanzzahlOptional

Mindestanzahl an Artikeln im Warenkorb

minimum: 1maximum: 2147483647

Standardwert: 1

nameZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

minLength: 1maxLength: 160

Beispiel: "Autumn guide offer"

per_customer_limitGanzzahlOptional

Nutzungslimit pro Kunde

minimum: -1maximum: 2147483647

Standardwert: -1

percentageZeichenfolgeOptional

Prozentual

maxLength: 19

Einschränkungen

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

Standardwert: "10"

product_idsArray <Zeichenfolge> Optional

Kennungen der zugehörigen Produkte.

maxItems: 1000

Einschränkungen · Array 1

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

product_scopeZeichenfolgeOptional

Produkte

Einschränkungen

enum: ["all", "selected"]

Standardwert: "all"

show_accountBoolescher WertOptional

Im Kundenkonto

Standardwert: false

show_cartBoolescher WertOptional

Im Warenkorb

Standardwert: false

show_productBoolescher WertOptional

Auf Produktseiten

Standardwert: false

starts_atZeichenfolge nullOptional

Aktiv ab

Zeichenfolge:format: "date-time"

usage_limitGanzzahlOptional

Nutzungslimit

minimum: -1maximum: 2147483647

Standardwert: -1

Zusätzliche Felder: Nein

CampaignData

CampaignData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

audienceZeichenfolgeOptional

Kunden

Einschränkungen

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

Standardwert: "all"

benefit_typeZeichenfolgeOptional

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen

enum: ["percentage", "fixed", "none"]

Standardwert: "percentage"

category_idsArray <Zeichenfolge> Optional

Kennungen der zugehörigen Kategorien.

maxItems: 1000

Einschränkungen · Array 1

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

codeZeichenfolge nullOptional

Stabiler maschinenlesbarer Code.

Einschränkungen · Zeichenfolge 1

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

combine_couponsBoolescher WertOptional

Mit anderen Codes kombinieren

Standardwert: false

combine_promotionsBoolescher WertOptional

Diesen Code für Produkte mit automatischen Aktionen zulassen

Standardwert: false

created_atZeichenfolgeErforderlich

Zeitpunkt der Erstellung.

format: "date-time"

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

created_byCreatorData Erforderlich

Erstellt von

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

customer_idsArray <Zeichenfolge> Optional

Für diese Ressource gespeicherte Kundendaten.

maxItems: 1000

Einschränkungen · Array 1

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

enabledBoolescher WertErforderlich

Gibt an, ob diese Einstellung aktiviert ist.

Beispiel: false

ends_atZeichenfolge nullOptional

Aktiv bis

Zeichenfolge:format: "date-time"

free_shippingBoolescher WertOptional

Kostenloser Versand

Standardwert: false

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen.

Beispiel: "example-campaign"

kindZeichenfolgeErforderlich

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen

enum: ["coupon", "promotion"]

Beispiel: "coupon"

marketsArray <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Erforderlich

Im Shop-Kontext verfügbare Märkte.

minItems: 1maxItems: 1000

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

minimum_quantityGanzzahlOptional

Mindestanzahl an Artikeln im Warenkorb

minimum: 1maximum: 2147483647

Standardwert: 1

nameZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

minLength: 1maxLength: 160

Beispiel: "Autumn guide offer"

per_customer_limitGanzzahlOptional

Nutzungslimit pro Kunde

minimum: -1maximum: 2147483647

Standardwert: -1

percentageZeichenfolgeOptional

Prozentual

maxLength: 19

Einschränkungen

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

Standardwert: "10"

product_idsArray <Zeichenfolge> Optional

Kennungen der zugehörigen Produkte.

maxItems: 1000

Einschränkungen · Array 1

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

product_scopeZeichenfolgeOptional

Produkte

Einschränkungen

enum: ["all", "selected"]

Standardwert: "all"

show_accountBoolescher WertOptional

Im Kundenkonto

Standardwert: false

show_cartBoolescher WertOptional

Im Warenkorb

Standardwert: false

show_productBoolescher WertOptional

Auf Produktseiten

Standardwert: false

starts_atZeichenfolge nullOptional

Aktiv ab

Zeichenfolge:format: "date-time"

updated_atZeichenfolgeErforderlich

Zeitpunkt der letzten Änderung.

format: "date-time"

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

usage_limitGanzzahlOptional

Nutzungslimit

minimum: -1maximum: 2147483647

Standardwert: -1

used_countGanzzahlErforderlich

Bereits verwendet

Beispiel: 0

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

Zusätzliche Felder: Nein

CampaignStatus

CampaignStatus · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

enabledBoolescher WertErforderlich: Gibt an, ob diese Einstellung aktiviert ist.

Beispiel: false
expected_versionGanzzahlErforderlich: Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807

Beispiel: 1

Zusätzliche Felder: Nein

CampaignUpdate

CampaignUpdate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

audienceZeichenfolgeOptional

Kunden

Einschränkungen

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

Standardwert: "all"

benefit_typeZeichenfolgeOptional

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen

enum: ["percentage", "fixed", "none"]

Standardwert: "percentage"

category_idsArray <Zeichenfolge> Optional

Kennungen der zugehörigen Kategorien.

maxItems: 1000

Einschränkungen · Array 1

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

codeZeichenfolge nullOptional

Stabiler maschinenlesbarer Code.

Einschränkungen · Zeichenfolge 1

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

Beispiel: "LEARN10"

combine_couponsBoolescher WertOptional

Mit anderen Codes kombinieren

Standardwert: false

combine_promotionsBoolescher WertOptional

Diesen Code für Produkte mit automatischen Aktionen zulassen

Standardwert: false

customer_idsArray <Zeichenfolge> Optional

Für diese Ressource gespeicherte Kundendaten.

maxItems: 1000

Einschränkungen · Array 1

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

ends_atZeichenfolge nullOptional

Aktiv bis

Zeichenfolge:format: "date-time"

expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807

Beispiel: 1

free_shippingBoolescher WertOptional

Kostenloser Versand

Standardwert: false

marketsArray <MarketData-Input > Erforderlich

Im Shop-Kontext verfügbare Märkte.

minItems: 1maxItems: 1000

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

minimum_quantityGanzzahlOptional

Mindestanzahl an Artikeln im Warenkorb

minimum: 1maximum: 2147483647

Standardwert: 1

nameZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

minLength: 1maxLength: 160

Beispiel: "Autumn guide offer"

per_customer_limitGanzzahlOptional

Nutzungslimit pro Kunde

minimum: -1maximum: 2147483647

Standardwert: -1

percentageZeichenfolgeOptional

Prozentual

maxLength: 19

Einschränkungen

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

Standardwert: "10"

product_idsArray <Zeichenfolge> Optional

Kennungen der zugehörigen Produkte.

maxItems: 1000

Einschränkungen · Array 1

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

product_scopeZeichenfolgeOptional

Produkte

Einschränkungen

enum: ["all", "selected"]

Standardwert: "all"

show_accountBoolescher WertOptional

Im Kundenkonto

Standardwert: false

show_cartBoolescher WertOptional

Im Warenkorb

Standardwert: false

show_productBoolescher WertOptional

Auf Produktseiten

Standardwert: false

starts_atZeichenfolge nullOptional

Aktiv ab

Zeichenfolge:format: "date-time"

usage_limitGanzzahlOptional

Nutzungslimit

minimum: -1maximum: 2147483647

Standardwert: -1

Zusätzliche Felder: Nein

CreatorData

CreatorData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

kindZeichenfolgeErforderlich

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen

enum: ["admin", "api"]

Beispiel: "admin"

labelZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

Beispiel: "Editorial integration"

referenceZeichenfolgeErforderlich

Kennung des referenzierten Objekts.

Beispiel: "learn-api-key"

Zusätzliche Felder: Nein

MarketData

MarketData-Input · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

currencyZeichenfolgeErforderlich

Währungscode des Betrags.

Einschränkungen

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

Beispiel: "PLN"

fixed_amountZeichenfolgeOptional

Rabattbetrag

maxLength: 19

Einschränkungen

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

Standardwert: "0"

market_idZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebene Marktkennung.

Einschränkungen

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

Beispiel: "poland"

maximum_priceZeichenfolge nullOptional

Maximaler Produktpreis

Zeichenfolge:maxLength: 19

Einschränkungen · Zeichenfolge 1

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

minimum_priceZeichenfolge nullOptional

Minimaler Produktpreis

Zeichenfolge:maxLength: 19

Einschränkungen · Zeichenfolge 1

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

minimum_subtotalZeichenfolgeOptional

Mindestbestellwert

maxLength: 19

Einschränkungen

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

Standardwert: "0"

minor_unitsGanzzahlErforderlich

Anzahl der Nachkommastellen der Währung.

minimum: 0maximum: 4

Beispiel: 2

Zusätzliche Felder: Nein

MarketData

shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

currencyZeichenfolgeErforderlich

Währungscode des Betrags.

Einschränkungen

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

Beispiel: "PLN"

fixed_amountZeichenfolgeOptional

Rabattbetrag

maxLength: 19

Einschränkungen

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

Standardwert: "0"

market_idZeichenfolgeErforderlich

Vom Kontext-Endpunkt zurückgegebene Marktkennung.

Einschränkungen

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

Beispiel: "poland"

maximum_priceZeichenfolge nullOptional

Maximaler Produktpreis

Zeichenfolge:maxLength: 19

Einschränkungen · Zeichenfolge 1

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

minimum_priceZeichenfolge nullOptional

Minimaler Produktpreis

Zeichenfolge:maxLength: 19

Einschränkungen · Zeichenfolge 1

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

minimum_subtotalZeichenfolgeOptional

Mindestbestellwert

maxLength: 19

Einschränkungen

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

Standardwert: "0"

minor_unitsGanzzahlErforderlich

Anzahl der Nachkommastellen der Währung.

minimum: 0maximum: 4

Beispiel: 0

Zusätzliche Felder: Nein