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 tag definition)
subtagStringCurrent subtag of tracking. (See subtag definition)
subtag_messageStringNormalized tracking message. (See subtag message 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
locationStringLocation info provided by carrier (if any)
cityStringCity info provided by carrier (if any)
stateStringState info provided by carrier (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
tagStringCurrent status of checkpoint. Values include 
  • Pending
  • InfoReceived
  • InTransit
  • OutForDelivery
  • AttemptFail
  • Delivered
  • Exception
  • Expired
(See tag definition)
subtagStringCurrent subtag of checkpoint. (See subtag definition)
subtag_messageStringNormalized checkpoint message. (See subtag message definition)
zipStringLocation info (if any)

Body

{
    "meta": {
        "code": 200
    },
    "data": {
        "id": "5b74f4958776db0e00b6f5ed",
        "tracking_number": "111111111111",
        "slug": "fedex",
        "tag": "Delivered",
        "subtag": "Delivered_001",
        "subtag_message": "Delivered",
        "checkpoint": {
            "slug": "fedex",
            "created_at": "2018-08-16T03:50:47+00:00",
            "checkpoint_time": "2018-08-01T13:19:47-04:00",
            "city": "Deal",
            "coordinates": [],
            "country_iso3": null,
            "country_name": null,
            "message": "Delivered - Left at front door. Signature Service not requested.",
            "state": "NJ",
            "tag": "Delivered",
            "subtag": "Delivered_001",
            "subtag_message": "Delivered",
            "zip": null
        }
    }
}