Trackers

Tracking Update

# Tracking Update Model

id string
Unique identifier for this tracking update, prefixed with upd_.

address Address
The address of the package at this waypoint. Address details are often limited to use the city and state when in transit.

status string
The status code for this update. See Statuses

message string
User-friendly message generated by PackageX to let a customer know about their shipment status.

comment string
A comment left by the provider about this update.

images string[]
An array of URLs to images about this update. Commonly used by on demand couriers for picture proof of delivery.

contact_id string
References the ID of the contact associated with this tracking update. This typically identifies who signed for or accepted the delivery when the event was recorded.

location_id string
References your location ID if this update occurred at one of your registered locations.

layout_id string
The ID of the layout that this item is on, if it matches one of your locations.

layout Layout
The layout object of the location of this update, if it is one of your locations.

created_at integer
Time in epoch seconds when this update occurred.

updated_by string
The ID of the user or key who last updated the tracking update.

provider_id string
The ID of the provider associated with this tracking update.

container_id string
The ID of the container associated with this tracking update.

container_group_id string
The ID of the container group associated with this tracking update. This field helps in organizing and managing shipments that are grouped together for easier tracking and handling.

vehicle_id string
The ID of the vehicle associated with this tracking update.

shipment_id string
The ID of the shipment associated with this tracking update.

checksum string
A hash value computed from the current tracking update configuration that enables verification of data integrity. This value gets updated whenever the update changes.