Track a Package

HTTP Request

GET /v1/tracking/{identifier}?packageIdentifierType=TrackingNumber

Summary

Shipment labels that are printed using the Pitney Bowes Ecommerce APIs are automatically tracked. This operation retrieves package status for a Production label.

Considerations

  1. Production Labels Only: For all carriers and services, the Tracking API works only with Production labels. To test tracking in the Sandbox environment, use a Production label. Do not use a label created in the Sandbox environment.

  2. Current Package Status: The current package status is found in three places in the response object:

    • The status field.

    • The currentStatus.packageStatus field.

    • The scanDetailsList.packageStatus field for the most recent event in the scanDetailsList array.

  3. PB Expedited (USPS): USPS performs daily scheduled maintenance on tracking services, generally between midnight and 3 AM ET. During this time shippers might experience intermittent timeout errors if requesting USPS tracking status. We recommend that shippers not schedule jobs to obtain USPS tracking during this time period.

  4. IMb labels: USPS does not guarantee reporting of tracking events for First-Class Mail letters and flats that use IMb labels.

  5. PB Standard: Set the carrier query parameter to PBCS to ensure the API returns events for both PB Standard and first-mile carriers.

  6. PB Presort: The following considerations apply to PB Presort:

    • The API tracks the PB Presort parcel only while the parcel is in the USPS mailstream.

    • Tracking events show up only after PB Presort uploads the Shipping Services File to USPS. Tracking information can take a while to appear.

    • If the PB Presort label used an IMb, enter only the first 20 digits of the tracking number in the trackingNumber path parameter.

  7. CBDS: In addition to international tracking events, the Tracking API will also return domestic tracking events if the first-mile shipping is through Pitney Bowes, USPS, PB Standard, FedEx, or UPS.

  8. UPS: UPS labels must be printed through the PB Ecommerce APIs to be tracked using this API call.

  9. Pitney Bowes Tracking Page: In addition to this API, Pitney Bowes provides the following tracking site:

    https://trackpb.shipment.co/track/

    To provide a buyer a direct link to a parcel’s tracking information, append the tracking number to the above URL:

    https://trackpb.shipment.co/track/<trackingNumber>

Request URLs

Important: The Tracking API works only with Production labels. To test tracking in Sandbox, use a Production label.

Sandbox: https://shipping-api-sandbox.pitneybowes.com/shippingservices/v1/tracking/{identifier}?packageIdentifierType=TrackingNumber
Production: https://shipping-api.pitneybowes.com/shippingservices/v1/tracking/{identifier}?packageIdentifierType=TrackingNumber

Path Parameter

Name

Description

identifier

Required. The identifier for the shipment. Currently, the Tracking API requires that the identifier be the shipment’s tracking number.

For PB Presort mailpieces that use IMb labels, enter only the first 20 digits of the tracking number.

Query Parameters

Name

Description

packageIdentifierType

Required. Indicates the type of identifier used to reference the shipment. Currently, the Tracking API requires that shipments be identified by their tracking numbers. The valid value for this parameter is:

  • TrackingNumber

carrier

PB Standard Only. Required. For PB Standard, set the carrier query parameter to PBCS to ensure the API returns events for both PB Standard and USPS.

Request Header

Name


Description

Authorization

Required. OAuth token generated using the Generate an OAuth Token API.

Response Elements

Name

Data Type

Description

packageCount

Integer

The number of packages tracked.

reattemptDate

String

If the package was not delivered the first time, this field indicates the date at the destination that the delivery was re-attempted, specified in the YYYY-MM-DD format.

reattemptTime

String

If the package was not delivered the first time, this field indicates the local time at the destination that delivery was re-attempted, specified in the HH:MM:SS format.

signedBy

String

Name of the person who signed for the package.

senderAddress

Address Object

This object is not used and returns null values.

requestedIdentifier

String

The type of identifier passed in the path parameter.

clientId

String

trackingNumber

String

The tracking number for the shipment.

referenceNumber

String

The value passed by the carrier as referenceNumber.

smartLabelBarcode

String

The value for the SmartLabel® barcode for PB Standard Services.

carrier

String

The carrier or label type. Possible values:

serviceName

String

The carrier’s name for the mail class.

serviceCode

String

The carrier’s code for the mail class.

estimatedDeliveryDate

String

