Trackers

Models

Tracker Model

The tracker represents a single tracking number with one or more parcels that are being tracked.

object "tracker"
The description of the model.

coordinates Array<Number, Number>
The latitude and longitude of the current location. This is estimated based on the location which often does not have a street address.

created_at integer
Time in epoch seconds when this resource was created.

estimated_delivery_at integer
The estimated delivery for this tracker in epoch seconds.

fulfillment_id string
The ID of the fulfillment that created this tracker.

id string
Unique identifier for the tracker prefixed with track_.

location_id string
The hub location to which this tracker is assigned.

metadata object
Key value pairs of data that you can set for this tracker.

organization_id string
Unique identifier for the organization that owns this tracker. This will always be your organization ID.

type "outbound" | "inbound"
Indicates whether the tracker is an inbound or outbound tracker.

pickup_at integer
The time in epoch seconds when this tracker will be picked up, if known.

provider object
Details about the shipping carrier.

Show Details


provider.id `string` Unique ID for the provider.
provider.logo_url `string` Logo of the provider.
provider.marketplace `boolean` If this shipping provider came from the PackageX marketplace.
provider.name `string` Name of the provider.
provider.support_email `string` Email to contact support for this provider, available for on demand couriers.
provider.support_phone `string` Phone to contact support for this provider, available for on demand couriers.
provider.support_url `string` URL to contact support for this provider, available for on demand couriers.
provider.support_reference `string` A support reference code that some providers use to help customers.

recipient object
Details about the contact receiving this tracker.

Show Details


recipient.address `Address` The parsed address for this recipient
recipient.name `string` Name of the recipient, printed on the shipping label

sender object
Details about the contact sending this tracker.

Show Details


sender.address `Address` Parsed address for the sender.
sender.name `string` Name of the sender, printed on the shipping label

status string
Current status for this tracker. See Statuses.

tracking_number string
Provider-specific string used to track the shipment.

tracking_updates array<TrackingUpdate>
A list of waypoints this tracker had in order from oldest to newest.

Show Details


TrackingUpdate.address `Address` The address of the package at this waypoint. Address details are often limited to use the city and state when in transit.
TrackingUpdate.comment `string` A comment left by the provider about this update
TrackingUpdate.created_at `integer` Time in epoch seconds when this update occurred
TrackingUpdate.event `string` The latest event that occurred at this waypoint. See Shipment Events
TrackingUpdate.hash `string` A unique hash for this update to make it easier to identify duplicates in webhooks.
TrackingUpdate.images `Array<string>` An array of URLs to images about this update. Commonly used by on demand couriers for picture proof of delivery
TrackingUpdate.layout_id `string` The ID of the layout that this item is on, if it matches one of your locations.
TrackingUpdate.layout `object` The layout object of the location of this update, if it is one of your locations.
TrackingUpdate.location_id `string` The ID of the location of this update, if it is one of your locations.
TrackingUpdate.message `string` User-friendly message generated by PackageX to let a customer know about their shipment status
TrackingUpdate.status `string` The status code for this update See Statuses
TrackingUpdate.updated_at `integer` The time in epoch seconds when this status was last updated

tracking_url string
URL where a user can go to track their packages.

updated_at integer
Time in epoch seconds when this tracker was last updated.

_search object
A special property that will be included if searching through deliveries. This is a flat object which will include <mark> tags around characters that have matched the search. You can use this to more easily highlight text for a user interface.

Show Details

| | | :-------------------------------------------------------------------------------------------------------------------------------------------------- | --- | | _search.id string
The ID of the tracker. | | _search.tracking_number string
The tracking number. | | _search.sender_name string
The sender's name. It will also match common nicknames. | | | _search.sender_formatted_address string
The sender's full address string. | | _search.recipient_name string
The recipient's name. It will also match common nicknames. | | | _search.recipient_formatted_address string
The recipient's full address string. | | _search.relevance_score ?number
A number from 0 - 1 about how relevant the result was to the search query, with 1 being a perfect match. |

Models

# Tracker Model

Tracker Model