Σχήματα δεδομένων
Διεύθυνση παράδοσης
AddressData · Σχήμα · Σχήματα δεδομένων: Παραγγελίες
address_line_1Συμβολοσειρά nullΥποχρεωτικόΠρώτη γραμμή διεύθυνσης.
address_line_2Συμβολοσειρά nullΥποχρεωτικόΠρόσθετα στοιχεία διεύθυνσης.
cityΣυμβολοσειρά nullΥποχρεωτικόΠόλη ή οικισμός.
country_codeΣυμβολοσειρά nullΥποχρεωτικόΚωδικός χώρας.
first_nameΣυμβολοσειρά nullΥποχρεωτικόΌνομα.
house_numberΣυμβολοσειρά nullΥποχρεωτικόΑριθμός κτιρίου ή οικίας.
last_nameΣυμβολοσειρά nullΥποχρεωτικόΕπώνυμο.
phoneΣυμβολοσειρά nullΥποχρεωτικόΑριθμός τηλεφώνου.
postal_codeΣυμβολοσειρά nullΥποχρεωτικόΤαχυδρομικός κώδικας.
regionΣυμβολοσειρά nullΥποχρεωτικόΔιοικητική περιφέρεια.
streetΣυμβολοσειρά nullΥποχρεωτικόΌνομα οδού.
Πρόσθετα πεδία: Όχι
Λίστα — Παραγγελίες — Απόκριση
ApiResponse_list_OrderSummaryData__ · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
dataΠίνακας <OrderSummaryData> ΥποχρεωτικόΠαράδειγμα απόκρισης · ApiResponse_list_OrderSummaryData__.
metaContextPageMetaContextMetaPageMetaRequestMetaΥποχρεωτικόΜεταδεδομένα απόκρισης.
Πρόσθετα πεδία: Όχι
Ανάκτηση — Παραγγελίες — Απόκριση
ApiResponse_OrderDetailData_ · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
dataOrderDetailDataΥποχρεωτικόΠαράδειγμα απόκρισης · OrderDetailData.
metaContextPageMetaContextMetaPageMetaRequestMetaΥποχρεωτικόΜεταδεδομένα απόκρισης.
Πρόσθετα πεδία: Όχι
Στοιχεία πελάτη που έχουν καταγραφεί για αυτόν τον πόρο
CustomerData · Σχήμα · Σχήματα δεδομένων: Παραγγελίες
emailΣυμβολοσειράΥποχρεωτικόΔιεύθυνση ηλεκτρονικού ταχυδρομείου.
first_nameΣυμβολοσειρά nullΥποχρεωτικόΌνομα.
last_nameΣυμβολοσειρά nullΥποχρεωτικόΕπώνυμο.
phoneΣυμβολοσειρά nullΥποχρεωτικόΑριθμός τηλεφώνου.
Πρόσθετα πεδία: Όχι
Ημερομηνίες αποστολής και παράδοσης
DeliveryDatesData · Η λίστα και οι λεπτομέρειες παραγγελιών περιλαμβάνουν delivery.dates. Οι ημερομηνίες YYYY-MM-DD είναι προγραμματισμένες και δεν επιβεβαιώνουν αποστολή. Οι τρέχουσες ημερομηνίες υπερισχύουν· οι παλιές παραγγελίες χρησιμοποιούν την αποθηκευμένη εκτίμηση. Διαγραμμένες ή άγνωστες τιμές είναι null. Οι λεπτομέρειες περιλαμβάνουν επίσης όλες τις γραμμές και εικόνες προϊόντων.
dispatch_timezoneΣυμβολοσειρά nullΥποχρεωτικόΖώνη ώρας αποστολής (IANA; null).
estimated_delivery_fromΣυμβολοσειρά nullΥποχρεωτικόΑρχή εκτιμώμενης παράδοσης (YYYY-MM-DD; null).
Συμβολοσειρά:format:"date"estimated_delivery_toΣυμβολοσειρά nullΥποχρεωτικόΤέλος εκτιμώμενης παράδοσης (YYYY-MM-DD; null).
Συμβολοσειρά:format:"date"planned_dispatch_onΣυμβολοσειρά nullΥποχρεωτικόΠρογραμματισμένη ημερομηνία αποστολής (YYYY-MM-DD; null).
Συμβολοσειρά:format:"date"
Πρόσθετα πεδία: Όχι
DeliveryPickupPointData
DeliveryPickupPointData · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
addressPickupPointAddressDataΥποχρεωτικόΔιεύθυνση παράδοσης.
codeΣυμβολοσειράΥποχρεωτικόΣταθερός κωδικός για επεξεργασία από λογισμικό.
Περιορισμοί
pattern"^[A-Za-z0-9_-]{1,63}$"
coordinatesPickupPointCoordinatesDatanullΥποχρεωτικόΤιμή που περιγράφεται από το περιβάλλον σχήμα.
country_codeΣυμβολοσειράΥποχρεωτικόΚωδικός χώρας.
Περιορισμοί
pattern"^[A-Z]{2}$"
environmentΣυμβολοσειράΥποχρεωτικόΠληροφορίες περιβάλλοντος που συνοδεύουν την εγγραφή.
Περιορισμοί
enum["live", "sandbox"]
kindΣυμβολοσειράΥποχρεωτικόΜορφή της δομής δεδομένων, όπως ορίζεται από τις επιτρεπόμενες τιμές.
Περιορισμοί
enum["locker", "pickup_point"]
location_descriptionΣυμβολοσειρά nullΥποχρεωτικόΠεριγραφή στην επιλεγμένη γλώσσα.
Συμβολοσειρά:maxLength:1000nameΣυμβολοσειράΥποχρεωτικόΌνομα πόρου στο σχετικό πλαίσιο.
minLength:1maxLength:160opening_hoursΣυμβολοσειρά nullΥποχρεωτικόOpening hours
Συμβολοσειρά:maxLength:500operatorΣυμβολοσειράΥποχρεωτικόΌνομα πόρου στο σχετικό πλαίσιο.
minLength:1maxLength:63verified_atΣυμβολοσειράΥποχρεωτικόΧρόνος τελευταίας ενημέρωσης.
format:"date-time"
Πρόσθετα πεδία: Όχι
Στοιχεία τιμολογίου
InvoiceData · Σχήμα · Σχήματα δεδομένων: Παραγγελίες
address_line_1Συμβολοσειρά nullΥποχρεωτικόΠρώτη γραμμή διεύθυνσης.
address_line_2Συμβολοσειρά nullΥποχρεωτικόΠρόσθετα στοιχεία διεύθυνσης.
cityΣυμβολοσειρά nullΥποχρεωτικόΠόλη ή οικισμός.
company_nameΣυμβολοσειρά nullΥποχρεωτικόΕπωνυμία εταιρείας.
country_codeΣυμβολοσειρά nullΥποχρεωτικόΚωδικός χώρας.
house_numberΣυμβολοσειρά nullΥποχρεωτικόΑριθμός κτιρίου ή οικίας.
postal_codeΣυμβολοσειρά nullΥποχρεωτικόΤαχυδρομικός κώδικας.
regionΣυμβολοσειρά nullΥποχρεωτικόΔιοικητική περιφέρεια.
streetΣυμβολοσειρά nullΥποχρεωτικόΌνομα οδού.
tax_identifierΣυμβολοσειρά nullΥποχρεωτικόΑριθμός φορολογικού μητρώου.
tax_schemeΣυμβολοσειρά nullΥποχρεωτικόΣχήμα υπολογισμού φόρου.
Πρόσθετα πεδία: Όχι
Καθαρό ποσό / Ποσό φόρου / Μικτό ποσό
OrderAmountBreakdownData · Τα ποσά και οι συντελεστές προέρχονται από την αποθηκευμένη παραγγελία, μαζί με τις διορθώσεις γραμμών. Τα άγνωστα ιστορικά στοιχεία είναι null και δεν αντικαθίστανται από τρέχοντες συντελεστές καταλόγου. Τα ποσά παραμένουν δεκαδικές συμβολοσειρές.
grossMoneyDataΥποχρεωτικόΜικτό ποσό · Μετά τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
netMoneyDatanullΥποχρεωτικόΚαθαρό ποσό · Μετά τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
taxMoneyDatanullΥποχρεωτικόΠοσό φόρου · Μετά τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
Πρόσθετα πεδία: Όχι
Αποστολή · Εκπτώσεις
OrderDeliveryDiscountData · Τα ποσά και οι συντελεστές προέρχονται από την αποθηκευμένη παραγγελία, μαζί με τις διορθώσεις γραμμών. Τα άγνωστα ιστορικά στοιχεία είναι null και δεν αντικαθίστανται από τρέχοντες συντελεστές καταλόγου. Τα ποσά παραμένουν δεκαδικές συμβολοσειρές.
amountMoneyDataΥποχρεωτικόΜικτό ποσό · Αποστολή · Εκπτώσεις.
campaign_idΣυμβολοσειράΥποχρεωτικόΑναγνωριστικό πόρου· διατηρήστε το ακριβώς όπως επιστρέφεται.
codeΣυμβολοσειρά nullΥποχρεωτικόΣταθερός κωδικός για επεξεργασία από λογισμικό.
kindΣυμβολοσειράΥποχρεωτικόΜορφή της δομής δεδομένων, όπως ορίζεται από τις επιτρεπόμενες τιμές.
Περιορισμοί
enum["coupon", "promotion"]
nameΣυμβολοσειράΥποχρεωτικόΌνομα πόρου στο σχετικό πλαίσιο.
sequenceΑκέραιος nullΥποχρεωτικόΘέση στην ταξινομημένη συλλογή.
versionΑκέραιοςΥποχρεωτικόΈκδοση πόρου για έλεγχο ταυτόχρονων εγγραφών.
Πρόσθετα πεδία: Όχι
Ανάκτηση — Παραγγελίες — Απόκριση
OrderDetailData · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
created_atΣυμβολοσειράΥποχρεωτικόΧρόνος δημιουργίας.
format:"date-time"customerCustomerDataΥποχρεωτικόΣτοιχεία πελάτη που έχουν καταγραφεί για αυτόν τον πόρο.
deliveryShippingDetailDataΥποχρεωτικόΜέθοδος παράδοσης και σχετικές πληροφορίες.
discount_amountMoneyDataΥποχρεωτικόΔεκαδικό ποσό ως συμβολοσειρά JSON· null μόνο όπου επιτρέπεται.
discountsΠίνακας <OrderDiscountData> ΥποχρεωτικόΕκπτώσεις
idΣυμβολοσειράΥποχρεωτικόΑναγνωριστικό πόρου· διατηρήστε το ακριβώς όπως επιστρέφεται. (OrderDetailData).
invoiceInvoiceDatanullΥποχρεωτικόΣτοιχεία τιμολογίου.
invoice_requestedΛογική τιμήΥποχρεωτικόΔείχνει αν ζητήθηκε τιμολόγιο.
lifecycle_stateOrderLifecycleStateΥποχρεωτικόΚατάσταση στον επιχειρησιακό κύκλο ζωής.
linesΠίνακας <OrderLineData> ΥποχρεωτικόΣτιγμιότυπα γραμμών παραγγελίας.
localeΣυμβολοσειράΥποχρεωτικόΓλώσσα που επιλέχθηκε για αυτό το αίτημα.
market_idΣυμβολοσειράΥποχρεωτικόΑναγνωριστικό αγοράς που επιστρέφει το endpoint πλαισίου.
numberΣυμβολοσειράΥποχρεωτικόΑριθμός παραγγελίας ή αιτήματος που εμφανίζεται στον χρήστη.
paymentPaymentDataΥποχρεωτικόΣτοιχεία πληρωμής που έχουν καταγραφεί για την παραγγελία.
pickup_pointPickupPointDatanullΥποχρεωτικόΣημείο παραλαβής
prices_include_taxΛογική τιμήΥποχρεωτικόΔείχνει αν οι τιμές περιλαμβάνουν φόρο.
shipping_addressAddressDatanullΥποχρεωτικόΔιεύθυνση παράδοσης.
shipping_discount_amountMoneyDataΥποχρεωτικόΔεκαδικό ποσό ως συμβολοσειρά JSON· null μόνο όπου επιτρέπεται.
statusOrderStatusDataΥποχρεωτικόΚατάσταση αποδεκτή από τη συγκεκριμένη λειτουργία.
subtotalMoneyDataΥποχρεωτικόΠοσό πριν από τα πρόσθετα στοιχεία που εμφανίζονται στην απόκριση.
taxMoneyDataΥποχρεωτικόΠληροφορίες φόρου.
tax_breakdownOrderTaxBreakdownDataΥποχρεωτικόΦορολογικές ομάδες · source + tax_rate; unallocated_tax.
tax_country_codeΣυμβολοσειρά nullΥποχρεωτικόΦορολογική χώρα · Αποθηκευμένα στοιχεία παραγγελίας · ISO 3166-1 alpha-2; null.
totalMoneyDataΥποχρεωτικόΣυνολικό ποσό.
totalsOrderTotalsDataΥποχρεωτικόΣύνολα · net / tax / gross; Πριν τις εκπτώσεις / Μετά τις εκπτώσεις.
Πρόσθετα πεδία: Όχι
Μεταδεδομένα και URL εικόνας
OrderImageData · Σχήμα · Σχήματα δεδομένων: Παραγγελίες
altΣυμβολοσειρά nullΥποχρεωτικόΕναλλακτικό κείμενο εικόνας.
sourceΣυμβολοσειράΠροαιρετικόΠηγή της καταγεγραμμένης δραστηριότητας.
const:"current_catalog"urlΣυμβολοσειράΥποχρεωτικόURL πόρου.
Πρόσθετα πεδία: Όχι
Κατάσταση στον επιχειρησιακό κύκλο ζωής
OrderLifecycleState · Σχήμα · Σχήματα δεδομένων: Παραγγελίες
ΣυμβολοσειράΠεριορισμοί
enum["placed", "cancelled", "fulfilled", "returned"]
Πρόσθετα πεδία: Ναι
Στιγμιότυπα γραμμών παραγγελίας
OrderLineData · Σχήμα · Σχήματα δεδομένων: Παραγγελίες
discount_amountMoneyDataΥποχρεωτικόΔεκαδικό ποσό ως συμβολοσειρά JSON· null μόνο όπου επιτρέπεται.
discount_grossMoneyDataΥποχρεωτικόΜικτό ποσό · Εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
discount_netMoneyDatanullΥποχρεωτικόΚαθαρό ποσό · Εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
discount_taxMoneyDatanullΥποχρεωτικόΠοσό φόρου · Εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
discountsΠίνακας <OrderDiscountData> ΥποχρεωτικόΕκπτώσεις · net / tax / gross.
identifiersΑντικείμενοΠρόσθετα πεδία: ΣυμβολοσειράΥποχρεωτικόΚωδικοί αναγνώρισης προϊόντος.
imageOrderImageDatanullΥποχρεωτικόΜεταδεδομένα και URL εικόνας.
line_idΣυμβολοσειράΥποχρεωτικόΣταθερό αναγνωριστικό γραμμής παραγγελίας.
manual_discountOrderManualDiscountDatanullΥποχρεωτικόΧειροκίνητη έκπτωση; null.
nameΣυμβολοσειράΥποχρεωτικόΌνομα πόρου στο σχετικό πλαίσιο.
original_totalMoneyDataΥποχρεωτικόΣυνολικό ποσό.
original_total_grossMoneyDataΥποχρεωτικόΜικτό ποσό · Προϊόντα · Πριν τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
original_total_netMoneyDatanullΥποχρεωτικόΚαθαρό ποσό · Προϊόντα · Πριν τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
original_total_taxMoneyDatanullΥποχρεωτικόΠοσό φόρου · Προϊόντα · Πριν τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
positionΑκέραιοςΥποχρεωτικόΘέση στην ταξινομημένη συλλογή.
product_idΣυμβολοσειράΥποχρεωτικόΑναγνωριστικό προϊόντος.
quantityΑκέραιοςΥποχρεωτικόΠλήθος μονάδων.
skuΣυμβολοσειράΥποχρεωτικόΚωδικός μονάδας αποθέματος.
taxMoneyDatanullΥποχρεωτικόΠοσό φόρου · Μία μονάδα · Αποθηκευμένα στοιχεία παραγγελίας; tax ≠ unit_tax; Άγνωστο: null· γνωστό μηδέν: 0.
tax_category_idΣυμβολοσειρά nullΥποχρεωτικόΑναγνωριστικό φορολογικής κατηγορίας · Αποθηκευμένα στοιχεία παραγγελίας; null.
tax_category_nameΣυμβολοσειρά nullΥποχρεωτικόΑποθηκευμένο όνομα φορολογικής κατηγορίας; null.
tax_rateΣυμβολοσειρά nullΥποχρεωτικόtax_rate · Αποθηκευμένα στοιχεία παραγγελίας: "0.23" = 23%; "0" ≠ null.
totalMoneyDataΥποχρεωτικόΣυνολικό ποσό.
total_grossMoneyDataΥποχρεωτικόΜικτό ποσό · Προϊόντα · Μετά τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
total_netMoneyDatanullΥποχρεωτικόΚαθαρό ποσό · Προϊόντα · Μετά τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
total_taxMoneyDatanullΥποχρεωτικόΠοσό φόρου · Προϊόντα · Μετά τις εκπτώσεις · Αποθηκευμένα στοιχεία παραγγελίας; Άγνωστο: null· γνωστό μηδέν: 0.
unit_grossMoneyDataΥποχρεωτικόΜικτό ποσό · Μία μονάδα · Πριν τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
unit_netMoneyDatanullΥποχρεωτικόΚαθαρό ποσό · Μία μονάδα · Πριν τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
unit_priceMoneyDataΥποχρεωτικόΤιμή ανά μονάδα.
unit_taxMoneyDatanullΥποχρεωτικόΠοσό φόρου · Μία μονάδα · Πριν τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
variant_idΣυμβολοσειρά nullΥποχρεωτικόΑναγνωριστικό παραλλαγής προϊόντος.
variant_optionsΠίνακας <shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData> ΥποχρεωτικόΕπιλογές παραλλαγής που συνδέονται με το προϊόν ή το στιγμιότυπο.
Πρόσθετα πεδία: Όχι
Χειροκίνητη έκπτωση
OrderManualDiscountData · Τα ποσά και οι συντελεστές προέρχονται από την αποθηκευμένη παραγγελία, μαζί με τις διορθώσεις γραμμών. Τα άγνωστα ιστορικά στοιχεία είναι null και δεν αντικαθίστανται από τρέχοντες συντελεστές καταλόγου. Τα ποσά παραμένουν δεκαδικές συμβολοσειρές.
amountMoneyDataΥποχρεωτικόΜικτό ποσό · Χειροκίνητη έκπτωση · Αποθηκευμένα στοιχεία παραγγελίας.
kindΣυμβολοσειράΥποχρεωτικόΤύπος έκπτωσης: percentage / fixed.
Περιορισμοί
enum["percentage", "fixed"]
valueΣυμβολοσειράΥποχρεωτικόΡυθμισμένη τιμή: percentage "10" = 10%; fixed = Μικτό ποσό.
Πρόσθετα πεδία: Όχι
Κατάσταση αποδεκτή από τη συγκεκριμένη λειτουργία
OrderPaymentStatus · Σχήμα · Σχήματα δεδομένων: Παραγγελίες
ΣυμβολοσειράΠεριορισμοί
enum["unpaid", "paid", "failed", "refunded"]
Πρόσθετα πεδία: Ναι
Κατάσταση αποδεκτή από τη συγκεκριμένη λειτουργία
OrderStatusData · Σχήμα · Σχήματα δεδομένων: Παραγγελίες
idΣυμβολοσειράΥποχρεωτικόΑναγνωριστικό πόρου· διατηρήστε το ακριβώς όπως επιστρέφεται. (OrderStatusData).
nameΣυμβολοσειράΥποχρεωτικόΌνομα πόρου στο σχετικό πλαίσιο.
updated_atΣυμβολοσειράΥποχρεωτικόΧρόνος τελευταίας ενημέρωσης.
format:"date-time"versionΑκέραιοςΥποχρεωτικόΈκδοση πόρου για έλεγχο ταυτόχρονων εγγραφών.
Πρόσθετα πεδία: Όχι
Λίστα · Καταστάσεις — Παραγγελίες — Απόκριση
shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
created_atΣυμβολοσειράΥποχρεωτικόΧρόνος δημιουργίας.
format:"date-time"idΣυμβολοσειράΥποχρεωτικόΑναγνωριστικό πόρου· διατηρήστε το ακριβώς όπως επιστρέφεται. (shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData).
is_initialΛογική τιμήΥποχρεωτικόΔείχνει αν είναι η αρχική κατάσταση.
nameΣυμβολοσειράΥποχρεωτικόΌνομα πόρου στο σχετικό πλαίσιο.
positionΑκέραιοςΥποχρεωτικόΘέση στην ταξινομημένη συλλογή.
Πρόσθετα πεδία: Όχι
Λίστα · Καταστάσεις — Παραγγελίες — Απόκριση
shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1 · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
dataΠίνακας <shopently_engine__domains__orders__adapters__public_http__orders__schemas__StatusDefinitionData> ΥποχρεωτικόΠαράδειγμα απόκρισης · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1.
metaContextPageMetaContextMetaPageMetaRequestMetaΥποχρεωτικόΜεταδεδομένα απόκρισης.
Πρόσθετα πεδία: Όχι
Ενημέρωση · Κατάσταση — Παραγγελίες — Περιεχόμενο αιτήματος
OrderStatusUpdate · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
expected_versionΑκέραιοςΥποχρεωτικόΈκδοση που διαβάστηκε πριν από την εγγραφή· αν δεν συμφωνεί, η ενημέρωση απορρίπτεται.
minimum:1maximum:9223372036854775807status_idΣυμβολοσειράΥποχρεωτικόΑναγνωριστικό από το αντίστοιχο λεξικό καταστάσεων.
Περιορισμοί
pattern"^[a-z0-9][a-z0-9_-]{0,62}$"
Πρόσθετα πεδία: Όχι
Λίστα — Παραγγελίες — Απόκριση
OrderSummaryData · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
created_atΣυμβολοσειράΥποχρεωτικόΧρόνος δημιουργίας.
format:"date-time"customerCustomerDataΥποχρεωτικόΣτοιχεία πελάτη που έχουν καταγραφεί για αυτόν τον πόρο.
deliveryShippingDataΥποχρεωτικόΜέθοδος παράδοσης και σχετικές πληροφορίες.
discount_amountMoneyDataΥποχρεωτικόΔεκαδικό ποσό ως συμβολοσειρά JSON· null μόνο όπου επιτρέπεται.
idΣυμβολοσειράΥποχρεωτικόΑναγνωριστικό πόρου· διατηρήστε το ακριβώς όπως επιστρέφεται. (OrderSummaryData).
lifecycle_stateOrderLifecycleStateΥποχρεωτικόΚατάσταση στον επιχειρησιακό κύκλο ζωής.
localeΣυμβολοσειράΥποχρεωτικόΓλώσσα που επιλέχθηκε για αυτό το αίτημα.
market_idΣυμβολοσειράΥποχρεωτικόΑναγνωριστικό αγοράς που επιστρέφει το endpoint πλαισίου.
numberΣυμβολοσειράΥποχρεωτικόΑριθμός παραγγελίας ή αιτήματος που εμφανίζεται στον χρήστη.
paymentPaymentDataΥποχρεωτικόΣτοιχεία πληρωμής που έχουν καταγραφεί για την παραγγελία.
prices_include_taxΛογική τιμήΥποχρεωτικόΔείχνει αν οι τιμές περιλαμβάνουν φόρο.
shipping_discount_amountMoneyDataΥποχρεωτικόΔεκαδικό ποσό ως συμβολοσειρά JSON· null μόνο όπου επιτρέπεται.
statusOrderStatusDataΥποχρεωτικόΚατάσταση αποδεκτή από τη συγκεκριμένη λειτουργία.
subtotalMoneyDataΥποχρεωτικόΠοσό πριν από τα πρόσθετα στοιχεία που εμφανίζονται στην απόκριση.
taxMoneyDataΥποχρεωτικόΠληροφορίες φόρου.
tax_country_codeΣυμβολοσειρά nullΥποχρεωτικόΦορολογική χώρα · Αποθηκευμένα στοιχεία παραγγελίας · ISO 3166-1 alpha-2; null.
totalMoneyDataΥποχρεωτικόΣυνολικό ποσό.
Πρόσθετα πεδία: Όχι
Παραγγελία · Φορολογικές ομάδες
OrderTaxBreakdownData · Τα ποσά και οι συντελεστές προέρχονται από την αποθηκευμένη παραγγελία, μαζί με τις διορθώσεις γραμμών. Τα άγνωστα ιστορικά στοιχεία είναι null και δεν αντικαθίστανται από τρέχοντες συντελεστές καταλόγου. Τα ποσά παραμένουν δεκαδικές συμβολοσειρές.
groupsΠίνακας <OrderTaxGroupData> ΥποχρεωτικόΦορολογικές ομάδες · source + tax_rate; Άγνωστο: null· γνωστό μηδέν: 0.
unallocated_taxMoneyDataΥποχρεωτικόΜη κατανεμημένος φόρος = order.tax − Σ groups.tax; ±.
Πρόσθετα πεδία: Όχι
Φορολογικές ομάδες
OrderTaxGroupData · Τα ποσά και οι συντελεστές προέρχονται από την αποθηκευμένη παραγγελία, μαζί με τις διορθώσεις γραμμών. Τα άγνωστα ιστορικά στοιχεία είναι null και δεν αντικαθίστανται από τρέχοντες συντελεστές καταλόγου. Τα ποσά παραμένουν δεκαδικές συμβολοσειρές.
grossMoneyDataΥποχρεωτικόΜικτό ποσό · Μετά τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
netMoneyDatanullΥποχρεωτικόΚαθαρό ποσό · Μετά τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
sourceΣυμβολοσειράΥποχρεωτικόΠηγή: products (Προϊόντα), shipping (Αποστολή).
Περιορισμοί
enum["products", "shipping"]
taxMoneyDatanullΥποχρεωτικόΠοσό φόρου · Μετά τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
tax_rateΣυμβολοσειρά nullΥποχρεωτικόtax_rate · Αποθηκευμένα στοιχεία παραγγελίας: "0.23" = 23%; "0" ≠ null.
Πρόσθετα πεδία: Όχι
Παραγγελία · Σύνολα
OrderTotalsData · Τα ποσά και οι συντελεστές προέρχονται από την αποθηκευμένη παραγγελία, μαζί με τις διορθώσεις γραμμών. Τα άγνωστα ιστορικά στοιχεία είναι null και δεν αντικαθίστανται από τρέχοντες συντελεστές καταλόγου. Τα ποσά παραμένουν δεκαδικές συμβολοσειρές.
before_discountsOrderAmountBreakdownDataΥποχρεωτικόΠαραγγελία · Πριν τις εκπτώσεις · net / tax / gross.
discountsOrderAmountBreakdownDataΥποχρεωτικόΕκπτώσεις · net / tax / gross.
orderOrderAmountBreakdownDataΥποχρεωτικόΠαραγγελία · Μετά τις εκπτώσεις · net / tax / gross.
product_discountsOrderAmountBreakdownDataΥποχρεωτικόΠροϊόντα · Εκπτώσεις · net / tax / gross.
productsOrderAmountBreakdownDataΥποχρεωτικόΠροϊόντα · Μετά τις εκπτώσεις · net / tax / gross.
products_before_discountsOrderAmountBreakdownDataΥποχρεωτικόΠροϊόντα · Πριν τις εκπτώσεις · net / tax / gross.
shippingOrderAmountBreakdownDataΥποχρεωτικόΑποστολή · Μετά τις εκπτώσεις · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownDataΥποχρεωτικόΑποστολή · Πριν τις εκπτώσεις · net / tax / gross.
shipping_discountsOrderAmountBreakdownDataΥποχρεωτικόΑποστολή · Εκπτώσεις · net / tax / gross.
Πρόσθετα πεδία: Όχι
Επιλογές παραλλαγής που συνδέονται με το προϊόν ή το στιγμιότυπο
shopently_engine__domains__orders__adapters__public_http__orders__schemas__VariantOptionData · Σχήμα · Σχήματα δεδομένων: Παραγγελίες
nameΣυμβολοσειράΥποχρεωτικόΌνομα πόρου στο σχετικό πλαίσιο.
valueΣυμβολοσειράΥποχρεωτικόΤιμή που περιγράφεται από το περιβάλλον σχήμα.
Πρόσθετα πεδία: Όχι
OrderDiscountData
OrderDiscountData · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
amountMoneyDataΥποχρεωτικόΜικτό ποσό · Προϊόντα · Εκπτώσεις.
campaign_idΣυμβολοσειράΥποχρεωτικόΑναγνωριστικό πόρου· διατηρήστε το ακριβώς όπως επιστρέφεται.
codeΣυμβολοσειρά nullΥποχρεωτικόΣταθερός κωδικός για επεξεργασία από λογισμικό.
kindΣυμβολοσειράΥποχρεωτικόΜορφή της δομής δεδομένων, όπως ορίζεται από τις επιτρεπόμενες τιμές.
Περιορισμοί
enum["coupon", "promotion"]
nameΣυμβολοσειράΥποχρεωτικόΌνομα πόρου στο σχετικό πλαίσιο.
sequenceΑκέραιος nullΠροαιρετικόΣειρά εφαρμογής; null.
shipping_amountMoneyDatanullΠροαιρετικόΜικτό ποσό · Αποστολή · Εκπτώσεις; null.
versionΑκέραιοςΥποχρεωτικόΈκδοση πόρου για έλεγχο ταυτόχρονων εγγραφών.
Πρόσθετα πεδία: Όχι
Στοιχεία πληρωμής που έχουν καταγραφεί για την παραγγελία
PaymentData · Σχήμα · Σχήματα δεδομένων: Παραγγελίες
amountMoneyDataΥποχρεωτικόΤο payment.amount είναι το σύνολο παραγγελίας. Η κατάσταση πληρωμής δεν καθορίζει πληρωμένα, επιστραφέντα ή οφειλόμενα ποσά.
environmentΣυμβολοσειράΥποχρεωτικόΠληροφορίες περιβάλλοντος που συνοδεύουν την εγγραφή.
Περιορισμοί
enum["live", "sandbox"]
method_codeΣυμβολοσειρά nullΥποχρεωτικόΚωδικός μεθόδου παράδοσης ή πληρωμής.
method_nameΣυμβολοσειρά nullΥποχρεωτικόΌνομα μεθόδου παράδοσης ή πληρωμής.
paid_atΣυμβολοσειρά nullΥποχρεωτικόΗμερομηνία και ώρα επισήμανσης της πληρωμής ως εξοφλημένης.
Συμβολοσειρά:format:"date-time"statusOrderPaymentStatusΥποχρεωτικόΚατάσταση αποδεκτή από τη συγκεκριμένη λειτουργία.
updated_atΣυμβολοσειράΥποχρεωτικόΧρόνος τελευταίας ενημέρωσης.
format:"date-time"versionΑκέραιοςΥποχρεωτικόΈκδοση πόρου για έλεγχο ταυτόχρονων εγγραφών.
Πρόσθετα πεδία: Όχι
Ενημέρωση · Κατάσταση πληρωμής — Παραγγελίες — Περιεχόμενο αιτήματος
PaymentStatusUpdate · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
expected_versionΑκέραιοςΥποχρεωτικόΈκδοση που διαβάστηκε πριν από την εγγραφή· αν δεν συμφωνεί, η ενημέρωση απορρίπτεται.
minimum:0maximum:9223372036854775807reasonΣυμβολοσειράΥποχρεωτικόΑιτιολογία που καταγράφηκε για την αλλαγή.
minLength:1maxLength:500statusPaymentStatusΥποχρεωτικόΚατάσταση αποδεκτή από τη συγκεκριμένη λειτουργία.
Πρόσθετα πεδία: Όχι
Κατάσταση αποδεκτή από τη συγκεκριμένη λειτουργία
PaymentStatus · Σχήμα · Σχήματα δεδομένων: Παραγγελίες
ΣυμβολοσειράΠεριορισμοί
enum["unpaid", "paid", "failed", "refunded"]
Πρόσθετα πεδία: Ναι
PickupPointAddressData
PickupPointAddressData · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
address_line_1ΣυμβολοσειράΥποχρεωτικόΠρώτη γραμμή διεύθυνσης.
minLength:1maxLength:240cityΣυμβολοσειράΥποχρεωτικόΠόλη ή οικισμός.
minLength:1maxLength:160postal_codeΣυμβολοσειράΥποχρεωτικόΤαχυδρομικός κώδικας.
minLength:1maxLength:32
Πρόσθετα πεδία: Όχι
PickupPointCoordinatesData
PickupPointCoordinatesData · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
latitudeΑριθμόςΥποχρεωτικόWGS84 φ (°)
minimum:-90.0maximum:90.0longitudeΑριθμόςΥποχρεωτικόWGS84 λ (°)
minimum:-180.0maximum:180.0
Πρόσθετα πεδία: Όχι
PickupPointData
PickupPointData · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
address_line1ΣυμβολοσειράΥποχρεωτικόΠρώτη γραμμή διεύθυνσης.
cityΣυμβολοσειράΥποχρεωτικόΠόλη ή οικισμός.
codeΣυμβολοσειράΥποχρεωτικόΣταθερός κωδικός για επεξεργασία από λογισμικό.
country_codeΣυμβολοσειράΥποχρεωτικόΚωδικός χώρας.
kindΣυμβολοσειράΥποχρεωτικόΜορφή της δομής δεδομένων, όπως ορίζεται από τις επιτρεπόμενες τιμές.
Περιορισμοί
enum["locker", "pickup_point"]
latitudeΑριθμός nullΥποχρεωτικόWGS84 φ (°)
location_descriptionΣυμβολοσειρά nullΥποχρεωτικόΠεριγραφή στην επιλεγμένη γλώσσα.
longitudeΑριθμός nullΥποχρεωτικόWGS84 λ (°)
nameΣυμβολοσειράΥποχρεωτικόΌνομα πόρου στο σχετικό πλαίσιο.
opening_hoursΣυμβολοσειρά nullΥποχρεωτικόOpening hours
operatorΣυμβολοσειράΥποχρεωτικόΌνομα πόρου στο σχετικό πλαίσιο.
postal_codeΣυμβολοσειράΥποχρεωτικόΤαχυδρομικός κώδικας.
Πρόσθετα πεδία: Όχι
PickupPointSummaryData
PickupPointSummaryData · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
codeΣυμβολοσειράΥποχρεωτικόΣταθερός κωδικός για επεξεργασία από λογισμικό.
Περιορισμοί
pattern"^[A-Za-z0-9_-]{1,63}$"
country_codeΣυμβολοσειράΥποχρεωτικόΚωδικός χώρας.
Περιορισμοί
pattern"^[A-Z]{2}$"
environmentΣυμβολοσειράΥποχρεωτικόΠληροφορίες περιβάλλοντος που συνοδεύουν την εγγραφή.
Περιορισμοί
enum["live", "sandbox"]
kindΣυμβολοσειράΥποχρεωτικόΜορφή της δομής δεδομένων, όπως ορίζεται από τις επιτρεπόμενες τιμές.
Περιορισμοί
enum["locker", "pickup_point"]
operatorΣυμβολοσειράΥποχρεωτικόΌνομα πόρου στο σχετικό πλαίσιο.
minLength:1maxLength:63
Πρόσθετα πεδία: Όχι
Στοιχεία πελάτη που έχουν καταγραφεί για αυτόν τον πόρο
RequestCustomerData · Σχήμα · Σχήματα δεδομένων: Παραγγελίες
emailΣυμβολοσειράΥποχρεωτικόΔιεύθυνση ηλεκτρονικού ταχυδρομείου.
nameΣυμβολοσειράΥποχρεωτικόΌνομα πόρου στο σχετικό πλαίσιο.
Πρόσθετα πεδία: Όχι
Μέθοδος παράδοσης και σχετικές πληροφορίες
ShippingData · Σχήμα · Σχήματα δεδομένων: Παραγγελίες
amountMoneyDataΥποχρεωτικόΜικτό ποσό αποστολής αποθηκευμένο στην παραγγελία ως MoneyData. Μεταγενέστερες φορολογικές αλλαγές δεν αλλάζουν αυτό το ιστορικό ποσό.
datesDeliveryDatesDataΥποχρεωτικόΗμερομηνίες αποστολής και παράδοσης. Η λίστα και οι λεπτομέρειες παραγγελιών περιλαμβάνουν delivery.dates. Οι ημερομηνίες YYYY-MM-DD είναι προγραμματισμένες και δεν επιβεβαιώνουν αποστολή. Οι τρέχουσες ημερομηνίες υπερισχύουν· οι παλιές παραγγελίες χρησιμοποιούν την αποθηκευμένη εκτίμηση. Διαγραμμένες ή άγνωστες τιμές είναι null. Οι λεπτομέρειες περιλαμβάνουν επίσης όλες τις γραμμές και εικόνες προϊόντων.
method_codeΣυμβολοσειρά nullΥποχρεωτικόΚωδικός μεθόδου παράδοσης ή πληρωμής.
method_nameΣυμβολοσειρά nullΥποχρεωτικόΌνομα μεθόδου παράδοσης ή πληρωμής.
pickup_pointPickupPointSummaryDatanullΥποχρεωτικόΣημείο παραλαβής
recipient_modeΣυμβολοσειράΥποχρεωτικόΜορφή της δομής δεδομένων, όπως ορίζεται από τις επιτρεπόμενες τιμές.
Περιορισμοί
enum["full_address", "pickup_contact"]
Πρόσθετα πεδία: Όχι
ShippingDetailData
ShippingDetailData · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
amountMoneyDataΥποχρεωτικόΜικτό ποσό αποστολής αποθηκευμένο στην παραγγελία ως MoneyData. Μεταγενέστερες φορολογικές αλλαγές δεν αλλάζουν αυτό το ιστορικό ποσό.
datesDeliveryDatesDataΥποχρεωτικόΗμερομηνίες αποστολής και παράδοσης. Η λίστα και οι λεπτομέρειες παραγγελιών περιλαμβάνουν delivery.dates. Οι ημερομηνίες YYYY-MM-DD είναι προγραμματισμένες και δεν επιβεβαιώνουν αποστολή. Οι τρέχουσες ημερομηνίες υπερισχύουν· οι παλιές παραγγελίες χρησιμοποιούν την αποθηκευμένη εκτίμηση. Διαγραμμένες ή άγνωστες τιμές είναι null. Οι λεπτομέρειες περιλαμβάνουν επίσης όλες τις γραμμές και εικόνες προϊόντων.
discount_grossMoneyDataΥποχρεωτικόΜικτό ποσό · Εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
discount_netMoneyDatanullΥποχρεωτικόΚαθαρό ποσό · Εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
discount_taxMoneyDatanullΥποχρεωτικόΠοσό φόρου · Εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
discountsΠίνακας <OrderDeliveryDiscountData> nullΥποχρεωτικόΑποστολή · Εκπτώσεις; []: 0; null: Άγνωστο: null· γνωστό μηδέν: 0.
grossMoneyDataΥποχρεωτικόΜικτό ποσό · Μετά τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
method_codeΣυμβολοσειρά nullΥποχρεωτικόΚωδικός μεθόδου παράδοσης ή πληρωμής.
method_nameΣυμβολοσειρά nullΥποχρεωτικόΌνομα μεθόδου παράδοσης ή πληρωμής.
netMoneyDatanullΥποχρεωτικόΚαθαρό ποσό · Μετά τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
original_grossMoneyDataΥποχρεωτικόΜικτό ποσό · Αποστολή · Πριν τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
original_netMoneyDatanullΥποχρεωτικόΚαθαρό ποσό · Αποστολή · Πριν τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
original_taxMoneyDatanullΥποχρεωτικόΠοσό φόρου · Αποστολή · Πριν τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
pickup_pointDeliveryPickupPointDatanullΥποχρεωτικόΣημείο παραλαβής
recipient_modeΣυμβολοσειράΥποχρεωτικόΜορφή της δομής δεδομένων, όπως ορίζεται από τις επιτρεπόμενες τιμές.
Περιορισμοί
enum["full_address", "pickup_contact"]
taxMoneyDatanullΥποχρεωτικόΠοσό φόρου · Μετά τις εκπτώσεις; Άγνωστο: null· γνωστό μηδέν: 0.
tax_category_idΣυμβολοσειρά nullΥποχρεωτικόΑναγνωριστικό φορολογικής κατηγορίας · Αποθηκευμένα στοιχεία παραγγελίας; null.
tax_category_nameΣυμβολοσειρά nullΥποχρεωτικόΑποθηκευμένο όνομα φορολογικής κατηγορίας; null.
tax_rateΣυμβολοσειρά nullΥποχρεωτικόtax_rate · Αποθηκευμένα στοιχεία παραγγελίας: "0.23" = 23%; "0" ≠ null.
Πρόσθετα πεδία: Όχι