The estimated date at the destination that the package will be delivered, specified in the YYYY-MM-DD format.

estimatedDeliveryTime

String

The estimated local time at the destination that the package will be delivered, specified in the HH:MM:SS format.

estimatedDeliveryTimeOffset

String

The UTC offset between the local time of the estimated delivery and the time in UTC/GMT. The offset is specified in the ±hh:mm format.

weight

Number

Weight of the package delivered.

weightUOM

String

Unit of measure for the package’s weight. Possible values:

  • lb: pounds

  • LBS: pounds

  • Pounds: pounds

  • KGS: kilograms

dimension

Dimension Object

The package dimensions.

deliveryDate

String

The date at the destination when the package was delivered, specified in the YYYY-MM-DD format.

deliveryTime

String

The local time at the destination when the package was delivered, specified in the HH:MM:SS format.

deliveryTimeOffset

String

The UTC offset between the local time of the delivery and the time in UTC/GMT. The offset is specified in the ±hh:mm format.

deliveryProofUrl

String

The URL to access either a picture of the delivered package or a picture of the signature confirmation.

shipDate

String

The date at the origin when the package was shipped, specified in the YYYY-MM-DD format.

shipTime

String

The time at the origin when the package was shipped, specified in the hh:mm:ss format.

shipTimeOffset

String

The UTC offset between the local time for the ship time and the time in UTC/GMT. The offset is specified in the ±hh:mm format.

destinationAddress

Address Object

The location where the package is to be delivered. This field might return null values.

deliveryLocation

String

The location where the package was delivered.

deliveryLocationDescription

String

Description of where the package was delivered.

scanDetailsList

Array[Event Object]

This array contains an object for each tracking event, as obtained from the barcode on the shipping label.

Note: The most recent event in this array will match the event listed in the currentStatus object.

currentStatus

Array[Event Object]

The most recent tracking event, as obtained from the barcode on the shipping label.

Note: The currentStatus object will match the most recent event in the scanDetailsList array.

status

String

The most recent package status, as obtained from the barcode on the shipping label. Note that this status also appears in the currentStatus.packageStatus field and in the scanDetailsList.packageStatus field for the most recent event in the scanDetailsList array.

The possible values for this field are the following. Some might not apply to your carrier:

  • Acceptance

  • Delivered

  • DeliveryAttempt

  • Exception

  • InTransit

  • Manifest

  • OutForDelivery

  • PickedUp

  • PickupMissed

  • ReadyForPickup

  • ReturnToSender

updatedDate

String

The local date when the tracking status was posted, specified in the YYYY-MM-DD format.

updatedTime

String

The local time when the tracking status was posted, specified in the HH:MM:SS format.

lastPackageStatusLocation

String

The last location of the tracked package.

Address Object (Tracking API)

The senderAddress and destinationAddress fields return the address object.

Name

Data Type

Description

name

String

First and last name.

address1
address2
address3

Strings

Street address or P.O. Box.

city

String

City or town.

stateOrProvince

String

State or province.

country

String

Two-character country code from the ISO country list.

postalCode

String

Postal or ZIP code.

Event Object (Tracking API)

The scanDetailsList and currentStatus fields return the event object.

Name

Data Type

Description

standardizedEventCode

String

PB Standard Only. The event code found in the StandardizedEventCode column of the Status Mapping for Event Codes table on the PB Standard Tracking Codes page.

l1Code

String

The event code provided by the carrier. See the carrier’s documentation. For Pitney Bowes or USPS, see the following:

l1Description

String

The event description provided by the carrier. See the carrier’s documentation. For Pitney Bowes or USPS, see the following:

l2Description

String

An additional event description provided by the carrier, if applicable. See the carrier’s documentation.

eventDate

String

The date posted by the carrier for the event. Format: YYYY-MM-DD

eventTime

String

The time posted by the carrier for the event. Format: HH:MM:SS

eventTimeOffset

String

The UTC offset between the local time of the event and the time in UTC/GMT. The offset is specified in the ±hh:mm format.

trackingUrl

String

CBDS Only. For CBDS, this field displays the final-mile carrier’s URL for tracking the package.

latitude

String

longitude

String

locationUnit

String

eventLeg

String

eventType

String

scanType

String

An event code provided by the carrier. This might match the code returned in the l1Code field. For codes, see the carrier’s documentation.

