Checkpoint - AfterShip Tracking API

Object describes checkpoint information.

[url](../../docs/enum/events.md)[url](../../docs/enum/additional_tracking_fields.md)[url](../../docs/enum/delivery_sub_statuses.md)[url](../../docs/enum/delivery_statuses.md)[url](../../docs/enum/slug_groups.md)[url](../../model/resource/tracking.json)[url](../../model/resource/checkpoint.json)[url](../../model/resource/courier.json)[url](../../model/resource/notification.json)[url](../../model/enum/additional_fields.v1.json)[url](../../model/enum/slug_group.v1.json)[url](../../model/enum/tag.v1.json)[url](../../reference/api.json/paths/~1trackings/get)[url](../../reference/api.json/paths/~1trackings/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/put)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}/delete)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1retrack/post)[url](../../reference/api.json/paths/~1trackings~1{slug}~1{tracking_number}~1mark-as-completed/post)[url](../../reference/api.json/paths/~1couriers/get)[url](../../reference/api.json/paths/~1couriers~1detect/post)[url](../../reference/api.json/paths/~1couriers~1all/get)[url](../../reference/api.json/paths/~1last_checkpoint~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}/get)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1add/post)[url](../../reference/api.json/paths/~1notifications~1{slug}~1{tracking_number}~1remove/post)

Object describes checkpoint information.Show all...

created_at

string

The date and time of the checkpoint event was added to AfterShip. It uses the format YYYY-MM-DDTHH:mm:ssZ for the timezone GMT +0.

>= 1 characters

Example:

2023-01-18T08:47:10+00:00

slug

string

The unique code of courier for this checkpoint. Get courier slug here

>= 1 characters

Example:

fedex

checkpoint_time

string

The date and time of the checkpoint event, provided by the carrier. It uses the timezone of the checkpoint. The format may differ depending on how the carrier provides it:

YYYY-MM-DDTHH:mm:ss
YYYY-MM-DDTHH:mm:ssZ

>= 1 characters

Example:

2022-01-01T18:47:10-05:00

location

string or null

Location info provided by carrier

>= 1 characters

Example:

13th Street, New York, NY 10011, USA, United States

city

string or null

City info provided by carrier

>= 1 characters

Example:

New York

state

string or null

State info provided by carrier

>= 1 characters

Example:

zip

string or null

Postal code info provided by carrier

>= 1 characters

Example:

10011

coordinate

object or null

The latitude and longitude coordinates indicate the precise location of the shipments that are currently in transit.

Example:

null

latitude

number

read-only

Represents the latitude.

Example:

37.09024

longitude

number

read-only

Represents the longitude.

Example:

-95.712891

country_region

string or null

Country/Region ISO Alpha-3 (three letters) of the checkpoint

Example:

USA

country_region_name

string or null

Country/Region name of the checkpoint, may also contain other location info.

Example:

United States

message

string

Checkpoint message

>= 1 characters

Example:

Package delivered

tag

string

Current status of tracking. (See tag definition)

url url url url url url url url url url url url url url url url url url url url url url url url url

Allowed values:

PendingInfoReceivedInTransitOutForDeliveryAttemptFailDeliveredAvailableForPickupExceptionExpired

Example:

Delivered

subtag

string

Current subtag of checkpoint. (See subtag definition)

>= 1 characters

Example:

Delivered_002

subtag_message

string

Normalized checkpoint message. (See subtag message definition)

>= 1 characters

Example:

Picked up by customer

raw_tag

string or null

Checkpoint raw status provided by courier

>= 1 characters

Example:

events

array[object]

The array provides details about specific event(s) that occurred to a shipment, such as "returned_to_sender". You can find the full list of events and reasons here (Beta Feature)

The events' value for the same checkpoint message is subject to change as we consistently strive to enhance the performance of this feature.

code

string

Represents the event code.

Example:

delivered_to_neighbor

reason

object or null

Describes the specific reason that led to the event.

source

The source of the checkpoint, which can either be from the carrier or when the user marks the tracking as completed.

Allowed values:

carrieruser

Example:

carrier