Ετικέτα αποστολής (PDF)

Η κλήση GET /shipments/{voucher}/label επιστρέφει την ετικέτα (voucher) της αποστολής σε PDF, για εκτύπωση.

WARNING

Θα πρέπει να συμπεριλάβετε το API Token σας σε κάθε αίτημα ως Bearer Token. Αντικαταστήστε το YOUR_TOKEN με το API Token του καταστήματος (chub_...). Δείτε το Overview.

Method	URI	Headers
GET	/api/v2/shipments/{voucher}/label	Authorization: Bearer YOUR_TOKEN

Μεταβλητές αποστολής

Variable Name	Type	Usage	Required
voucher	String	Ο αριθμός voucher, μέσα στο path του URL (π.χ. 7012345679).	*

Απάντηση αιτήματος

Με επιτυχία η απάντηση είναι 200 OK με το αρχείο PDF (όχι JSON):

Header	Τιμή
Content-Type	application/pdf
Content-Disposition	attachment; filename=label-<voucher>.pdf. Στο όνομα αρχείου, οι χαρακτήρες εκτός από A-Z, a-z, 0-9, _ και - γίνονται _.

Μορφή σελίδας. Η ετικέτα βγαίνει στη μορφή της ρύθμισης Τύπος Εκτύπωσης του λογαριασμού σας (περιβάλλον πελάτη: Ρυθμίσεις > Ρυθμίσεις Εκτύπωσης), A4 ή A6. Αν δεν έχετε ορίσει τύπο, A4. Δεν υπάρχει παράμετρος για αλλαγή της μορφής ανά κλήση.

Από πού έρχεται. Η ετικέτα κατεβαίνει από την courier σε κάθε κλήση. Για τις courier που κρατούν αντίγραφο της ετικέτας (Speedex, Γενική Ταχυδρομική, Courier Center) επιστρέφεται το αποθηκευμένο αντίγραφο όσο είναι σε ισχύ.

Παράδειγμα επιτυχημένης κλήσης.

HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename=label-7012345679.pdf

%PDF-1.4 ...

Σφάλματα

Τα σφάλματα επιστρέφονται σε JSON, με τη μορφή σφαλμάτων του v2.

code	HTTP	Πότε
not_found	404	Ο αριθμός voucher δεν υπάρχει, ανήκει σε άλλο λογαριασμό ή έχει ακυρωθεί.
courier_not_supported	422	Η courier δεν υποστηρίζεται από το CourierHub για vouchers.
courier_error	502	Η courier απέτυχε κατά τη λήψη της ετικέτας. Το message περιγράφει το σφάλμα (το μήνυμα της courier ή δική μας περιγραφή) και είναι για ανθρώπους: στηριχτείτε στο code.
label_unavailable	502	Η courier δεν επέστρεψε αρχείο ετικέτας. Ξαναδοκιμάστε αργότερα.

Η courier δεν επέστρεψε ετικέτα (502 Bad Gateway).

{
    "message": "The courier returned no label for this voucher.",
    "code": "label_unavailable"
}

Παράδειγμα κλήσης

Το -o αποθηκεύει το PDF σε αρχείο. Με --fail το curl δεν γράφει το JSON ενός σφάλματος στο αρχείο .pdf:

curl --fail https://courierhub.gr/api/v2/shipments/7012345679/label \
  -H "Authorization: Bearer chub_YOUR_API_TOKEN" \
  -o label-7012345679.pdf