scanDescription

String

An event description provided by the carrier. This might match the description returned in the l1Description field. For descriptions, see the carrier’s documentation.

packageStatus

String

The package status, as obtained from the barcode on the shipping label. Note that for the currentStatus object and for the most recent event in the scanDetailsList array, this will be the same status as appears in the response’s status field.

The possible values for this field are the following. Some might not apply to your carrier:

  • Acceptance

  • Delivered

  • DeliveryAttempt

  • Exception

  • InTransit

  • Manifest

  • OutForDelivery

  • PickedUp

  • PickupMissed

  • ReadyForPickup

  • ReturnToSender

eventCity

String

The city where the event occurred.

eventStateOrProvince

String

The state or province where the event occurred.

postalCode

String

The postal code where the event occurred.

country

String

The country where the event occurred.

Sample Requests

See the following sample tracking requests:

PB Expedited Delivery (USPS) Sample Tracking Request

USPS Sample Tracking Request
curl -X GET .../v1/tracking/9405509898641500000146?packageIdentifierType=TrackingNumber \
-H "Authorization: Bearer <oauth_token>"
USPS Sample Tracking Response
{
    "packageCount": 1,
    "reattemptDate": null,
    "reattemptTime": null,
    "signedBy": null,
    "senderAddress": {
        "name": null,
        "address1": null,
        "address2": null,
        "address3": null,
        "city": null,
        "stateOrProvince": null,
        "postalCode": null,
        "country": null
    },
    "requestedIdentifier": "9405509898641500000146",
    "clientId": null,
    "trackingNumber": "9405509898641500000146",
    "referenceNumber": null,
    "smartLabelBarcode": null,
    "carrier": "USPS",
    "serviceName": "Media Mail",
    "serviceCode": "490",
    "estimatedDeliveryDate": null,
    "estimatedDeliveryTime": null,
    "estimatedDeliveryTimeOffset": null,
    "weight": "0.0",
    "weightUOM": "LBS",
    "dimension": {
        "length": null,
        "width": null,
        "height": null,
        "unitOfMeasurement": null
    },
    "deliveryDate": "2021-10-22",
    "deliveryTime": "16:23:00",
    "deliveryTimeOffset": "+00:00",
    "deliveryProofUrl": null,
    "shipDate": "2021-10-08",
    "shipTime": "16:06:24",
    "shipTimeOffset": "+00:00",
    "destinationAddress": {
        "name": null,
        "address1": null,
        "address2": null,
        "address3": null,
        "city": "SALINA",
        "stateOrProvince": "KS",
        "country": null,
        "postalCode": "67401"
    },
    "deliveryLocation": "SALINA,KS,67401",
    "deliveryLocationDescription": "DELIVERED, IN/AT MAILBOX",
    "scanDetailsList": [ {
        "l1Code": "01",
        "l1Description": "Delivered",
        "l2Description": "Delivered",
        "eventDate": "2021-10-22",
        "eventTime": "16:23:00",
        "eventTimeOffset": "+00:00",
        "trackingUrl": null,
        "latitude": null,
        "longitude": null,
        "locationUnit": null,
        "scanDescription": "DELIVERED, IN/AT MAILBOX",
        "packageStatus": "Delivered",
        "eventCity": "SALINA",
        "eventStateOrProvince": "KS",
        "postalCode": "67401",
        "country": null
    },
    ...
    ],
    "currentStatus": {
        "l1Code": "01",
        "l1Description": "Delivered",
        "l2Description": "Delivered",
        "eventDate": "2021-10-22",
        "eventTime": "16:23:00",
        "eventTimeOffset": "+00:00",
        "trackingUrl": null,
        "latitude": null,
        "longitude": null,
        "locationUnit": null,
        "packageStatus": "Delivered",
        "scanDescription": "DELIVERED, IN/AT MAILBOX",
        "eventCity": "SALINA",
        "eventStateOrProvince": "KS",
        "postalCode": "67401",
        "country": ""
    },
    "status": "Delivered",
    "updatedDate": "2021-10-22",
    "updatedTime": "16:23:00",
    "lastPackageStatusLocation": "SALINA,KS,67401"
}

PB Standard Delivery Sample Tracking Request

