Parcel

Operations about parcels

Parcel

The Parcel endpoint returns information regarding a given parcel. This broadly includes shipper and consignee address, delivery information, ETA timestamps and much more.

SecuritybasicAuth
Request
path Parameters
parcelIdentifier
required
string

Parcel number or tracking id

Example: 10362781851
Responses
200

Parcel response

401

Authorization information is missing or invalid

429

Rate limit exceeded

default

Error message

get/external/parcel/{parcelIdentifier}
Request samples
Response samples
application/json
{
  • "trackingId": "YUTKBBTN",
  • "parcelNumber": "10362781851",
  • "status": {
    },
  • "shipperId": "bmw",
  • "jobType": "DELIVERY",
  • "supportedCustomizedDeliveryTypes": [
    ],
  • "customizedDelivery": {
    },
  • "fromAddress": {
    },
  • "toAddress": {
    }
}

Tracking Availability

Checks if parcel is in delivery and real time tracking is available

SecuritybasicAuth
Request
path Parameters
parcelIdentifier
required
string

Parcel number or tracking id

Example: 10362781851
Responses
200

Parcel is in delivery and available for real time tracking

401

Authorization information is missing or invalid

404

Parcel not found or not available for real time tracking

429

Rate limit exceeded

default

Error message

get/external/parcel/{parcelIdentifier}/availability
Request samples
Response samples
application/json
{
  • "timestamp": "2022-01-15T14:33:25Z",
  • "path": "/v1/external/parcel",
  • "status": 401,
  • "error": "Unauthorized",
  • "message": "Authorization required",
  • "requestId": "331f2ea7-197"
}