Λογαριασμός

Η κλήση GET /account επιστρέφει τον πελάτη, το κατάστημα στο οποίο ανήκει το API Token, το υπόλοιπο του λογαριασμού και το κόστος ανά voucher.

WARNING

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

Method	URI	Headers
GET	/api/v2/account	Authorization: Bearer YOUR_TOKEN

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

Καμία.

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

Η εφαρμογή σας επιστρέφει δεδομένα σε μορφή JSON, μέσα στο κλειδί data.

Variable Name	Type	Description
customer.id	Integer	Το ID του πελάτη.
customer.name	String	Η επωνυμία / όνομα του πελάτη.
customer.email	String	Το email του πελάτη.
store.id	Integer	Το ID του καταστήματος στο οποίο ανήκει το API Token.
store.name	String	Το όνομα του καταστήματος.
currency	String	Το νόμισμα των ποσών, πάντα EUR.
balance	String	Το υπόλοιπο του λογαριασμού, με 2 δεκαδικά.
available_balance	String	Το υπόλοιπο μείον τα ποσά που έχουν δεσμευτεί για ενέργειες σε εξέλιξη, με 2 δεκαδικά.
voucher_cost	String	Το κόστος του επόμενου voucher, με 2 δεκαδικά. Δείτε παρακάτω.

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

{
    "data": {
        "customer": {
            "id": 1,
            "name": "Γιώργος Παπαδόπουλος",
            "email": "giorgos@example.gr"
        },
        "store": {
            "id": 1,
            "name": "Το Κατάστημά μου"
        },
        "currency": "EUR",
        "balance": "42.50",
        "available_balance": "42.50",
        "voucher_cost": "0.00"
    }
}

Παράδειγμα σφάλματος.

{
    "message": "Invalid API token",
    "code": "unauthenticated"
}

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

curl https://courierhub.gr/api/v2/account \
  -H "Authorization: Bearer chub_YOUR_API_TOKEN" \
  -H "Accept: application/json"

Πώς υπολογίζεται το voucher_cost

Είναι το κόστος του επόμενου voucher στην τρέχουσα περίοδο χρέωσης (με βάση την ημέρα χρέωσης του λογαριασμού). Η μηνιαία συνδρομή χρεώνεται αυτόματα από το σύστημα στην αρχή της περιόδου και δεν προστίθεται σε κανένα voucher. Τα vouchers μέσα στο όριο του πρώτου κλιμακίου κοστίζουν 0.00. Μετά από αυτό το όριο χρεώνονται με την τιμή του δεύτερου κλιμακίου και, μετά το όριο του δεύτερου, με την τιμή του τρίτου. Τα ακυρωμένα vouchers μετρούν κι αυτά στο όριο.

Σημείωση

Το πρώτο αίτημα σε έναν λογαριασμό που δεν έχει ακόμα εγγραφή υπολοίπου ή τιμολόγησης δημιουργεί αυτές τις εγγραφές με προεπιλεγμένες τιμές.