PB Standard Delivery Sample Tracking Request
curl -X GET .../v1/tracking/4209850192612999999999000000337629?packageIdentifierType=TrackingNumber&carrier=PBCS \
-H "Authorization: Bearer <oauth_token>"
PB Standard Delivery Sample Tracking Response
{
    "packageCount": 1,
    "reattemptDate": null,
    "reattemptTime": null,
    "signedBy": null,
    "senderAddress": {
        "name": null,
        "address1": null,
        "address2": null,
        "address3": null,
        "city": null,
        "stateOrProvince": null,
        "postalCode": null,
        "country": null
    },
    "requestedIdentifier": "4209850192612999999999000000337629",
    "clientId": null,
    "trackingNumber": "4209850192612999999999000000337629",
    "referenceNumber": "1000010",
    "smartLabelBarcode": null,
    "carrier": "PBCS",
    "serviceName": null,
    "serviceCode": null,
    "estimatedDeliveryDate": null,
    "estimatedDeliveryTime": null,
    "estimatedDeliveryTimeOffset": null,
    "weight": "6.53",
    "weightUOM": "lbs",
    "dimension": {
        "length": null,
        "width": null,
        "height": null,
        "unitOfMeasurement": null
    },
    "deliveryDate": "2022-07-23",
    "deliveryTime": "16:36:00",
    "deliveryTimeOffset": "-07:00",
    "deliveryProofUrl": null,
    "shipDate": null,
    "shipTime": null,
    "shipTimeOffset": null,
    "destinationAddress": {
        "name": null,
        "address1": null,
        "address2": null,
        "address3": null,
        "city": "OLYMPIA",
        "stateOrProvince": "WA",
        "country": null,
        "postalCode": "98501"
    },
    "deliveryLocation": "OLYMPIA,WA,98501",
    "deliveryLocationDescription": "DELIVERED LEFT WITH INDIVIDUAL",
    "scanDetailsList": [ {
        "standardizedEventCode": "DLD",
        "l1Code": "DLD",
        "l1Description": "Delivered",
        "l2Description": "Delivered",
        "eventDate": "2022-07-23",
        "eventTime": "16:36:00",
        "eventTimeOffset": "-07:00",
        "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=9261292123450000000086549",
        "latitude": null,
        "longitude": null,
        "locationUnit": null,
        "eventLeg": "FML",
        "eventType": "FWD",
        "scanType": "01",
        "scanDescription": "DELIVERED LEFT WITH INDIVIDUAL",
        "packageStatus": "Delivered",
        "eventCity": "OLYMPIA",
        "eventStateOrProvince": "WA",
        "postalCode": "98501",
        "country": null
    },
    ...
    ],
    "currentStatus": {
        "standardizedEventCode": "DLD",
        "l1Code": "01",
        "l1Description": "Delivered",
        "l2Description": "Delivered",
        "eventDate": "2022-07-23",
        "eventTime": "16:36:00",
        "eventTimeOffset": "-07:00",
        "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction?qtc_tLabels1=92612927005715000000337629",
        "latitude": null,
        "longitude": null,
        "locationUnit": null,
        "eventLeg": "FML",
        "eventType": "FWD",
        "packageStatus": "Delivered",
        "scanType": "01",
        "scanDescription": "DELIVERED LEFT WITH INDIVIDUAL",
        "eventCity": "OLYMPIA",
        "eventStateOrProvince": "WA",
        "postalCode": "98501",
        "country": null
    },
    "status": "Delivered",
    "updatedDate": "2022-07-23",
    "updatedTime": "16:36:00",
    "lastPackageStatusLocation": "OLYMPIA,WA,98501"
}

PB Standard Returns Sample Tracking Request

