Track Event Object

A tracking event object is used to represent different events that happen throughout a shipments lifetime with a carrier.

NameTypeRequired?Description
event_datetimestring

When this tracking event occurred. Formatted per https://tools.ietf.org/html/rfc3339. Must be in UTC.

event_datetime_localstring

Most providers do not provide tracking events in UTC, and without time zone or geo information its hard to deduce.

event_codestring

Carrier's specific event code.

descriptionstring

Description of the package status at this event.

citystring

City or Locality for this event.

statestring

State or Province for this event.

postal_codestring

Postal Code for this event.

countrystring

Country for this event

companystring
signerstring

If the event had a signer associated, normally on delivery.

geoobject

Coordinates for the event

geo.latnumber

The latitude of the point. Represented as signed degrees. http://www.geomidpoint.com/latlon.html

geo.longnumber

The longitude of the point. Represented as signed degrees http://www.geomidpoint.com/latlon.html

status_codestring

The standardized status code used for shipment tracking information

Valid values include the following:

  • UN - Unknown
  • AC - Accepted
  • IT - InTransit
  • DE - Delivered
  • EX - Exception
  • AT - DeliveryAttempt
  • NY - NotYetInSystem