Εμφάνιση
Ακύρωση αποστολής
Η κλήση DELETE /shipments/{voucher} ακυρώνει το voucher στην courier και διαγράφει την αποστολή από το CourierHub, όπως η διαγραφή voucher από το περιβάλλον πελάτη.
Πραγματική ακύρωση, χωρίς επιστροφή χρέωσης
Δεν υπάρχει sandbox: η ακύρωση γίνεται στην πραγματική courier. Υποστηρίζεται μόνο για ACS, BoxNow και ELTA και δεν επιστρέφει τη χρέωση του voucher στο υπόλοιπο.
WARNING
Θα πρέπει να συμπεριλάβετε το API Token σας σε κάθε αίτημα ως Bearer Token. Αντικαταστήστε το YOUR_TOKEN με το API Token του καταστήματος (chub_...). Δείτε το Overview.
| Method | URI | Headers |
|---|---|---|
| DELETE | /api/v2/shipments/{voucher} | Authorization: Bearer YOUR_TOKEN |
Μεταβλητές αποστολής
| Variable Name | Type | Usage | Required |
|---|---|---|---|
voucher | String | Ο αριθμός voucher, μέσα στο path του URL (π.χ. 7012345679). | * |
Τι γίνεται μετά την ακύρωση
- Η αποστολή δεν υπάρχει πια για το API: το GET /shipments/{voucher} και μια νέα ακύρωση απαντούν
404, και δεν εμφανίζεται στη λίστα αποστολών (δεν εμφανίζεται ωςcancelled, διαγράφεται). - Στέλνεται webhook
shipment.deleted. - Αν η παραγγελία ήταν
shipped, επιστρέφει σεprocessingκαι τοcourierτης γίνεταιnull(καθαρίζεται και ο αριθμός αποστολής της παραγγελίας). Σε άλλη κατάσταση η παραγγελία δεν αλλάζει. - Η χρέωση του voucher δεν επιστρέφεται. Η κίνηση παραμένει στις κινήσεις υπολοίπου με το ίδιο
voucher_number. - Μπορείτε να εκδώσετε νέο voucher για την ίδια παραγγελία και courier με POST /shipments (
201, με νέα χρέωση).
Απάντηση αιτήματος
Με επιτυχία η απάντηση είναι 204 No Content, χωρίς σώμα.
Παράδειγμα επιτυχημένης ακύρωσης.
HTTP/1.1 204 No ContentΣφάλματα
code | HTTP | Πότε |
|---|---|---|
not_found | 404 | Ο αριθμός voucher δεν υπάρχει, ανήκει σε άλλο λογαριασμό ή έχει ήδη ακυρωθεί. |
courier_cancellation_unsupported | 422 | Η courier δεν υποστηρίζει ακύρωση μέσω API (όλες εκτός από ACS, BoxNow και ELTA). Το voucher δεν αλλάζει. Ακυρώστε το απευθείας στην courier. |
courier_not_supported | 422 | Η courier δεν υποστηρίζεται από το CourierHub για vouchers. |
courier_error | 502 | Η courier (ACS, BoxNow, ELTA) απέτυχε ή αρνήθηκε την ακύρωση. Το message περιγράφει το σφάλμα (το μήνυμα της courier ή δική μας περιγραφή) και είναι για ανθρώπους: στηριχτείτε στο code. Το voucher δεν διαγράφεται. |
Courier χωρίς ακύρωση μέσω API (422).
json
{
"message": "Delete voucher not implemented for Kronos Express",
"code": "courier_cancellation_unsupported"
}Άγνωστο ή ήδη ακυρωμένο voucher (404).
json
{
"message": "Resource not found.",
"code": "not_found"
}Παράδειγμα κλήσης
bash
curl -X DELETE https://courierhub.gr/api/v2/shipments/7012345679 \
-H "Authorization: Bearer chub_YOUR_API_TOKEN" \
-H "Accept: application/json"