PB Standard Returns Sample Tracking Request
curl -X GET .../v1/tracking/4205690192023999999999000000312757?packageIdentifierType=TrackingNumber&carrier=PBCS \
-H "Authorization: Bearer <oauth_token>"
PB Standard Sample Tracking Response
{
    "packageCount": 1,
    "reattemptDate": null,
    "reattemptTime": null,
    "signedBy": null,
    "senderAddress": {
        "name": null,
        "address1": null,
        "address2": null,
        "address3": null,
        "city": null,
        "stateOrProvince": null,
        "postalCode": null,
        "country": null
    },
    "requestedIdentifier": "4205690192023999999999000000312757",
    "clientId": null,
    "trackingNumber": "4205690192023999999999000000312757",
    "referenceNumber": "16914244210",
    "smartLabelBarcode": "7251019609999999999990000000016914244210I",
    "carrier": "PBCS",
    "serviceName": null,
    "serviceCode": null,
    "estimatedDeliveryDate": null,
    "estimatedDeliveryTime": null,
    "estimatedDeliveryTimeOffset": null,
    "weight": "2.41",
    "weightUOM": "lbs",
    "dimension": {
        "length": null,
        "width": null,
        "height": null,
        "unitOfMeasurement": null
    },
    "deliveryDate": "2022-07-25",
    "deliveryTime": "10:10:00",
    "deliveryTimeOffset": "-04:00",
    "deliveryProofUrl": null,
    "shipDate": null,
    "shipTime": null,
    "shipTimeOffset": null,
    "destinationAddress": {
        "name": null,
        "address1": null,
        "address2": null,
        "address3": null,
        "city": "Rocky Mount",
        "stateOrProvince": "NC",
        "country": "US",
        "postalCode": "27801"
    },
    "deliveryLocation": "Rocky Mount,NC,US,27801",
    "deliveryLocationDescription": null,
    "scanDetailsList": [ {
        "standardizedEventCode": "DLD",
        "l1Code": "DLD",
        "eventDescription": "",
        "l1Description": "Delivered",
        "l2Description": "Delivered to your return facility",
        "eventDate": "2022-07-25",
        "eventTime": "10:10:00",
        "eventTimeOffset": "-04:00",
        "trackingUrl": null,
        "latitude": null,
        "longitude": null,
        "locationUnit": null,
        "eventLeg": "DEL",
        "eventType": "RTN",
        "scanType": "D1",
        "packageStatus": "Delivered",
        "eventCity": "Rocky Mount",
        "eventStateOrProvince": "NC",
        "postalCode": "27801",
        "country": "US"
    },
    ...
    ],
    "currentStatus": {
        "standardizedEventCode": "DLD",
        "l1Code": "DLD",
        "eventDescription": "",
        "l1Description": "Delivered",
        "l2Description": "Delivered to your return facility",
        "eventDate": "2022-07-25",
        "eventTime": "10:10:00",
        "eventTimeOffset": "-04:00",
        "trackingUrl": null,
        "latitude": null,
        "longitude": null,
        "locationUnit": null,
        "eventLeg": "DEL",
        "eventType": "RTN",
        "packageStatus": "Delivered",
        "scanType": "D1",
        "eventCity": "Rocky Mount",
        "eventStateOrProvince": "NC",
        "postalCode": "27801",
        "country": "US"
    },
    "status": "Delivered",
    "updatedDate": "2022-07-25",
    "updatedTime": "10:10:00",
    "lastPackageStatusLocation": "Rocky Mount,NC,27801"
}

CBDS Sample Tracking Request

