Decode Tracking Number

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

SecuritybearerAuth

Request

query Parameters

trackingNumber required	number The tracking numebr to be decoded. Example: trackingNumber=PB4OZAWWNPBG
expectedPackage	boolean Indicates if the decoded asset is part of an expected package. Set to 'true' for expected packages. Example: expectedPackage=true
editflow	boolean

Responses

200

Successful response containing decoded tracking details and package information.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

get/api/v1/packages/tracking/decode

Request samples

Response samples

application/json

{"package": {"packageId": "LMQmVaVXXxyQyZv1l2EkO",
"sender": {"personalId": "jy32",
"contactId": "5f508e6baa797f3c3d092307",
"name": "contact_name",
"company": "company_name",
"phone": "1234567890",
"location": {"inboundSiteId": "zy0a23Bo4Gn0",
"name": "Site 1CD1001RMF",
"parent": "Site",
"type": "site",
"locationHierarchy": "Noida, Office of CG| Noida,Bldg| Noida,Floor| Noida,MS",
"ancestorlist": ["k5OrZWe0ly6dg1v",
"gKP4RNbMzrPO",
"XbyR9zpPDneY"
],
"topTier": {"inboundSiteId": "EMPTY_SITE",
"name": "EMPTY_SITE"
}
},
"mailStopLocation": {"inboundSiteId": "zy0a23Bo4Gn0",
"name": "Site 1CD1001RMF",
"parent": "Site",
"type": "site",
"locationHierarchy": "Noida, Office of CG| Noida,Bldg| Noida,Floor| Noida,MS",
"ancestorlist": ["k5OrZWe0ly6dg1v",
"gKP4RNbMzrPO",
"XbyR9zpPDneY"
],
"topTier": {"inboundSiteId": "EMPTY_SITE",
"name": "EMPTY_SITE"
}
}
},
"receiver": {"personalId": "jy32",
"contactId": "5f508e6baa797f3c3d092307",
"name": "contact_name",
"company": "company_name",
"phone": "1234567890",
"location": {"inboundSiteId": "zy0a23Bo4Gn0",
"name": "Site 1CD1001RMF",
"parent": "Site",
"type": "site",
"locationHierarchy": "Noida, Office of CG| Noida,Bldg| Noida,Floor| Noida,MS",
"ancestorlist": ["k5OrZWe0ly6dg1v",
"gKP4RNbMzrPO",
"XbyR9zpPDneY"
],
"topTier": {"inboundSiteId": "EMPTY_SITE",
"name": "EMPTY_SITE"
}
},
"mailStopLocation": {"inboundSiteId": "zy0a23Bo4Gn0",
"name": "Site 1CD1001RMF",
"parent": "Site",
"type": "site",
"locationHierarchy": "Noida, Office of CG| Noida,Bldg| Noida,Floor| Noida,MS",
"ancestorlist": ["k5OrZWe0ly6dg1v",
"gKP4RNbMzrPO",
"XbyR9zpPDneY"
],
"topTier": {"inboundSiteId": "EMPTY_SITE",
"name": "EMPTY_SITE"
}
}
},
"givenTo": {"personalId": "jy32",
"contactId": "5f508e6baa797f3c3d092307",
"name": "contact_name",
"company": "company_name",
"phone": "1234567890",
"location": {"inboundSiteId": "zy0a23Bo4Gn0",
"name": "Site 1CD1001RMF",
"parent": "Site",
"type": "site",
"locationHierarchy": "Noida, Office of CG| Noida,Bldg| Noida,Floor| Noida,MS",
"ancestorlist": ["k5OrZWe0ly6dg1v",
"gKP4RNbMzrPO",
"XbyR9zpPDneY"
],
"topTier": {"inboundSiteId": "EMPTY_SITE",
"name": "EMPTY_SITE"
}
},
"mailStopLocation": {"inboundSiteId": "zy0a23Bo4Gn0",
"name": "Site 1CD1001RMF",
"parent": "Site",
"type": "site",
"locationHierarchy": "Noida, Office of CG| Noida,Bldg| Noida,Floor| Noida,MS",
"ancestorlist": ["k5OrZWe0ly6dg1v",
"gKP4RNbMzrPO",
"XbyR9zpPDneY"
],
"topTier": {"inboundSiteId": "EMPTY_SITE",
"name": "EMPTY_SITE"
}
}
},
"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": ["k5OrZWe0ly6dg1v",
"gKP4RNbMzrPO",
"XbyR9zpPDneY"
],
"topTier": {"inboundSiteId": "EMPTY_SITE",
"name": "EMPTY_SITE"
}
},
"currentStatus": "RECEIVED",
"confirmationType": "PHONE",
"additionalConfirmationType": "SIGNATURE",
"timezone": -330,
"customFields": [{"name": "End User",
"status": "ACTIVE",
"customFieldId": "o1axRY2NKxq",
"value": "end user"
}
]
},
"decodedCarriers": [{"trackingNum": "PBLZQ93PMANYPO"
}
]
}