Σχήματα δεδομένων · Εκπτώσεις

dataCampaignData Υποχρεωτικό

Δεδομένα επιτυχούς απόκρισης.

Παράδειγμα: {"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 Υποχρεωτικό

Μεταδεδομένα απόκρισης.

Παράδειγμα: {"locale":"example","market_code":"example","market_id":"poland","pagination":{"has_more":false,"limit":1,"next_cursor":null},"request_id":"learn-example-request"}

Πρόσθετα πεδία: Όχι

dataΠίνακας <CampaignData > Υποχρεωτικό

Δεδομένα επιτυχούς απόκρισης.

Παράδειγμα: []

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Υποχρεωτικό

Μεταδεδομένα απόκρισης.

Παράδειγμα: {"locale":"example","market_code":"example","market_id":"poland","pagination":{"has_more":false,"limit":1,"next_cursor":null},"request_id":"learn-example-request"}

Πρόσθετα πεδία: Όχι

audienceΣυμβολοσειράΠροαιρετικό

Πελάτες

Περιορισμοί

enum

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

Προεπιλογή: "all"

benefit_typeΣυμβολοσειράΠροαιρετικό

Μορφή της δομής δεδομένων, όπως ορίζεται από τις επιτρεπόμενες τιμές.

Περιορισμοί

enum

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

Προεπιλογή: "percentage"

category_idsΠίνακας <Συμβολοσειρά> Προαιρετικό

Αναγνωριστικά σχετικών κατηγοριών.

maxItems: 1000

Περιορισμοί · Πίνακας 1

pattern

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

codeΣυμβολοσειρά | nullΠροαιρετικό

Σταθερός κωδικός για επεξεργασία από λογισμικό.

Περιορισμοί · Συμβολοσειρά 1

pattern

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

Παράδειγμα: "LEARN10"

combine_couponsΛογική τιμήΠροαιρετικό

Συνδυασμός με άλλους κωδικούς

Προεπιλογή: false

combine_promotionsΛογική τιμήΠροαιρετικό

Να επιτρέπεται αυτός ο κωδικός σε προϊόντα με αυτόματες προσφορές

Προεπιλογή: false

customer_idsΠίνακας <Συμβολοσειρά> Προαιρετικό

Στοιχεία πελάτη που έχουν καταγραφεί για αυτόν τον πόρο.

maxItems: 1000

Περιορισμοί · Πίνακας 1

pattern

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

ends_atΣυμβολοσειρά | nullΠροαιρετικό

Ενεργό έως

Συμβολοσειρά:format: "date-time"

free_shippingΛογική τιμήΠροαιρετικό

Δωρεάν αποστολή

Προεπιλογή: false

marketsΠίνακας <MarketData-Input > Υποχρεωτικό

Αγορές διαθέσιμες στο πλαίσιο του καταστήματος.

minItems: 1maxItems: 1000

Παράδειγμα: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityΑκέραιοςΠροαιρετικό

Ελάχιστος αριθμός τεμαχίων στο καλάθι

minimum: 1maximum: 2147483647

Προεπιλογή: 1

nameΣυμβολοσειράΥποχρεωτικό

Όνομα πόρου στο σχετικό πλαίσιο.

minLength: 1maxLength: 160

Παράδειγμα: "Autumn guide offer"

per_customer_limitΑκέραιοςΠροαιρετικό

Όριο χρήσεων ανά πελάτη

minimum: -1maximum: 2147483647

Προεπιλογή: -1

percentageΣυμβολοσειράΠροαιρετικό

Ποσοστό

maxLength: 19

Περιορισμοί

pattern

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

Προεπιλογή: "10"

product_idsΠίνακας <Συμβολοσειρά> Προαιρετικό

Αναγνωριστικά σχετικών προϊόντων.

maxItems: 1000

Περιορισμοί · Πίνακας 1

pattern

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

product_scopeΣυμβολοσειράΠροαιρετικό

Προϊόντα

Περιορισμοί

enum

["all", "selected"]

Προεπιλογή: "all"

show_accountΛογική τιμήΠροαιρετικό

Στον λογαριασμό πελάτη

Προεπιλογή: false

show_cartΛογική τιμήΠροαιρετικό

Στο καλάθι

Προεπιλογή: false

show_productΛογική τιμήΠροαιρετικό

Στις σελίδες προϊόντων

Προεπιλογή: false

starts_atΣυμβολοσειρά | nullΠροαιρετικό

Ενεργό από

Συμβολοσειρά:format: "date-time"

usage_limitΑκέραιοςΠροαιρετικό

Όριο χρήσεων

minimum: -1maximum: 2147483647

Προεπιλογή: -1

Πρόσθετα πεδία: Όχι

audienceΣυμβολοσειράΠροαιρετικό

Πελάτες

Περιορισμοί

enum

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

Προεπιλογή: "all"

benefit_typeΣυμβολοσειράΠροαιρετικό

Μορφή της δομής δεδομένων, όπως ορίζεται από τις επιτρεπόμενες τιμές.

Περιορισμοί

enum

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

Προεπιλογή: "percentage"

category_idsΠίνακας <Συμβολοσειρά> Προαιρετικό

Αναγνωριστικά σχετικών κατηγοριών.

maxItems: 1000

Περιορισμοί · Πίνακας 1

pattern

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

codeΣυμβολοσειρά | nullΠροαιρετικό

Σταθερός κωδικός για επεξεργασία από λογισμικό.

Περιορισμοί · Συμβολοσειρά 1

pattern

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

combine_couponsΛογική τιμήΠροαιρετικό

Συνδυασμός με άλλους κωδικούς

Προεπιλογή: false

combine_promotionsΛογική τιμήΠροαιρετικό

Να επιτρέπεται αυτός ο κωδικός σε προϊόντα με αυτόματες προσφορές

Προεπιλογή: false

created_atΣυμβολοσειράΥποχρεωτικό

Χρόνος δημιουργίας.

format: "date-time"

Παράδειγμα: "2026-10-07T10:00:00Z"

created_byCreatorData Υποχρεωτικό

Δημιουργήθηκε από

Παράδειγμα: {"kind":"admin","label":"Editorial integration","reference":"learn-api-key"}

customer_idsΠίνακας <Συμβολοσειρά> Προαιρετικό

Στοιχεία πελάτη που έχουν καταγραφεί για αυτόν τον πόρο.

maxItems: 1000

Περιορισμοί · Πίνακας 1

pattern

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

enabledΛογική τιμήΥποχρεωτικό

Δείχνει αν η ρύθμιση είναι ενεργοποιημένη.

Παράδειγμα: false

ends_atΣυμβολοσειρά | nullΠροαιρετικό

Ενεργό έως

Συμβολοσειρά:format: "date-time"

free_shippingΛογική τιμήΠροαιρετικό

Δωρεάν αποστολή

Προεπιλογή: false

idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό πόρου· διατηρήστε το ακριβώς όπως επιστρέφεται.

Παράδειγμα: "example-campaign"

kindΣυμβολοσειράΥποχρεωτικό

Μορφή της δομής δεδομένων, όπως ορίζεται από τις επιτρεπόμενες τιμές.

Περιορισμοί

enum

["coupon", "promotion"]

Παράδειγμα: "coupon"

marketsΠίνακας <shopently_engine__domains__discounts__adapters__public_http__schemas__MarketData > Υποχρεωτικό

Αγορές διαθέσιμες στο πλαίσιο του καταστήματος.

minItems: 1maxItems: 1000

Παράδειγμα: [{"currency":"PLN","market_id":"poland","minor_units":0}]

minimum_quantityΑκέραιοςΠροαιρετικό

Ελάχιστος αριθμός τεμαχίων στο καλάθι

minimum: 1maximum: 2147483647

Προεπιλογή: 1

nameΣυμβολοσειράΥποχρεωτικό

Όνομα πόρου στο σχετικό πλαίσιο.

minLength: 1maxLength: 160

Παράδειγμα: "Autumn guide offer"

per_customer_limitΑκέραιοςΠροαιρετικό

Όριο χρήσεων ανά πελάτη

minimum: -1maximum: 2147483647

Προεπιλογή: -1

percentageΣυμβολοσειράΠροαιρετικό

Ποσοστό

maxLength: 19

Περιορισμοί

pattern

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

Προεπιλογή: "10"

product_idsΠίνακας <Συμβολοσειρά> Προαιρετικό

Αναγνωριστικά σχετικών προϊόντων.

maxItems: 1000

Περιορισμοί · Πίνακας 1

pattern

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

product_scopeΣυμβολοσειράΠροαιρετικό

Προϊόντα

Περιορισμοί

enum

["all", "selected"]

Προεπιλογή: "all"

show_accountΛογική τιμήΠροαιρετικό

Στον λογαριασμό πελάτη

Προεπιλογή: false

show_cartΛογική τιμήΠροαιρετικό

Στο καλάθι

Προεπιλογή: false

show_productΛογική τιμήΠροαιρετικό

Στις σελίδες προϊόντων

Προεπιλογή: false

starts_atΣυμβολοσειρά | nullΠροαιρετικό

Ενεργό από

Συμβολοσειρά:format: "date-time"

updated_atΣυμβολοσειράΥποχρεωτικό

Χρόνος τελευταίας ενημέρωσης.

format: "date-time"

Παράδειγμα: "2026-10-07T10:00:00Z"

usage_limitΑκέραιοςΠροαιρετικό

Όριο χρήσεων

minimum: -1maximum: 2147483647

Προεπιλογή: -1

used_countΑκέραιοςΥποχρεωτικό

Αριθμός χρήσεων

Παράδειγμα: 0

versionΑκέραιοςΥποχρεωτικό

Έκδοση πόρου για έλεγχο ταυτόχρονων εγγραφών.

Παράδειγμα: 1

Πρόσθετα πεδία: Όχι

enabledΛογική τιμήΥποχρεωτικό

Δείχνει αν η ρύθμιση είναι ενεργοποιημένη.

Παράδειγμα: false

expected_versionΑκέραιοςΥποχρεωτικό

Έκδοση που διαβάστηκε πριν από την εγγραφή· αν δεν συμφωνεί, η ενημέρωση απορρίπτεται.

minimum: 1maximum: 9223372036854775807

Παράδειγμα: 1

Πρόσθετα πεδία: Όχι

audienceΣυμβολοσειράΠροαιρετικό

Πελάτες

Περιορισμοί

enum

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

Προεπιλογή: "all"

benefit_typeΣυμβολοσειράΠροαιρετικό

Μορφή της δομής δεδομένων, όπως ορίζεται από τις επιτρεπόμενες τιμές.

Περιορισμοί

enum

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

Προεπιλογή: "percentage"

category_idsΠίνακας <Συμβολοσειρά> Προαιρετικό

Αναγνωριστικά σχετικών κατηγοριών.

maxItems: 1000

Περιορισμοί · Πίνακας 1

pattern

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

codeΣυμβολοσειρά | nullΠροαιρετικό

Σταθερός κωδικός για επεξεργασία από λογισμικό.

Περιορισμοί · Συμβολοσειρά 1

pattern

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

Παράδειγμα: "LEARN10"

combine_couponsΛογική τιμήΠροαιρετικό

Συνδυασμός με άλλους κωδικούς

Προεπιλογή: false

combine_promotionsΛογική τιμήΠροαιρετικό

Να επιτρέπεται αυτός ο κωδικός σε προϊόντα με αυτόματες προσφορές

Προεπιλογή: false

customer_idsΠίνακας <Συμβολοσειρά> Προαιρετικό

Στοιχεία πελάτη που έχουν καταγραφεί για αυτόν τον πόρο.

maxItems: 1000

Περιορισμοί · Πίνακας 1

pattern

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

ends_atΣυμβολοσειρά | nullΠροαιρετικό

Ενεργό έως

Συμβολοσειρά:format: "date-time"

expected_versionΑκέραιοςΥποχρεωτικό

Έκδοση που διαβάστηκε πριν από την εγγραφή· αν δεν συμφωνεί, η ενημέρωση απορρίπτεται.

minimum: 1maximum: 9223372036854775807

Παράδειγμα: 1

free_shippingΛογική τιμήΠροαιρετικό

Δωρεάν αποστολή

Προεπιλογή: false

marketsΠίνακας <MarketData-Input > Υποχρεωτικό

Αγορές διαθέσιμες στο πλαίσιο του καταστήματος.

minItems: 1maxItems: 1000

Παράδειγμα: [{"currency":"PLN","market_id":"poland","minor_units":2}]

minimum_quantityΑκέραιοςΠροαιρετικό

Ελάχιστος αριθμός τεμαχίων στο καλάθι

minimum: 1maximum: 2147483647

Προεπιλογή: 1

nameΣυμβολοσειράΥποχρεωτικό

Όνομα πόρου στο σχετικό πλαίσιο.

minLength: 1maxLength: 160

Παράδειγμα: "Autumn guide offer"

per_customer_limitΑκέραιοςΠροαιρετικό

Όριο χρήσεων ανά πελάτη

minimum: -1maximum: 2147483647

Προεπιλογή: -1

percentageΣυμβολοσειράΠροαιρετικό

Ποσοστό

maxLength: 19

Περιορισμοί

pattern

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

Προεπιλογή: "10"

product_idsΠίνακας <Συμβολοσειρά> Προαιρετικό

Αναγνωριστικά σχετικών προϊόντων.

maxItems: 1000

Περιορισμοί · Πίνακας 1

pattern

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

product_scopeΣυμβολοσειράΠροαιρετικό

Προϊόντα

Περιορισμοί

enum

["all", "selected"]

Προεπιλογή: "all"

show_accountΛογική τιμήΠροαιρετικό

Στον λογαριασμό πελάτη

Προεπιλογή: false

show_cartΛογική τιμήΠροαιρετικό

Στο καλάθι

Προεπιλογή: false

show_productΛογική τιμήΠροαιρετικό

Στις σελίδες προϊόντων

Προεπιλογή: false

starts_atΣυμβολοσειρά | nullΠροαιρετικό

Ενεργό από

Συμβολοσειρά:format: "date-time"

usage_limitΑκέραιοςΠροαιρετικό

Όριο χρήσεων

minimum: -1maximum: 2147483647

Προεπιλογή: -1

Πρόσθετα πεδία: Όχι

kindΣυμβολοσειράΥποχρεωτικό

Μορφή της δομής δεδομένων, όπως ορίζεται από τις επιτρεπόμενες τιμές.

Περιορισμοί

enum

["admin", "api"]

Παράδειγμα: "admin"

labelΣυμβολοσειράΥποχρεωτικό

Όνομα πόρου στο σχετικό πλαίσιο.

Παράδειγμα: "Editorial integration"

referenceΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό της αναφερόμενης οντότητας.

Παράδειγμα: "learn-api-key"

Πρόσθετα πεδία: Όχι

currencyΣυμβολοσειράΥποχρεωτικό

Κωδικός νομίσματος του ποσού.

Περιορισμοί

pattern

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

Παράδειγμα: "PLN"

fixed_amountΣυμβολοσειράΠροαιρετικό

Ποσό έκπτωσης

maxLength: 19

Περιορισμοί

pattern

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

Προεπιλογή: "0"

market_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αγοράς που επιστρέφει το endpoint πλαισίου.

Περιορισμοί

pattern

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

Παράδειγμα: "poland"

maximum_priceΣυμβολοσειρά | nullΠροαιρετικό

Μέγιστη τιμή προϊόντος

Συμβολοσειρά:maxLength: 19

Περιορισμοί · Συμβολοσειρά 1

pattern

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

minimum_priceΣυμβολοσειρά | nullΠροαιρετικό

Ελάχιστη τιμή προϊόντος

Συμβολοσειρά:maxLength: 19

Περιορισμοί · Συμβολοσειρά 1

pattern

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

minimum_subtotalΣυμβολοσειράΠροαιρετικό

Ελάχιστη αξία καλαθιού

maxLength: 19

Περιορισμοί

pattern

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

Προεπιλογή: "0"

minor_unitsΑκέραιοςΥποχρεωτικό

Πλήθος δεκαδικών ψηφίων του νομίσματος.

minimum: 0maximum: 4

Παράδειγμα: 2

Πρόσθετα πεδία: Όχι

currencyΣυμβολοσειράΥποχρεωτικό

Κωδικός νομίσματος του ποσού.

Περιορισμοί

pattern

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

Παράδειγμα: "PLN"

fixed_amountΣυμβολοσειράΠροαιρετικό

Ποσό έκπτωσης

maxLength: 19

Περιορισμοί

pattern

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

Προεπιλογή: "0"

market_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αγοράς που επιστρέφει το endpoint πλαισίου.

Περιορισμοί

pattern

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

Παράδειγμα: "poland"

maximum_priceΣυμβολοσειρά | nullΠροαιρετικό

Μέγιστη τιμή προϊόντος

Συμβολοσειρά:maxLength: 19

Περιορισμοί · Συμβολοσειρά 1

pattern

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

minimum_priceΣυμβολοσειρά | nullΠροαιρετικό

Ελάχιστη τιμή προϊόντος

Συμβολοσειρά:maxLength: 19

Περιορισμοί · Συμβολοσειρά 1

pattern

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

minimum_subtotalΣυμβολοσειράΠροαιρετικό

Ελάχιστη αξία καλαθιού

maxLength: 19

Περιορισμοί

pattern

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

Προεπιλογή: "0"

minor_unitsΑκέραιοςΥποχρεωτικό

Πλήθος δεκαδικών ψηφίων του νομίσματος.

minimum: 0maximum: 4

Παράδειγμα: 0

Πρόσθετα πεδία: Όχι