Trackings

Create trackings, update trackings, and get tracking results.

Pro Tip!

You can always use/:id to replace /:slug/:tracking_number.
e.g. DELETE /trackings/:id


POST /trackings/:slug/:tracking_number/retrack

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
trackingHash of Tracking ObjectHash describes the tracking status, with minimal attributes.
Tracking Object
AttributeTypeDescription
idStringA unique identifier generated by AfterShip for the tracking.
tracking_numberStringTracking number.
tracking_postal_codeStringThe postal code of receiver's address. Required by some couriers, such asdeutsch-post
tracking_ship_dateStringShipping date inYYYYMMDDformat. Required by some couriers, such asdeutsch-post
tracking_account_numberStringAccount number of the shipper for a specific courier. Required by some couriers, such asdynamic-logistics
tracking_keyStringKey of the shipment for a specific courier. Required by some couriers, such assic-teliway
tracking_origin_countryStringOrigin Country of the shipment for a specific courier. Required by some couriers, such asdhl
tracking_destination_countryStringDestination Country of the shipment for a specific courier. Required by some couriers, such aspostnl-3s
tracking_stateStringLocated state of the shipment for a specific courier. Required by some couriers, such asstar-track-courier
slugStringUnique code of courier. Get courier slug here
activebooleanWhether or not AfterShip will continue tracking the shipments. Value is false when tag (status) is DeliveredExpired, or further updates for 30 days since last update.

Body

{
    "meta": {
        "code": 200
    },
    "data": {
        "tracking": {
            "active": true,
            "id": "52e0dfd21246ff7488066941",
            "slug": "russian-post",
            "tracking_number": "RA223547577RU"
        }
    }
}

Coming soon