Εμφάνιση
Διαγραφή παραγγελίας
Η κλήση DELETE /orders/{id} διαγράφει μια παραγγελία που δεν έχει voucher, όπως η ενέργεια Διαγραφή στη λίστα παραγγελιών του CourierHub.
WARNING
Θα πρέπει να συμπεριλάβετε το API Token σας σε κάθε αίτημα ως Bearer Token. Αντικαταστήστε το YOUR_TOKEN με το API Token του καταστήματος (chub_...). Δείτε το Overview.
| Method | URI | Headers |
|---|---|---|
| DELETE | /api/v2/orders/{id} | Authorization: Bearer YOUR_TOKEN |
Μεταβλητές αποστολής
| Variable Name | Type | Usage | Required |
|---|---|---|---|
id | Integer | Το id της παραγγελίας, μέσα στο path του URL. | * |
Τι κάνει η διαγραφή
- Η διαγραφή είναι soft delete: η παραγγελία κρύβεται από το API (
GET /orders/{id}επιστρέφει404, δεν εμφανίζεται στο GET /orders) και από τη λίστα παραγγελιών του CourierHub, αλλά δεν σβήνεται οριστικά από τη βάση. Δεν υπάρχει endpoint επαναφοράς. - Το
order_numberτης ελευθερώνεται: μπορείτε να δημιουργήσετε νέα παραγγελία με τον ίδιο αριθμό στο ίδιο κατάστημα. Η νέα παραγγελία παίρνει νέοidκαι νέοorder_id. - Μπορείτε να διαγράψετε κάθε παραγγελία του λογαριασμού σας (όλων των καταστημάτων), και παραγγελίες που ήρθαν από e-shop. Η διαγραφή δεν στέλνεται στο e-shop.
- Αν η παραγγελία έχει voucher, η απάντηση είναι
409 order_has_shipmentκαι η παραγγελία δεν διαγράφεται. Ισχύει ο ίδιος κανόνας με την ενημέρωση: μετράει κάθε μη διαγραμμένο voucher, και αυτό που εκδίδεται εκείνη τη στιγμή. Πρώτα πρέπει να ακυρωθεί (διαγραφεί) το voucher, με DELETE /shipments/{voucher} ή από το περιβάλλον πελάτη του CourierHub.
Απάντηση αιτήματος
Επιτυχής διαγραφή: HTTP 204 No Content, χωρίς σώμα.
| Variable Name | Type | Description |
|---|---|---|
| - | - | Η απάντηση 204 δεν έχει σώμα. |
Παράδειγμα επιτυχημένης διαγραφής.
HTTP/1.1 204 No ContentΠαραγγελία με voucher (409 Conflict).
json
{
"message": "The order has a shipment (voucher). Cancel or delete the voucher first.",
"code": "order_has_shipment"
}Άγνωστη ή ήδη διαγραμμένη παραγγελία (404).
Μια δεύτερη διαγραφή της ίδιας παραγγελίας επιστρέφει επίσης 404:
json
{
"message": "Resource not found.",
"code": "not_found"
}Παράδειγμα κλήσης
bash
curl -X DELETE https://courierhub.gr/api/v2/orders/3 \
-H "Authorization: Bearer chub_YOUR_API_TOKEN" \
-H "Accept: application/json"