Skip to main content

Authorizations

AccessKey
string
header
required

Send the access token returned by Login. Both access and refresh tokens are accepted; reserve refresh for credential renewal.

Body

application/json
AssetName
string
required

Name of the asset.

AccountID
string
required

Unique identifier of the account.

CarrierID
string | null

Unique identifier of the carrier. Use a valid carrier identifier if you supply this field.

TrackingNo
string | null

Carrier tracking number.

LabelID
string | null

Label identifier. Optional on creation and can be omitted. Send it as a string in requests. Responses return LabelID as a number.

GroupID
string | null

Unique identifier of the group.

DestinationAddress
string | null

Destination address.

DestinationLat
number | null

Destination latitude.

DestinationLng
number | null

Destination longitude.

Description
string | null

Free-text description.

AssetForeignID
string | null

Identifier supplied by your system. Not included in the list response.

Response

Successful response.

Response body for successful asset changes.

Code
integer

Application code in the response body. Separate from the HTTP status.

Message
string

Result message.