GET
/
v1
/
packages
/
{id}
curl --request GET \
  --url https://supportviewapi.parcelshield.com/v1/packages/{id} \
  --header 'Authorization: Bearer <token>'
{
  "orderNumber": "PS1234567",
  "trackingNumber": "1Z000AA000000000000",
  "status": "Delivered",
  "carrierDesc": "UPS",
  "carrierServiceDesc": "UPS NEXT DAY AIR SAVER",
  "carrierDeliveryLocation": "Front Door",
  "weight": 2.7,
  "tier": 1,
  "refrigerated": false,
  "signatureRequired": false,
  "reIced": false,
  "manifestDate": "2022-03-24T11:48:03",
  "scheduledDeliveryDate": "2022-03-25T23:00:00",
  "originalScheduledDeliveryDate": "2022-03-25T23:00:00",
  "deliveryDate": "2022-03-25T13:11:50",
  "recipientAddress": {
    "line1": "123 N TEST ST",
    "line2": null,
    "city": "SURPRISE",
    "state": "AZ",
    "zip": "865374"
  },
  "events": [
    {
      "code": "PU",
      "discriminator": "OR",
      "description": "PICKUP SCAN",
      "city": "Lakeland",
      "state": "FL",
      "eventDateTime": "2022-03-24T11:03:06",
      "timeZone": "Eastern Standard Time"
    }
  ]
}

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
Success
​
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