Couriers

Get a list of our supported couriers.


GET /couriers

Headers

aftership-api-key: YOUR_API_KEY
Content-Type: application/json

Headers

HTTP/1.1 200 OK
Content-Type: application/json
Connection: keep-alive
Date: Mon, 10 Jun 2013 07:38:02 GMT

Attributes

Attributes
AttributeTypeDescription
totalNumberTotal number of couriers supported by AfterShip.
couriersArray of Courier ObjectArray of Hash describes the couriers information.
Courier Object
AttributeTypeDescription
slugStringUnique code of courier
nameStringName of courier
phoneStringContact phone number of courier
other_nameStringOther name of courier
web_urlStringWebsite link of courier
required_fieldsArrayThe extra fields need for tracking, such as `tracking_account_number`, `tracking_postal_code`, `tracking_ship_date`, `tracking_key`, `tracking_destination_country`
optional_fieldsArraythe extra fields which are optional for tracking. Basically it's the same as required_fields, but the difference is that only some of the tracking numbers require these fields.
default_languageStringDefault language of tracking results
support_languagesArrayOther supported languages
service_from_country_iso3ArrayCountry code (ISO Alpha-3) where the courier provides service

Body

{
    "meta": {
        "code": 200
    },
    "data": {
        "total": 2,
        "couriers": [
            {
                "slug": "dhl",
                "name": "DHL",
                "phone": "+1 800 225 5345",
                "other_name": "DHL Express",
                "web_url": "http://www.dhl.com/",
                "required_fields": [],
                "optional_fields": []
            },
            {
                "slug": "deutsch-post",
                "name": "Deutsche Post Mail",
                "phone": "+49 (0) 180 2 000221",
                "other_name": "dpdhl",
                "web_url": "http://www.deutschepost.de/",
                "required_fields": [
                    "tracking_ship_date"
                ],
                "optional_fields": []
            }
        ]
    }
}