Skip to main content
Get a shared asset

Query Parameters

AssetShareID
string
required

Identifier granting access to a shared asset. Keep it private except when sharing with intended recipients.

Response

Shared asset object, or an empty object for an unknown or deleted sharing identifier.

Shared asset data. An unknown or deleted sharing identifier returns an empty object. AssetID is not returned; Exceptions is an array of labels.

LabelID
integer | null

Label identifier; may be null.

AssetName
string

Name of the asset.

lat
number | null

Current latitude.

lng
number | null

Current longitude.

TrackingNo
string | null

Carrier tracking number.

Address
string | null

Current address.

DestinationAddress
string | null

Destination address.

Description
string | null

Asset description.

CarrierName
string | null

Carrier name; may be null.

CreatedOn
string

Asset creation timestamp.

LastContact
string | null

Last contact timestamp; may be null.

StatusNo
integer

Asset status value.

ActivatedOn
string | null

Asset activation timestamp; may be null.

ExpirationDate
string | null

Asset expiration timestamp, not sharing-link expiration.

Status
string | null

Asset status name.

Exceptions
string[]

Exception labels; an empty array when none are set.

Locations
object[]

Location history, newest first. All entries are returned in one response.