GET
/
v1
/
packages
/
{id}

Authorizations

​
Authorization
string
header
required

Scopes are derived implicitly based on the provided client_id and audience (defaulted) values.

Path Parameters

​
id
string
required

The package order or tracking number

Response

200 - application/json
​
carrierDeliveryLocation
string | null

Package delivery location, if available

​
carrierDesc
enum<string>
Available options:
UPS,
FedEx,
USPS
​
carrierServiceDesc
string | null

Carrier service name

​
deliveryDate
string | null

Record delivery datetime, if available

​
events
object[] | null

Package scan events

​
manifestDate
string | null

Datetime the package is provided to the Carrier

​
orderNumber
string | null

Client-provided order number

​
originalScheduledDeliveryDate
string | null

Original scheduled delivery datetime

​
recipientAddress
object
​
refrigerated
boolean
​
reIced
boolean
​
scheduledDeliveryDate
string | null

Latest scheduled delivery datetime. Variance from original scheduled date suggests a delay.

​
signatureRequired
boolean
​
status
string | null

Current package status

​
tier
integer

ParcelShield protection tier

Required range: 0 < x < 2
​
trackingNumber
string | null

Carrier tracking number

​
weight
number

Package weight in lbs

Required range: 0 < x < 1000
Plan Shipment