Μετάβαση στο περιεχόμενο
ShopentlyLearn

Σχήματα δεδομένων: Απόθεμα

Σχήματα δεδομένων: Απόθεμα. Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.

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

Ποσότητες που έχουν κατανεμηθεί σε θέσεις αποθήκης

AllocationData · Σχήμα · Σχήματα δεδομένων: Απόθεμα
location_codeΣυμβολοσειράΥποχρεωτικό

Κωδικός θέσης αποθήκης.

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

Αναγνωριστικό θέσης αποθήκης.

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

Όνομα θέσης αποθήκης.

Παράδειγμα: "example"
on_handΑκέραιοςΥποχρεωτικό

Ποσότητα φυσικού αποθέματος.

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

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

ApiResponse[CodeContentData]

ApiResponse_CodeContentData_ · Ο κωδικός επιστρέφεται ως JSON, το αρχείο ως δυαδικά δεδομένα. Κάθε αίτημα απαιτεί Bearer και δικαίωμα reveal.
dataCodeContentData Υποχρεωτικό

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

Παράδειγμα: {"code":"DEMO-ONE","delivery_id":null,"kind":"code","payload_id":"00000000-0000-4000-8000-000000000004","unit_id":"00000000-0000-4000-8000-000000000003"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Υποχρεωτικό

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

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

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

ApiResponse[DigitalUploadData]

ApiResponse_DigitalUploadData_ · Έλεγξε μέγεθος, άθροισμα ελέγχου και μορφή. Έτοιμη μεταφόρτωση δεν σημαίνει ολοκληρωμένη παραλαβή.
dataDigitalUploadData Υποχρεωτικό

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

Παράδειγμα: {"consumer_id":"00000000-0000-4000-8000-000000000001","consumer_kind":"digital_import","expires_at":"2026-11-03T13:00:00Z","filename":"codes.txt","id":"00000000-0000-4000-8000-000000000002","product_id":"example","purpose":"digital_import","received_bytes":18,"sha256":"636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a","size_bytes":18,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Υποχρεωτικό

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

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

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

ApiResponse[ImportData]

ApiResponse_ImportData_ · Έλεγξε κατάσταση, έκδοση και επικύρωση. Το προσχέδιο ανήκει στο κλειδί API που το δημιούργησε.
dataImportData Υποχρεωτικό

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

Παράδειγμα: {"delivery_id":null,"delivery_status":null,"delivery_version":null,"expected_count":2,"expires_at":"2026-11-03T13:00:00Z","id":"00000000-0000-4000-8000-000000000001","kind":"code","product_id":"example","status":"validated","validated_count":2,"validation_digest":"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb","version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta Υποχρεωτικό

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

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

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

Λίστα · Αποθέματα — Απόθεμα — Απόκριση

ApiResponse_list_StockData__ · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
dataΠίνακας <StockData > Υποχρεωτικό

Παράδειγμα απόκρισης · ApiResponse_list_StockData__.

Παράδειγμα: [{"active":true,"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Υποχρεωτικό

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

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

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

ApiResponse[PoolData]

ApiResponse_PoolData_ · Διάβασε ρυθμίσεις και ποσότητες πριν τις αλλάξεις. Η απόκριση δεν περιέχει κωδικούς ή αρχεία.
dataPoolData Υποχρεωτικό

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

Παράδειγμα: {"configured":true,"counts":{"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0},"email_mode":"order_link","enabled":true,"order_version":2,"product_id":"example","retention_days":null,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Υποχρεωτικό

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

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

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

Ανάκτηση · Αποθέματα — Απόθεμα — Απόκριση

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

Παράδειγμα απόκρισης · StockDetailData.

Παράδειγμα: {"active":true,"allocations":[{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}],"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Υποχρεωτικό

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

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

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

ApiResponse[UnitsData]

ApiResponse_UnitsData_ · Διάβασε έως 100 μονάδες ανά σελίδα. Η λίστα δείχνει μεταδεδομένα χωρίς αποκάλυψη κωδικών.
dataUnitsData Υποχρεωτικό

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

Παράδειγμα: {"order_version":2,"total":1,"units":[{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]}
metaContextPageMeta ContextMeta PageMeta RequestMeta Υποχρεωτικό

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

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

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

CodeContentData

CodeContentData · Ο κωδικός επιστρέφεται ως JSON, το αρχείο ως δυαδικά δεδομένα. Κάθε αίτημα απαιτεί Bearer και δικαίωμα reveal.
codeΣυμβολοσειράΥποχρεωτικό

Ο ακριβής ψηφιακός κωδικός. Διατηρήστε τα κεφαλαία και τα εσωτερικά κενά.

minLength: 1maxLength: 512
Παράδειγμα: "DEMO-ONE"
delivery_idΣυμβολοσειρά nullΠροαιρετικό

ID παραλαβής ή εκχώρησης παραγγελίας.

Συμβολοσειρά:format: "uuid"
Παράδειγμα: null
kindΣυμβολοσειράΠροαιρετικό

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

const: "code"
Προεπιλογή: "code"Παράδειγμα: "code"
payload_idΣυμβολοσειράΥποχρεωτικό

ID περιεχομένου· δεν είναι δημόσιο URL λήψης.

format: "uuid"
Παράδειγμα: "00000000-0000-4000-8000-000000000004"
unit_idΣυμβολοσειράΥποχρεωτικό

ID ενός μεμονωμένου κωδικού ή αρχείου.

format: "uuid"
Παράδειγμα: "00000000-0000-4000-8000-000000000003"

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

DigitalUploadCreate

DigitalUploadCreate · Δέσμευσε χώρο για αρχείο και σύνδεσέ το με εισαγωγή ή μονάδα προς αντικατάσταση.
consumer_idΣυμβολοσειράΥποχρεωτικό

ID της συνδεδεμένης εισαγωγής ή μονάδας.

format: "uuid"
Παράδειγμα: "00000000-0000-4000-8000-000000000001"
consumer_kindΣυμβολοσειράΥποχρεωτικό

Σύνδεση μεταφόρτωσης: digital_import / digital_unit.

Περιορισμοί
enum
["digital_import", "digital_unit"]
Παράδειγμα: "digital_import"
filenameΣυμβολοσειράΥποχρεωτικό

Αρχείο

minLength: 1maxLength: 255
Παράδειγμα: "codes.txt"
purposeΣυμβολοσειράΥποχρεωτικό

digital_import: TXT/CSV· digital_unit: αρχείο που πωλείται μεμονωμένα.

Περιορισμοί
enum
["digital_unit", "digital_import"]
Παράδειγμα: "digital_import"
sha256ΣυμβολοσειράΥποχρεωτικό

SHA-256 (hex, 64)

Περιορισμοί
pattern
"^[0-9a-f]{64}$"
Παράδειγμα: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"
size_bytesΑκέραιοςΥποχρεωτικό

Μέγεθος σε byte

minimum: 1maximum: 262144000
Παράδειγμα: 18

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

DigitalUploadData

DigitalUploadData · Έλεγξε μέγεθος, άθροισμα ελέγχου και μορφή. Έτοιμη μεταφόρτωση δεν σημαίνει ολοκληρωμένη παραλαβή.
consumer_idΣυμβολοσειράΥποχρεωτικό

ID της συνδεδεμένης εισαγωγής ή μονάδας.

format: "uuid"
Παράδειγμα: "00000000-0000-4000-8000-000000000001"
consumer_kindΣυμβολοσειράΥποχρεωτικό

Σύνδεση μεταφόρτωσης: digital_import / digital_unit.

Περιορισμοί
enum
["digital_import", "digital_unit"]
Παράδειγμα: "digital_import"
expires_atΣυμβολοσειράΥποχρεωτικό

Χρόνος λήξης αυτής της μεταφόρτωσης ή εισαγωγής.

format: "date-time"
Παράδειγμα: "2026-11-03T13:00:00Z"
filenameΣυμβολοσειράΥποχρεωτικό

Αρχείο

Παράδειγμα: "codes.txt"
idΣυμβολοσειράΥποχρεωτικό

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

format: "uuid"
Παράδειγμα: "00000000-0000-4000-8000-000000000002"
product_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό προϊόντος.

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

digital_import: TXT/CSV· digital_unit: αρχείο που πωλείται μεμονωμένα.

Περιορισμοί
enum
["digital_unit", "digital_import"]
Παράδειγμα: "digital_import"
received_bytesΑκέραιοςΥποχρεωτικό

Μεταφόρτωση… · Μέγεθος σε byte

Παράδειγμα: 18
sha256ΣυμβολοσειράΥποχρεωτικό

SHA-256 (hex, 64)

Παράδειγμα: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"
size_bytesΑκέραιοςΥποχρεωτικό

Μέγεθος σε byte

Παράδειγμα: 18
statusΣυμβολοσειράΥποχρεωτικό

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

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

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

ImportCommit

ImportCommit · Δημιούργησε προγραμματισμένη ή ολοκληρωμένη παραλαβή από την έγκυρη παρτίδα. Οι προγραμματισμένες μονάδες δεν πωλούνται ακόμη.
delivered_atΣυμβολοσειράΥποχρεωτικό

Ημερομηνία και ώρα παράδοσης.

format: "date-time"
Παράδειγμα: "2026-11-03T12:00:00Z"
expected_delivery_versionΑκέραιοςΥποχρεωτικό

Έκδοση παραλαβής· 0 για νέα παραλαβή.

minimum: 0maximum: 0
Παράδειγμα: 0
expected_sales_limit_versionΑκέραιος nullΠροαιρετικό

Έκδοση ορίου πωλήσεων· απαιτείται με publish_for_sale=true.

Ακέραιος:minimum: 0maximum: 9223372036854775807
Παράδειγμα: 0
expected_versionΑκέραιοςΥποχρεωτικό

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

minimum: 1maximum: 9223372036854775807
Παράδειγμα: 2
location_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό θέσης αποθήκης.

Περιορισμοί
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Παράδειγμα: "location-digital"
publish_for_saleΛογική τιμήΠροαιρετικό

true αυξάνει και το πεπερασμένο όριο πωλήσεων· false δεν το αλλάζει.

Προεπιλογή: falseΠαράδειγμα: true
statusΣυμβολοσειράΥποχρεωτικό

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

Περιορισμοί
enum
["planned", "received"]
Παράδειγμα: "received"
validation_digestΣυμβολοσειράΥποχρεωτικό

Άθροισμα ελέγχου της επικύρωσης· στείλε το αμετάβλητο στην επιβεβαίωση.

Περιορισμοί
pattern
"^[0-9a-f]{64}$"
Παράδειγμα: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
warehouse_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αποθήκης.

Περιορισμοί
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Παράδειγμα: "warehouse-main"

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

ImportCreate

ImportCreate · Ετοίμασε προσχέδιο με έως 1000 κωδικούς ή 100 αρχεία. Το πωλήσιμο απόθεμα δεν αυξάνεται ακόμη.
countΑκέραιοςΥποχρεωτικό

Ακριβής αριθμός μονάδων της παρτίδας.

minimum: 1maximum: 1000
Παράδειγμα: 2
kindΣυμβολοσειράΥποχρεωτικό

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

Περιορισμοί
enum
["code", "file"]
Παράδειγμα: "code"

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

ImportData

ImportData · Έλεγξε κατάσταση, έκδοση και επικύρωση. Το προσχέδιο ανήκει στο κλειδί API που το δημιούργησε.
delivery_idΣυμβολοσειρά nullΥποχρεωτικό

ID παραλαβής ή εκχώρησης παραγγελίας.

Παράδειγμα: null
delivery_statusΣυμβολοσειρά nullΥποχρεωτικό

Κατάσταση παραλαβής: planned / received· null πριν την επιβεβαίωση.

Παράδειγμα: null
delivery_versionΑκέραιος nullΥποχρεωτικό

Τρέχουσα έκδοση της παραλαβής αποθήκης.

Παράδειγμα: null
expected_countΑκέραιοςΥποχρεωτικό

Αναμενόμενο πλήθος· γίνεται δεκτή μόνο ολόκληρη η παρτίδα.

Παράδειγμα: 2
expires_atΣυμβολοσειράΥποχρεωτικό

Χρόνος λήξης αυτής της μεταφόρτωσης ή εισαγωγής.

format: "date-time"
Παράδειγμα: "2026-11-03T13:00:00Z"
idΣυμβολοσειράΥποχρεωτικό

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

format: "uuid"
Παράδειγμα: "00000000-0000-4000-8000-000000000001"
kindΣυμβολοσειράΥποχρεωτικό

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

Περιορισμοί
enum
["code", "file"]
Παράδειγμα: "code"
product_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό προϊόντος.

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

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

Παράδειγμα: "validated"
validated_countΑκέραιοςΥποχρεωτικό

Μονάδες που έγιναν δεκτές στην τελευταία επιτυχή επικύρωση.

Παράδειγμα: 2
validation_digestΣυμβολοσειρά nullΥποχρεωτικό

Άθροισμα ελέγχου της επικύρωσης· στείλε το αμετάβλητο στην επιβεβαίωση.

Παράδειγμα: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
versionΑκέραιοςΥποχρεωτικό

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

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

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

ImportReceive

ImportReceive · Παράλαβε τις υπάρχουσες μονάδες χωρίς νέα εισαγωγή κωδικών ή αρχείων.
expected_delivery_versionΑκέραιοςΥποχρεωτικό

Έκδοση παραλαβής· 0 για νέα παραλαβή.

minimum: 1maximum: 9223372036854775807
Παράδειγμα: 1
expected_sales_limit_versionΑκέραιος nullΠροαιρετικό

Έκδοση ορίου πωλήσεων· απαιτείται με publish_for_sale=true.

Ακέραιος:minimum: 0maximum: 9223372036854775807
expected_versionΑκέραιοςΥποχρεωτικό

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

minimum: 1maximum: 9223372036854775807
Παράδειγμα: 3
publish_for_saleΛογική τιμήΠροαιρετικό

true αυξάνει και το πεπερασμένο όριο πωλήσεων· false δεν το αλλάζει.

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

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

ImportValidate

ImportValidate · Έλεγξε ολόκληρη την παρτίδα. Διπλότυπη ή άκυρη εγγραφή απορρίπτει την παρτίδα· οι κωδικοί δεν περικόπτονται.
code_columnΣυμβολοσειρά nullΠροαιρετικό

Στήλη CSV με κωδικούς· χρησιμοποίησε code.

Συμβολοσειρά:const: "code"
expected_versionΑκέραιοςΥποχρεωτικό

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

minimum: 1maximum: 9223372036854775807
Παράδειγμα: 1
formatΣυμβολοσειρά nullΠροαιρετικό

Λίστα κωδικών: txt / csv· για αρχεία χρησιμοποίησε upload_ids.

Περιορισμοί · Συμβολοσειρά 1
enum
["txt", "csv"]
Παράδειγμα: "txt"
source_upload_idΣυμβολοσειρά nullΠροαιρετικό

Έτοιμη ιδιωτική μεταφόρτωση TXT/CSV αυτής της εισαγωγής.

Συμβολοσειρά:format: "uuid"
Παράδειγμα: "00000000-0000-4000-8000-000000000002"
upload_idsΠίνακας <Συμβολοσειρά> nullΠροαιρετικό

1–100 έτοιμες ιδιωτικές μεταφορτώσεις αρχείων αυτής της εισαγωγής.

Πίνακας:minItems: 1maxItems: 100
Πίνακας / Πίνακας:format: "uuid"

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

ImportWithdrawal

ImportWithdrawal · Ανάκλησε μόνο ελεύθερες μονάδες. Δεσμευμένες και εκχωρημένες μονάδες παραμένουν στις παραγγελίες τους.
expected_delivery_versionΑκέραιοςΥποχρεωτικό

Έκδοση παραλαβής· 0 για νέα παραλαβή.

minimum: 1maximum: 9223372036854775807
Παράδειγμα: 1
expected_order_versionΑκέραιοςΥποχρεωτικό

Έκδοση της σειράς εκχώρησης, όχι της παραγγελίας πελάτη.

minimum: 0maximum: 9223372036854775807
Παράδειγμα: 1
expected_versionΑκέραιοςΥποχρεωτικό

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

minimum: 1maximum: 9223372036854775807
Παράδειγμα: 3
reasonΣυμβολοσειράΥποχρεωτικό

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

minLength: 1maxLength: 500
Παράδειγμα: "Withdraw a revoked license"

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

Ενημέρωση · Χειροκίνητη κράτηση — Απόθεμα — Περιεχόμενο αιτήματος

ManualReservationUpdate · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
expected_versionΑκέραιοςΥποχρεωτικό

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

minimum: 1maximum: 9223372036854775807
Παράδειγμα: 1
manual_reservedΑκέραιοςΥποχρεωτικό

Ποσότητα δεσμευμένη χειροκίνητα.

minimum: 0maximum: 2147483647
Παράδειγμα: 1
reasonΣυμβολοσειράΠροαιρετικό

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

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

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

PoolChange

PoolChange · Ενεργοποίησε μεμονωμένους κωδικούς ή αρχεία από το Professional. Η απενεργοποίηση διατηρεί την πρόσβαση προηγούμενων αγορών.
email_modeΣυμβολοσειράΠροαιρετικό

disabled: χωρίς e-mail· order_link: σύνδεσμος παραγγελίας· code_text: ενδέχεται να περιέχει και κωδικούς.

Περιορισμοί
enum
["disabled", "order_link", "code_text"]
Προεπιλογή: "disabled"Παράδειγμα: "order_link"
enabledΛογική τιμήΥποχρεωτικό

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

Παράδειγμα: true
expected_versionΑκέραιοςΥποχρεωτικό

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

minimum: 0maximum: 9223372036854775807
Παράδειγμα: 0
retention_daysΑκέραιος nullΠροαιρετικό

null: χωρίς λήξη· 1–3650 ημέρες από την πρώτη πρόσβαση. Οι κωδικοί δεν διαγράφονται αυτόματα.

Ακέραιος:minimum: 1maximum: 3650
Παράδειγμα: null

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

PoolCounts

PoolCounts · Διάβασε ρυθμίσεις και ποσότητες πριν τις αλλάξεις. Η απόκριση δεν περιέχει κωδικούς ή αρχεία.
availableΑκέραιοςΥποχρεωτικό

Πλήθος ελεύθερων μονάδων που δεν έχουν δεσμευτεί ή παραδοθεί.

Παράδειγμα: 1
heldΑκέραιοςΥποχρεωτικό

Μονάδες δεσμευμένες για παραγγελίες, δεν έχουν δοθεί ακόμη.

Παράδειγμα: 0
issuedΑκέραιοςΥποχρεωτικό

Μονάδες που έχουν δοθεί σε πληρωμένες αγορές.

Παράδειγμα: 1
plannedΑκέραιοςΥποχρεωτικό

Μονάδες επιβεβαιωμένων αλλά μη ολοκληρωμένων παραλαβών.

Παράδειγμα: 0
retiredΑκέραιοςΥποχρεωτικό

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

Παράδειγμα: 0
stagedΑκέραιοςΥποχρεωτικό

Μονάδες ημιτελών εισαγωγών, δεν αποτελούν ακόμη απόθεμα.

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

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

PoolData

PoolData · Διάβασε ρυθμίσεις και ποσότητες πριν τις αλλάξεις. Η απόκριση δεν περιέχει κωδικούς ή αρχεία.
configuredΛογική τιμήΥποχρεωτικό

Αν έχουν αποθηκευτεί οι ρυθμίσεις αποθέματος.

Παράδειγμα: true
countsPoolCounts Υποχρεωτικό

Πλήθος μονάδων ανά κατάσταση αποθέματος.

Παράδειγμα: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}
email_modeΣυμβολοσειράΥποχρεωτικό

disabled: χωρίς e-mail· order_link: σύνδεσμος παραγγελίας· code_text: ενδέχεται να περιέχει και κωδικούς.

Περιορισμοί
enum
["disabled", "order_link", "code_text"]
Παράδειγμα: "order_link"
enabledΛογική τιμήΥποχρεωτικό

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

Παράδειγμα: true
order_versionΑκέραιοςΥποχρεωτικό

Έκδοση της σειράς εκχώρησης αποθέματος.

Παράδειγμα: 2
product_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό προϊόντος.

Παράδειγμα: "example"
retention_daysΑκέραιος nullΥποχρεωτικό

null: χωρίς λήξη· 1–3650 ημέρες από την πρώτη πρόσβαση. Οι κωδικοί δεν διαγράφονται αυτόματα.

Παράδειγμα: null
versionΑκέραιοςΥποχρεωτικό

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

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

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

Ενημέρωση · Όριο πωλήσεων — Απόθεμα — Περιεχόμενο αιτήματος

SalesLimitUpdate · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
expected_versionΑκέραιοςΥποχρεωτικό

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

minimum: 1maximum: 9223372036854775807
Παράδειγμα: 1
reasonΣυμβολοσειράΠροαιρετικό

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

maxLength: 500
Προεπιλογή: ""
sellable_limitΑκέραιοςΥποχρεωτικό

Όριο πωλήσεων: -1 σημαίνει απεριόριστο και 0 απενεργοποιεί τις διαθέσιμες πωλήσεις.

minimum: -1maximum: 2147483647
Παράδειγμα: 1

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

Δημιουργία · Προσαρμογή αποθέματος — Απόθεμα — Περιεχόμενο αιτήματος

StockAdjustmentCreate · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
expected_versionΑκέραιοςΥποχρεωτικό

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

minimum: 0maximum: 9223372036854775807
Παράδειγμα: 0
locationsΠίνακας <LocationQuantity > Υποχρεωτικό

Θέσεις αποθήκης.

minItems: 1maxItems: 100
Παράδειγμα: [{"location_id":"example","on_hand":1}]
reasonΣυμβολοσειράΥποχρεωτικό

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

minLength: 1maxLength: 500
Παράδειγμα: "Example"
target_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό προϊόντος ή παραλλαγής που επηρεάζει η λειτουργία.

Περιορισμοί
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Παράδειγμα: "example"
target_typeΣυμβολοσειράΥποχρεωτικό

Δείχνει αν η λειτουργία αφορά προϊόν ή παραλλαγή.

Περιορισμοί
enum
["product", "variant"]
Παράδειγμα: "product"
warehouse_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αποθήκης.

Περιορισμοί
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Παράδειγμα: "example"

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

Ενημέρωση · Αποθέματα — Απόθεμα — Περιεχόμενο αιτήματος

StockAdjustmentUpdate · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
expected_versionΑκέραιοςΥποχρεωτικό

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

minimum: 1maximum: 9223372036854775807
Παράδειγμα: 1
locationsΠίνακας <LocationQuantity > Υποχρεωτικό

Θέσεις αποθήκης.

minItems: 1maxItems: 100
Παράδειγμα: [{"location_id":"example","on_hand":1}]
reasonΣυμβολοσειράΥποχρεωτικό

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

minLength: 1maxLength: 500
Παράδειγμα: "Example"

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

Λίστα · Αποθέματα — Απόθεμα — Απόκριση

StockData · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
activeΛογική τιμήΥποχρεωτικό

Δείχνει αν ο πόρος είναι ενεργός.

Παράδειγμα: true
availableΑκέραιος nullΥποχρεωτικό

Ποσότητα διαθέσιμη προς πώληση· null σημαίνει απεριόριστη ποσότητα.

Παράδειγμα: 5
idΣυμβολοσειράΥποχρεωτικό

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

Παράδειγμα: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"
manual_reservedΑκέραιοςΥποχρεωτικό

Ποσότητα δεσμευμένη χειροκίνητα.

Παράδειγμα: 2
on_handΑκέραιοςΥποχρεωτικό

Ποσότητα φυσικού αποθέματος.

Παράδειγμα: 10
reservedΑκέραιοςΥποχρεωτικό

Ποσότητα δεσμευμένη από παραγγελίες.

Παράδειγμα: 3
sellable_limitΑκέραιοςΥποχρεωτικό

Όριο πωλήσεων: -1 σημαίνει απεριόριστο και 0 απενεργοποιεί τις διαθέσιμες πωλήσεις.

Παράδειγμα: 10
target_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό προϊόντος ή παραλλαγής που επηρεάζει η λειτουργία.

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

Δείχνει αν η λειτουργία αφορά προϊόν ή παραλλαγή.

Περιορισμοί
enum
["product", "variant"]
Παράδειγμα: "product"
total_reservedΑκέραιοςΥποχρεωτικό

Συνολική δεσμευμένη ποσότητα.

Παράδειγμα: 5
updated_atΣυμβολοσειράΥποχρεωτικό

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

format: "date-time"
Παράδειγμα: "2026-01-01T12:00:00Z"
versionΑκέραιοςΥποχρεωτικό

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

Παράδειγμα: 1
warehouse_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αποθήκης.

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

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

Ανάκτηση · Αποθέματα — Απόθεμα — Απόκριση

StockDetailData · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
activeΛογική τιμήΥποχρεωτικό

Δείχνει αν ο πόρος είναι ενεργός.

Παράδειγμα: true
allocationsΠίνακας <AllocationData > Υποχρεωτικό

Ποσότητες που έχουν κατανεμηθεί σε θέσεις αποθήκης.

Παράδειγμα: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]
availableΑκέραιος nullΥποχρεωτικό

Ποσότητα διαθέσιμη προς πώληση· null σημαίνει απεριόριστη ποσότητα.

Παράδειγμα: 5
idΣυμβολοσειράΥποχρεωτικό

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

Παράδειγμα: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"
manual_reservedΑκέραιοςΥποχρεωτικό

Ποσότητα δεσμευμένη χειροκίνητα.

Παράδειγμα: 2
on_handΑκέραιοςΥποχρεωτικό

Ποσότητα φυσικού αποθέματος.

Παράδειγμα: 10
reservedΑκέραιοςΥποχρεωτικό

Ποσότητα δεσμευμένη από παραγγελίες.

Παράδειγμα: 3
sellable_limitΑκέραιοςΥποχρεωτικό

Όριο πωλήσεων: -1 σημαίνει απεριόριστο και 0 απενεργοποιεί τις διαθέσιμες πωλήσεις.

Παράδειγμα: 10
target_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό προϊόντος ή παραλλαγής που επηρεάζει η λειτουργία.

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

Δείχνει αν η λειτουργία αφορά προϊόν ή παραλλαγή.

Περιορισμοί
enum
["product", "variant"]
Παράδειγμα: "product"
total_reservedΑκέραιοςΥποχρεωτικό

Συνολική δεσμευμένη ποσότητα.

Παράδειγμα: 5
updated_atΣυμβολοσειράΥποχρεωτικό

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

format: "date-time"
Παράδειγμα: "2026-01-01T12:00:00Z"
versionΑκέραιοςΥποχρεωτικό

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

Παράδειγμα: 1
warehouse_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό αποθήκης.

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

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

UnitData

UnitData · Διάβασε έως 100 μονάδες ανά σελίδα. Η λίστα δείχνει μεταδεδομένα χωρίς αποκάλυψη κωδικών.
content_stateΣυμβολοσειράΥποχρεωτικό

Κατάσταση περιεχομένου: present / deleting / deleted.

Παράδειγμα: "present"
delivery_idΣυμβολοσειρά nullΥποχρεωτικό

ID παραλαβής ή εκχώρησης παραγγελίας.

Παράδειγμα: "delivery-example"
filenameΣυμβολοσειρά nullΥποχρεωτικό

Αρχείο

Παράδειγμα: null
idΣυμβολοσειράΥποχρεωτικό

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

format: "uuid"
Παράδειγμα: "00000000-0000-4000-8000-000000000003"
issued_atΣυμβολοσειρά nullΥποχρεωτικό

Πρώτη παράδοση· null πριν από αυτή.

Συμβολοσειρά:format: "date-time"
Παράδειγμα: null
kindΣυμβολοσειράΥποχρεωτικό

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

Περιορισμοί
enum
["file", "code"]
Παράδειγμα: "code"
location_idΣυμβολοσειρά nullΥποχρεωτικό

Αναγνωριστικό θέσης αποθήκης.

Παράδειγμα: "location-digital"
mime_typeΣυμβολοσειρά nullΥποχρεωτικό

Τύπος περιεχομένου πολυμέσων.

Παράδειγμα: null
payload_idΣυμβολοσειράΥποχρεωτικό

ID περιεχομένου· δεν είναι δημόσιο URL λήψης.

format: "uuid"
Παράδειγμα: "00000000-0000-4000-8000-000000000004"
product_idΣυμβολοσειράΥποχρεωτικό

Αναγνωριστικό προϊόντος.

Παράδειγμα: "example"
size_bytesΑκέραιος nullΥποχρεωτικό

Μέγεθος σε byte

Παράδειγμα: null
sort_orderΑκέραιοςΥποχρεωτικό

Θέση στην ταξινομημένη συλλογή.

Παράδειγμα: 1
stateΣυμβολοσειράΥποχρεωτικό

Κατάσταση

Παράδειγμα: "available"
versionΑκέραιοςΥποχρεωτικό

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

Παράδειγμα: 1
warehouse_idΣυμβολοσειρά nullΥποχρεωτικό

Αναγνωριστικό αποθήκης.

Παράδειγμα: "warehouse-main"

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

UnitDeletion

UnitDeletion · Αφαίρεσε απούλητο κωδικό ή αρχείο με αιτιολογία. Δεσμευμένες ή εκχωρημένες μονάδες απορρίπτονται.
expected_versionΑκέραιοςΥποχρεωτικό

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

minimum: 1
Παράδειγμα: 1
reasonΣυμβολοσειράΥποχρεωτικό

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

minLength: 1maxLength: 500
Παράδειγμα: "Withdraw a revoked license"

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

UnitReorder

UnitReorder · Στείλε ολόκληρη τη μη φιλτραρισμένη σελίδα με την επιθυμητή σειρά. Παρωχημένη έκδοση επιστρέφει 409.
expected_order_versionΑκέραιοςΥποχρεωτικό

Έκδοση της σειράς εκχώρησης, όχι της παραγγελίας πελάτη.

minimum: 1
Παράδειγμα: 1
unit_idsΠίνακας <Συμβολοσειρά> Υποχρεωτικό

Όλες οι μονάδες της μη φιλτραρισμένης σελίδας στην επιθυμητή σειρά.

minItems: 2maxItems: 100
Πίνακας:format: "uuid"
Παράδειγμα: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]
window_cursorΣυμβολοσειρά nullΠροαιρετικό

Δείκτης μη φιλτραρισμένης σελίδας· null για την πρώτη.

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

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

UnitReplacement

UnitReplacement · Αντικατάστησε κωδικό ή αρχείο χωρίς αλλαγή σειράς. Η αλλαγή παραμένει στο ιστορικό αποθήκης.
codeΣυμβολοσειρά nullΠροαιρετικό

Ο ακριβής ψηφιακός κωδικός. Διατηρήστε τα κεφαλαία και τα εσωτερικά κενά.

Συμβολοσειρά:minLength: 1maxLength: 512
Παράδειγμα: "SYNTHETIC-REPLACEMENT"
expected_versionΑκέραιοςΥποχρεωτικό

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

minimum: 1
Παράδειγμα: 1
reasonΣυμβολοσειράΥποχρεωτικό

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

minLength: 1maxLength: 500
Παράδειγμα: "Replace an invalid activation code"
upload_idΣυμβολοσειρά nullΠροαιρετικό

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

Συμβολοσειρά:format: "uuid"

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

UnitsData

UnitsData · Διάβασε έως 100 μονάδες ανά σελίδα. Η λίστα δείχνει μεταδεδομένα χωρίς αποκάλυψη κωδικών.
order_versionΑκέραιοςΥποχρεωτικό

Έκδοση της σειράς εκχώρησης αποθέματος.

Παράδειγμα: 2
totalΑκέραιοςΥποχρεωτικό

Συνολικό ποσό.

Παράδειγμα: 1
unitsΠίνακας <UnitData > Υποχρεωτικό

Μεταδεδομένα μονάδων· το περιεχόμενο απαιτεί ξεχωριστό εξουσιοδοτημένο αίτημα.

Παράδειγμα: [{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]

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