Σχήματα δεδομένων: Κοινά μοντέλα

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

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

Περιορισμοί

enum

["storage.limit_reached", "request.malformed", "authentication.required", "authentication.invalid_credentials", "authorization.scope_denied", "authorization.ip_not_allowed", "authorization.client_ip_unverified", "entitlements.api_disabled", "entitlements.operation_disabled", "entitlements.limit_exceeded", "entitlements.resource_blocked", "resource.not_found", "request.method_not_allowed", "resource.version_conflict", "resource.state_conflict", "resource.in_use", "resource.already_exists", "idempotency.key_reused", "request.too_large", "request.unsupported_media_type", "request.validation_failed", "request.range_not_satisfiable", "rate_limit.exceeded", "capacity.queue_full", "capacity.wait_timeout", "internal.error", "gateway.bad_response", "service.unavailable", "gateway.timeout"]

Παράδειγμα: "resource.state_conflict"

fieldsΠίνακας <FieldError > | nullΠροαιρετικό

Σφάλματα επικύρωσης επιμέρους πεδίων.

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

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

Επεξήγηση για τον χρήστη· χρησιμοποιήστε τον κωδικό σφάλματος στη λογική του προγράμματος.

Παράδειγμα: "The current resource state does not allow this operation."

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

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

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

Παράδειγμα: {"deleted":false,"id":"example","version":1}

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

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

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

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

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

Γλώσσα που επιλέχθηκε για αυτό το αίτημα.

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

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

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

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

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

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

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

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

Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.

minLength: 1maxLength: 100

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

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

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

Γλώσσα που επιλέχθηκε για αυτό το αίτημα.

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

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

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

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

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

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

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

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

Μεταδεδομένα σελιδοποίησης με cursor.

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

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

Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.

minLength: 1maxLength: 100

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

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

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

Δομημένες πληροφορίες σφάλματος.

Παράδειγμα: {"code":"resource.state_conflict","fields":null,"message":"The current resource state does not allow this operation."}

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

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

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

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

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

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

Περιορισμοί

enum

["required", "invalid_type", "invalid_value", "out_of_range", "unknown_field", "invalid_format", "invalid_cursor", "unsupported_value"]

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

Πεδίο που σχετίζεται με σφάλμα επικύρωσης.

minLength: 1maxLength: 128

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

Πληροφορίες τοποθεσίας.

Περιορισμοί

enum

["path", "query", "header", "body"]

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

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

Δεκαδικό ποσό ως συμβολοσειρά JSON· null μόνο όπου επιτρέπεται. Στείλε τα ποσά ως κείμενο με δεκαδική τελεία, για παράδειγμα "19.99", σύμφωνα με την περιγραφή του πεδίου. Χρησιμοποίησε δεκαδικό τύπο στους υπολογισμούς για να αποφύγεις σφάλματα ακρίβειας.

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

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

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

Περιορισμοί

pattern

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

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

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

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

minimum: 0maximum: 4

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

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

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

Δείχνει αν εφαρμόστηκε η διαγραφή.

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

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

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

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

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

Έκδοση πόρου για έλεγχο ταυτόχρονων εγγραφών. Ορισμένοι αριθμοί έκδοσης μπορεί να υπερβαίνουν το Number.MAX_SAFE_INTEGER στη JavaScript. Διάβασέ τους και στείλε τους χωρίς να αλλάξεις τα ψηφία. Στο JSON πρέπει να παραμένουν αριθμοί, όχι κείμενο.

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

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

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

Μεταδεδομένα σελιδοποίησης με cursor.

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

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

Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.

minLength: 1maxLength: 100

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

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

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

Δείχνει αν υπάρχει επόμενη σελίδα.

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

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

Μέγιστο πλήθος εγγραφών σε αυτή τη σελίδα.

minimum: 1maximum: 100

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

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

Τιμή συνέχισης για την επόμενη σελίδα ή null.

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

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

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

Αναγνωριστικό αιτήματος· στα μεταδεδομένα απόκρισης ταυτοποιεί το αίτημα HTTP.

minLength: 1maxLength: 100

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

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