GET
/
v1
/
packages
/
{id}

Authorizations

Authorization
string
headerrequired

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
orderNumber
string | null

Client-provided order number

trackingNumber
string | null

Carrier tracking number

status
string | null

Current package status

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

Carrier service name

carrierDeliveryLocation
string | null

Package delivery location, if available

weight
number

Package weight in lbs

Required range: 0 < x < 1000
tier
integer

ParcelShield protection tier

Required range: 0 < x < 2
refrigerated
boolean
signatureRequired
boolean
reIced
boolean
manifestDate
string | null

Datetime the package is provided to the Carrier

scheduledDeliveryDate
string | null

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

originalScheduledDeliveryDate
string | null

Original scheduled delivery datetime

deliveryDate
string | null

Record delivery datetime, if available

recipientAddress
object
events
object[] | null

Package scan events

Plan Shipment