Last Checkpoint

Get tracking information of the last checkpoint of a tracking.

Pro Tip!

You can always use/:tracking_id to replace /:slug/:tracking_number.
e.g. DELETE /last_checkpoint/:tracking_id


GET /last_checkpoint/:slug/:tracking_number

Header

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

Parameters

Optional Parameters
ParameterTypeDescription
fieldsStringList of fields to include in the response. Use comma for multiple values. Fields to include:slug,created_at,checkpoint_time,city,coordinates,country_iso3,
country_name,message,state,tag,zip
Default: none, Example: city,tag
langStringSupport Chinese to English translation for china-ems  and  china-post  only
(Example: en)

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
tracking_numberStringTracking number.
slugStringUnique code of courier.
tagStringCurrent status of tracking. Values include 
  • Pending
  • InfoReceived
  • InTransit
  • OutForDelivery
  • AttemptFail
  • Delivered
  • Exception
  • Expired
(See status definition)
checkpointHash, Checkpoint ObjectHash describes the checkpoint information.
Checkpoint Object
AttributeTypeDescription
created_atDateTimeDate and time of the tracking created.
slugStringThe unique code of courier for this checkpoint message. Get courier slug here
checkpoint_timeStringDate and time of the checkpoint, provided by courier. Value may be:
Empty String,
YYYY-MM-DD,
YYYY-MM-DDTHH:MM:SS, or
YYYY-MM-DDTHH:MM:SS+TIMEZONE
cityStringLocation info (if any)
coordinatesArrayDeprecated as of March 2013
country_iso3StringCountry ISO Alpha-3 (three letters) of the checkpoint
country_nameStringCountry name of the checkpoint, may also contain other location info.
messageStringCheckpoint message
stateStringLocation info (if any)
tagStringCurrent status of checkpoint. Values include 
  • Pending
  • InfoReceived
  • InTransit
  • OutForDelivery
  • AttemptFail
  • Delivered
  • Exception
  • Expired
(See status definition)
zipStringLocation info (if any)

Body

{
    "meta": {
        "code": 200
    },
    "data": {
        "id": "53aa788e415a67000000001d",
        "tracking_number": "1Z867F6RP220667561",
        "slug": "ups",
        "tag": "Delivered",
        "checkpoint": {
            "slug": "ups",
            "created_at": "2014-06-25T07:22:00+00:00",
            "checkpoint_time": "2014-06-19T09:48:00",
            "city": "POMPANO BEACH",
            "coordinates": [],
            "country_iso3": null,
            "country_name": "US",
            "message": "DELIVERED",
            "state": "FL",
            "tag": "Delivered",
            "zip": "33069"
        }
    }
}