CBDS Sample Tracking Request
curl -X GET .../v1/tracking/PBXCB000000003456789?packageIdentifierType=TrackingNumber \
-H "Authorization: Bearer <oauth_token>"
CBDS Sample Tracking Response
{
    "packageCount": 1,
    "reattemptDate": null,
    "reattemptTime": null,
    "signedBy": null,
    "senderAddress": {
        "name": null,
        "address1": null,
        "address2": null,
        "address3": null,
        "city": null,
        "stateOrProvince": null,
        "postalCode": null,
        "country": null
    },
    "requestedIdentifier": "PBXCB000000003456789",
    "clientId": null,
    "trackingNumber": "PBXCB000000003456789",
    "referenceNumber": null,
    "smartLabelBarcode": null,
    "carrier": "PBI",
    "serviceName": "Pitney Bowes Expedited Parcel Service",
    "serviceCode": null,
    "estimatedDeliveryDate": null,
    "estimatedDeliveryTime": null,
    "estimatedDeliveryTimeOffset": null,
    "weight": "5",
    "weightUOM": "lb",
    "dimension": {
        "length": null,
        "width": null,
        "height": null,
        "unitOfMeasurement": null
    },
    "deliveryDate": "2021-12-04",
    "deliveryTime": "23:52:29",
    "deliveryTimeOffset": "+00:00",
    "deliveryProofUrl": null,
    "shipDate": null,
    "shipTime": null,
    "shipTimeOffset": null,
    "destinationAddress": {
        "name": null,
        "address1": null,
        "address2": null,
        "address3": null,
        "city": "COOGEE NSW",
        "stateOrProvince": null,
        "country": null,
        "postalCode": null
    },
    "deliveryLocation": "COOGEE NSW",
    "deliveryLocationDescription": "Delivered",
    "scanDetailsList": [ {
        "l1Code": "DLD",
        "l1Description": "Delivered",
        "l2Description": null,
        "eventDate": "2021-12-04",
        "eventTime": "23:52:29",
        "eventTimeOffset": "+00:00",
        "trackingUrl": "https://.../track_sequenceNo=33YWE1987654",
        "latitude": null,
        "longitude": null,
        "locationUnit": null,
        "scanDescription": "Delivered",
        "packageStatus": "Delivered",
        "eventCity": "COOGEE NSW",
        "eventStateOrProvince": null,
        "postalCode": null,
        "country": null
    },
    ...
    ],
    "currentStatus": {
        "l1Code": "DLD",
        "l1Description": "Delivered",
        "l2Description": null,
        "eventDate": "2021-12-04",
        "eventTime": "23:52:29",
        "eventTimeOffset": "+00:00",
        "trackingUrl": "https://.../track_sequenceNo=33YWE1987654",
        "latitude": null,
        "longitude": null,
        "locationUnit": null,
        "packageStatus": "Delivered",
        "scanDescription": "Delivered",
        "eventCity": "COOGEE NSW",
        "eventStateOrProvince": null,
        "postalCode": null,
        "country": null
    },
    "status": "Delivered",
    "updatedDate": "2021-12-04",
    "updatedTime": "23:52:29",
    "lastPackageStatusLocation": "COOGEE NSW"
}

FedEx Sample Tracking Request

FedEx Sample Tracking Request
curl -X GET .../v1/tracking/771234567890?packageIdentifierType=TrackingNumber \
-H "Authorization: Bearer <oauth_token>"
FedEx Sample Tracking Response
{
    "packageCount": 1,
    "reattemptDate": null,
    "reattemptTime": null,
    "signedBy": null,
    "senderAddress": {
        "name": null,
        "address1": null,
        "address2": null,
        "address3": null,
        "city": null,
        "stateOrProvince": null,
        "postalCode": null,
        "country": null
    },
    "requestedIdentifier": "771234567890",
    "clientId": null,
    "trackingNumber": "771234567890",
    "referenceNumber": null,
    "smartLabelBarcode": null,
    "carrier": "FEDEX",
    "serviceName": "FedEx Express Saver",
    "serviceCode": null,
    "estimatedDeliveryDate": null,
    "estimatedDeliveryTime": null,
    "estimatedDeliveryTimeOffset": null,
    "weight": "0",
    "weightUOM": "KGS",
    "dimension": {
        "length": null,
        "width": null,
        "height": null,
        "unitOfMeasurement": null
    },
    "deliveryDate": "2022-01-11",
    "deliveryTime": "22:10:00",
    "deliveryTimeOffset": "+00:00",
    "deliveryProofUrl": null,
    "shipDate": null,
    "shipTime": null,
    "shipTimeOffset": null,
    "destinationAddress": {
        "name": null,
        "address1": null,
        "address2": null,
        "address3": null,
        "city": "Baton Rouge",
        "stateOrProvince": "LA",
        "country": "US",
        "postalCode": "70806"
    },
    "deliveryLocation": "Baton Rouge,LA,US,70806",
    "deliveryLocationDescription": "Delivered -  Package delivered to recipient address - release authorized",
    "scanDetailsList": [ {
        "l1Code": "DL",
        "l1Description": "Delivered -  Package delivered to recipient address - release authorized",
        "l2Description": null,
        "eventDate": "2022-01-11",
        "eventTime": "22:10:00",
        "eventTimeOffset": "+00:00",
        "trackingUrl": "https://.../index.html?tracknumbers=771234567890&cntry_code=us",
        "latitude": null,
        "longitude": null,
        "locationUnit": null,
        "scanDescription": "Delivered -  Package delivered to recipient address - release authorized",
        "packageStatus": "Delivered",
        "eventCity": "Baton Rouge",
        "eventStateOrProvince": "LA",
        "postalCode": "70806",
        "country": "US"
    },
    ...
    ],
    "currentStatus": {
        "l1Code": "DL",
        "l1Description": "Delivered -  Package delivered to recipient address - release authorized",
        "l2Description": null,
        "eventDate": "2022-01-11",
        "eventTime": "22:10:00",
        "eventTimeOffset": "+00:00",
        "trackingUrl": "https://.../index.html?tracknumbers=771234567890&cntry_code=us",
        "latitude": null,
        "longitude": null,
        "locationUnit": null,
        "packageStatus": "Delivered",
        "scanDescription": "Delivered -  Package delivered to recipient address - release authorized",
        "eventCity": "Baton Rouge",
        "eventStateOrProvince": "LA",
        "postalCode": "70806",
        "country": "US"
    },
    "status": "Delivered",
    "updatedDate": "2022-01-11",
    "updatedTime": "22:10:00",
    "lastPackageStatusLocation": "Baton Rouge,LA,70806"
}

