Skip to content
/Decode

Decode

APIs for decoding package tracking numbers from supported barcode formats. These APIs extract package-related details such as carrier information, receiver identifiers, and package type.

Operations

Decode Tracking Number

Request

This operation decodes a tracking number from a barcode, extracting package details like carrier information, receiver Id, and package type. It supports 2D barcodes.

Security
bearerAuth
Query
trackingNumbernumberrequired

The tracking numebr to be decoded.

Example:trackingNumber=PB4OZAWWNPBG
expectedPackageboolean

Indicates if the decoded asset is part of an expected package. Set to 'true' for expected packages.

Example:expectedPackage=true
editflowboolean
Example:editflow=false
curl -i -X GET \
  'https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack/api/v1/packages/tracking/decode?trackingNumber=PB4OZAWWNPBG&expectedPackage=true&editflow=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful response containing decoded tracking details and package information.

Bodyapplication/json
packageobject(PackageResponse)

Details of the package

decodedCarriersArray of objects

A list of decoded carriers associated with the request.

Response
{
  "package": {
    "packageId": "LMQmVaVXXxyQyZv1l2EkO",
    "sender": {
      "personalId": "jy32",
      "contactId": "5f508e6baa797f3c3d092307",
      "name": "contact_name",
      "company": "company_name",
      "phone": "1234567890",
      "email": "user@email.com",
      "additionalEmailIds": [ … ],
      "location": { … },
      "mailStopLocation": { … }
    },
    "receiver": {
      "personalId": "jy32",
      "contactId": "5f508e6baa797f3c3d092307",
      "name": "contact_name",
      "company": "company_name",
      "phone": "1234567890",
      "email": "user@email.com",
      "additionalEmailIds": [ … ],
      "location": { … },
      "mailStopLocation": { … }
    },
    "givenTo": {
      "personalId": "jy32",
      "contactId": "5f508e6baa797f3c3d092307",
      "name": "contact_name",
      "company": "company_name",
      "phone": "1234567890",
      "email": "user@email.com",
      "additionalEmailIds": [ … ],
      "location": { … },
      "mailStopLocation": { … }
    },
    "trackingNumber": "PBYV4PVRBYLAAW",
    "carrier": {
      "carrierId": "FedEx",
      "name": "FedEx"
    },
    "damaged": false,
    "comment": "user_comment",
    "currentLocation": {
      "inboundSiteId": "zy0a23Bo4Gn0",
      "name": "Site 1CD1001RMF",
      "parent": "Site",
      "type": "site",
      "locationHierarchy": "Noida, Office of CG| Noida,Bldg| Noida,Floor| Noida,MS",
      "ancestorlist": [ … ],
      "topTier": { … }
    },
    "currentStatus": "RECEIVED",
    "confirmationType": "PHONE",
    "additionalConfirmationType": "SIGNATURE",
    "timezone": -330,
    "customFields": [
      { … }
    ]
  },
  "decodedCarriers": [
    {
      "trackingNum": "PBLZQ93PMANYPO"
    }
  ]
}