Σχήματα δεδομένων: Επιστροφές, παράπονα και ανταλλαγές

Σχήματα δεδομένων: Επιστροφές, παράπονα και ανταλλαγές. Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.

Σχήματα δεδομένων

Λίστα — Επιστροφές, παράπονα και ανταλλαγές — Απόκριση

ApiResponse_list_RequestSummaryData__ · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.

dataΠίνακας <RequestSummaryData > Υποχρεωτικό: Παράδειγμα απόκρισης · ApiResponse_list_RequestSummaryData__.

Παράδειγμα: [{"created_at":"2026-01-01T12:00:00Z","customer":{"email":"customer@example.invalid","name":"Example"},"id":"example","number":"example","order_id":"example","order_number":"example","products_value":{"amount":"0.00","currency":"PLN","minor_units":2},"refund":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1},"resolution_state":"unknown","status":{"id":"example","locale":"en","name":"Example"},"type":"return","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Υποχρεωτικό: Μεταδεδομένα απόκρισης.

Παράδειγμα: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

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

Ανάκτηση — Επιστροφές, παράπονα και ανταλλαγές — Απόκριση

ApiResponse_RequestDetailData_ · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.

dataRequestDetailData Υποχρεωτικό: Παράδειγμα απόκρισης · RequestDetailData.

Παράδειγμα: {"created_at":"2026-01-01T12:00:00Z","customer":{"email":"customer@example.invalid","name":"Example"},"id":"example","items":[{"id":"example","name":"Example","order_line_id":"example","product_id":"example","quantity":1,"returned_quantity":1,"sku":"example","total":{"amount":"0.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"0.00","currency":"PLN","minor_units":2},"variant_id":"example","variant_options":[{"name":"Example","value":"example"}]}],"number":"example","order_id":"example","order_number":"example","products_value":{"amount":"0.00","currency":"PLN","minor_units":2},"refund":{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1},"resolution_state":"unknown","status":{"id":"example","locale":"en","name":"Example"},"type":"return","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Υποχρεωτικό: Μεταδεδομένα απόκρισης.

Παράδειγμα: {"request_id":"example"}

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

Ενημέρωση · Ποσό επιστροφής — Επιστροφές, παράπονα και ανταλλαγές — Περιεχόμενο αιτήματος

RefundAmountUpdate · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.

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

Δεκαδικό ποσό ως συμβολοσειρά JSON· null μόνο όπου επιτρέπεται.

minLength: 1maxLength: 64

Περιορισμοί

pattern: "^[+-]?(?:[0-9]+(?:\\.[0-9]+)?|\\.[0-9]+)(?:[eE][+-]?[0-9]+)?$"

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

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

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

minimum: 0maximum: 9223372036854775807

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

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

Αιτιολογία που καταγράφηκε για την αλλαγή.

maxLength: 500

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

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

Καταγεγραμμένες πληροφορίες επιστροφής χρημάτων

RefundData · Σχήμα · Σχήματα δεδομένων: Επιστροφές, παράπονα και ανταλλαγές

amountMoneyData nullΥποχρεωτικό

Δεκαδικό ποσό ως συμβολοσειρά JSON· null μόνο όπου επιτρέπεται.

Παράδειγμα: {"amount":"0.00","currency":"PLN","minor_units":2}

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

Χρόνος ολοκλήρωσης.

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

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

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

Κατάσταση αποδεκτή από τη συγκεκριμένη λειτουργία.

Περιορισμοί

enum: ["pending", "completed"]

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

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

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

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

Παράδειγμα: "2026-01-01T12:00:00Z"

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

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

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

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

Ανάκτηση — Επιστροφές, παράπονα και ανταλλαγές — Απόκριση

RequestDetailData · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.

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

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

format: "date-time"

Παράδειγμα: "2026-01-01T12:00:00Z"

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

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

Παράδειγμα: {"email":"customer@example.invalid","name":"Example"}

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

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

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

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

Στοιχεία που περιλαμβάνονται στον πόρο.

Παράδειγμα:

[{"id":"example","name":"Example","order_line_id":"example","product_id":"example","quantity":1,"returned_quantity":1,"sku":"example","total":{"amount":"0.00","currency":"PLN","minor_units":2},"unit_price":{"amount":"0.00","currency":"PLN","minor_units":2},"variant_id":"example","variant_options":[{"name":"Example","value":"example"}]}]

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

Αριθμός παραγγελίας ή αιτήματος που εμφανίζεται στον χρήστη.

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

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

Αναγνωριστικό σχετικής παραγγελίας.

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

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

Αριθμός σχετικής παραγγελίας.

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

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

Αξία προϊόντων της παραγγελίας.

Παράδειγμα: {"amount":"0.00","currency":"PLN","minor_units":2}

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

Καταγεγραμμένες πληροφορίες επιστροφής χρημάτων.

Παράδειγμα:

{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1}

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

Κατάσταση επίλυσης αιτήματος πελάτη.

Περιορισμοί

enum: ["unknown", "open", "completed", "rejected", "cancelled"]

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

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

Κατάσταση αποδεκτή από τη συγκεκριμένη λειτουργία.

Παράδειγμα: {"id":"example","locale":"en","name":"Example"}

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

Τύπος πόρου.

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

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

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

format: "date-time"

Παράδειγμα: "2026-01-01T12:00:00Z"

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

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

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

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

Ανάκτηση — Επιστροφές, παράπονα και ανταλλαγές — Απόκριση

RequestItemData · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.

idΣυμβολοσειράΥποχρεωτικό: Αναγνωριστικό πόρου· διατηρήστε το ακριβώς όπως επιστρέφεται. (RequestItemData).

Παράδειγμα: "example"
nameΣυμβολοσειράΥποχρεωτικό: Όνομα πόρου στο σχετικό πλαίσιο.

Παράδειγμα: "Example"
order_line_idΣυμβολοσειρά nullΥποχρεωτικό: Αναγνωριστικό σχετικής γραμμής παραγγελίας.

Παράδειγμα: "example"
product_idΣυμβολοσειράΥποχρεωτικό: Αναγνωριστικό προϊόντος.

Παράδειγμα: "example"
quantityΑκέραιοςΥποχρεωτικό: Πλήθος μονάδων.

Παράδειγμα: 1
returned_quantityΑκέραιοςΥποχρεωτικό: Επιστραφείσα ποσότητα αυτής της γραμμής.

Παράδειγμα: 1
skuΣυμβολοσειράΥποχρεωτικό: Κωδικός μονάδας αποθέματος.

Παράδειγμα: "example"
totalMoneyData Υποχρεωτικό: Συνολικό ποσό.

Παράδειγμα: {"amount":"0.00","currency":"PLN","minor_units":2}
unit_priceMoneyData Υποχρεωτικό: Τιμή ανά μονάδα.

Παράδειγμα: {"amount":"0.00","currency":"PLN","minor_units":2}
variant_idΣυμβολοσειρά nullΥποχρεωτικό: Αναγνωριστικό παραλλαγής προϊόντος.

Παράδειγμα: "example"
variant_optionsΠίνακας <shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData > Υποχρεωτικό: Επιλογές παραλλαγής που συνδέονται με το προϊόν ή το στιγμιότυπο.

Παράδειγμα: [{"name":"Example","value":"example"}]

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

Κατάσταση αποδεκτή από τη συγκεκριμένη λειτουργία

RequestStatusData · Σχήμα · Σχήματα δεδομένων: Επιστροφές, παράπονα και ανταλλαγές

idΣυμβολοσειράΥποχρεωτικό: Αναγνωριστικό πόρου· διατηρήστε το ακριβώς όπως επιστρέφεται. (RequestStatusData).

Παράδειγμα: "example"
localeΣυμβολοσειράΥποχρεωτικό: Γλώσσα που επιλέχθηκε για αυτό το αίτημα.

Παράδειγμα: "en"
nameΣυμβολοσειρά nullΥποχρεωτικό: Όνομα πόρου στο σχετικό πλαίσιο.

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

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

Λίστα · Καταστάσεις — Επιστροφές, παράπονα και ανταλλαγές — Απόκριση

shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.

codeΣυμβολοσειράΥποχρεωτικό: Σταθερός κωδικός για επεξεργασία από λογισμικό.

Παράδειγμα: "example"
created_atΣυμβολοσειράΥποχρεωτικό: Χρόνος δημιουργίας.

format: "date-time"

Παράδειγμα: "2026-01-01T12:00:00Z"
idΣυμβολοσειράΥποχρεωτικό: Αναγνωριστικό πόρου· διατηρήστε το ακριβώς όπως επιστρέφεται. (shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData).

Παράδειγμα: "example"
is_initialΛογική τιμήΥποχρεωτικό: Δείχνει αν είναι η αρχική κατάσταση.

Παράδειγμα: false
localeΣυμβολοσειράΥποχρεωτικό: Γλώσσα που επιλέχθηκε για αυτό το αίτημα.

Παράδειγμα: "en"
nameΣυμβολοσειρά nullΥποχρεωτικό: Όνομα πόρου στο σχετικό πλαίσιο.

Παράδειγμα: "Example"
positionΑκέραιοςΥποχρεωτικό: Θέση στην ταξινομημένη συλλογή.

Παράδειγμα: 1
typeRequestType Υποχρεωτικό: Τύπος πόρου.

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

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

Λίστα · Καταστάσεις — Επιστροφές, παράπονα και ανταλλαγές — Απόκριση

shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2 · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.

dataΠίνακας <shopently_engine__domains__returns__adapters__public_http__requests__schemas__StatusDefinitionData > Υποχρεωτικό: Παράδειγμα απόκρισης · shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2.

Παράδειγμα: [{"code":"example","created_at":"2026-01-01T12:00:00Z","id":"example","is_initial":false,"locale":"en","name":"Example","position":1,"type":"return"}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Υποχρεωτικό: Μεταδεδομένα απόκρισης.

Παράδειγμα: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

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

Ενημέρωση · Κατάσταση — Επιστροφές, παράπονα και ανταλλαγές — Περιεχόμενο αιτήματος

RequestStatusUpdate · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.

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

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

minimum: 1maximum: 9223372036854775807

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

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

Αναγνωριστικό από το αντίστοιχο λεξικό καταστάσεων.

Περιορισμοί

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

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

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

Λίστα — Επιστροφές, παράπονα και ανταλλαγές — Απόκριση

RequestSummaryData · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.

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

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

format: "date-time"

Παράδειγμα: "2026-01-01T12:00:00Z"

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

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

Παράδειγμα: {"email":"customer@example.invalid","name":"Example"}

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

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

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

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

Αριθμός παραγγελίας ή αιτήματος που εμφανίζεται στον χρήστη.

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

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

Αναγνωριστικό σχετικής παραγγελίας.

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

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

Αριθμός σχετικής παραγγελίας.

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

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

Αξία προϊόντων της παραγγελίας.

Παράδειγμα: {"amount":"0.00","currency":"PLN","minor_units":2}

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

Καταγεγραμμένες πληροφορίες επιστροφής χρημάτων.

Παράδειγμα:

{"amount":{"amount":"0.00","currency":"PLN","minor_units":2},"completed_at":null,"status":"pending","updated_at":"2026-01-01T12:00:00Z","version":1}

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

Κατάσταση επίλυσης αιτήματος πελάτη.

Περιορισμοί

enum: ["unknown", "open", "completed", "rejected", "cancelled"]

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

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

Κατάσταση αποδεκτή από τη συγκεκριμένη λειτουργία.

Παράδειγμα: {"id":"example","locale":"en","name":"Example"}

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

Τύπος πόρου.

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

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

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

format: "date-time"

Παράδειγμα: "2026-01-01T12:00:00Z"

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

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

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

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

Τύπος πόρου

RequestType · Σχήμα · Σχήματα δεδομένων: Επιστροφές, παράπονα και ανταλλαγές

Συμβολοσειρά

Περιορισμοί

enum: ["return", "exchange", "complaint"]

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

Επιλογές παραλλαγής που συνδέονται με το προϊόν ή το στιγμιότυπο

shopently_engine__domains__returns__adapters__public_http__requests__schemas__VariantOptionData · Σχήμα · Σχήματα δεδομένων: Επιστροφές, παράπονα και ανταλλαγές

nameΣυμβολοσειράΥποχρεωτικό: Όνομα πόρου στο σχετικό πλαίσιο.

Παράδειγμα: "Example"
valueΣυμβολοσειράΥποχρεωτικό: Τιμή που περιγράφεται από το περιβάλλον σχήμα.

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

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