UPS Sample Tracking Request

Note

UPS labels must be printed through the PB Ecommerce APIs to be tracked through this API call.

UPS Sample Tracking Request
curl -X GET .../v1/tracking/1Z0927XA0340576884?packageIdentifierType=TrackingNumber \
-H "Authorization: Bearer <oauth_token>"
UPS Sample Tracking Response
{
    "packageCount": 1,
    "reattemptDate": null,
    "reattemptTime": null,
    "signedBy": null,
    "senderAddress": {
        "name": null,
        "address1": null,
        "address2": null,
        "address3": null,
        "city": null,
        "stateOrProvince": null,
        "postalCode": null,
        "country": null
    },
    "requestedIdentifier": "1Z0927XA0340576884",
    "clientId": null,
    "trackingNumber": "1Z0927XA0340576884",
    "referenceNumber": null,
    "smartLabelBarcode": null,
    "carrier": "UPS",
    "serviceName": "UPS Ground",
    "serviceCode": "003",
    "estimatedDeliveryDate": "2022-01-12",
    "estimatedDeliveryTime": "00:00:00",
    "estimatedDeliveryTimeOffset": "+00:00",
    "weight": "2.00",
    "weightUOM": "LBS",
    "dimension": {
        "length": null,
        "width": null,
        "height": null,
        "unitOfMeasurement": null
    },
    "deliveryDate": "2022-01-12",
    "deliveryTime": "11:15:28",
    "deliveryTimeOffset": "+00:00",
    "deliveryProofUrl": null,
    "shipDate": null,
    "shipTime": null,
    "shipTimeOffset": null,
    "destinationAddress": {
        "name": null,
        "address1": null,
        "address2": null,
        "address3": null,
        "city": "NASHVILLE",
        "stateOrProvince": "TN",
        "country": "US",
        "postalCode": "37221"
    },
    "deliveryLocation": "NASHVILLE,TN,US,37221",
    "deliveryLocationDescription": "Delivered",
    "scanDetailsList": [ {
        "l1Code": "D",
        "l1Description": "Delivered",
        "l2Description": null,
        "eventDate": "2022-01-12",
        "eventTime": "11:15:28",
        "eventTimeOffset": "+00:00",
        "trackingUrl": null,
        "latitude": null,
        "longitude": null,
        "locationUnit": null,
        "scanDescription": "Delivered",
        "packageStatus": "Delivered",
        "eventCity": "NASHVILLE",
        "eventStateOrProvince": "TN",
        "postalCode": "37221",
        "country": "US"
    },
    ...
    ],
    "currentStatus": {
        "l1Code": "D",
        "l1Description": "Delivered",
        "l2Description": null,
        "eventDate": "2022-01-12",
        "eventTime": "11:15:28",
        "eventTimeOffset": "+00:00",
        "trackingUrl": null,
        "latitude": null,
        "longitude": null,
        "locationUnit": null,
        "packageStatus": "Delivered",
        "scanDescription": "Delivered",
        "eventCity": "NASHVILLE",
        "eventStateOrProvince": "TN",
        "postalCode": "37221",
        "country": "US"
    },
    "status": "Delivered",
    "updatedDate": "2022-01-12",
    "updatedTime": "11:15:28",
    "lastPackageStatusLocation": "NASHVILLE,TN,37221"
}

Error Codes

This API uses PB-TRKPKG-ERR Codes.

For a list of all error codes returned by the Ecommerce APIs, please see Error Codes.