About Tracking
Learn more about Tracking
DPS Tracking service provides end-to-end item tracking of jobs. This article provides in-depth information on how to use the service, what information the service provides, and more convenient ways to access your item's tracking information.
You need to prepare the required data available before calling Tracking API. For example, ShipperHash, ArticleNumber, etc.
Tracking Attribute
An object of Tracking could have the following attributes.
KEY | DESCRIPTION |
---|---|
ShipperHash | ShipperHash of api user |
JobHash | It will be the Unique JobHash of your order |
ComInfo | This would be COM Info with all the required ComInfo attributes of certificate of mailing |
CodInfo | This would be COD Info with all the required CodInfo of certificate of delivery |
RecordDate | It would be Record created date. |
ArticleNumber | A searchable number for tracking. |
Mode | Checkout Mode |
Weight | Weight of your package |
ApiService | Name of your used service for the current order and currently we are supporting ePostage only |
PersonName | Name of of the person(sender's name) |
Color | X |
PrintType | X |
ReturnEnvelope | X |
UniqueJobId | It will auto generate a unique job id (human readable id not like JobHash) |
PostageType | This would be selected PostageType that you have selected while creating the job |
FromName | Sender Name |
PostageLabelHash | It will be your Postage Label file hash |
PostageLabelPath | It will be your Postage Label Path, you can use it later to preview it from the [download] section |
PostageReceiptHash | This would be generated Postage Label Receipt unique hash |
PostageReceiptPath | This would be generated Postage Label Receipt path, you can use it later to preview it from [download] section |
TopicHash | This would be your passed topic hash, this is optional. |
PageCount | If you are using a document along with ePostage label then it would be your document page count |
LastStatus | This would be your package last status |
UspsTracking | USPS tracking status, it would be the same as LastStatus |
MailDate | Date of mailing and it will be available once your order will be mailed |
DeliveryDate | Date of delivery and it will be available once your order will be delivered |
ToName | It would be Recipient name |
DispatchDate | This would be the date when your order would have been dispatched. |
OrderedDate | This would be your ordered created date |
ShipDate | This would be your estimated ShippingDate |
JobId | X |
IsCanceled | This would be boolean, if you will cancel it then it would be true else false |
NftWalletAddress | X |
TopicName | Topic name of your topic, if you gonna use TopicHash while creating a job |
TopicSubject | Subject of your created topic, if you gonna use TopicHash while creating a job |
StorageYears | This would be the selected storage years of your order |
StorageCost | It will be your storage cost, its cost depends on your selected storage class. |
CertificateCost | It would be certificate cost |
CustomerChargedPrice | It will be your charged price |
PostagePrice | It will be your charged price same Customer charged price |
PriceType | PriceType would be Retail and Commercial, it depends on your subscription. |
Container | It would be your Selected container |
ToCompanyName | Recipient's company name |
ToEmail | Recipient's email |
ToPhone | Recipient's phone number |
ToCountry | Recipient's country |
ToCity | Recipient's city name |
ToState | Recipient's state name |
ToZip | Recipient's postal code |
ToAddressLine1 | Recipient's address line1 |
ToAddressLine2 | Recipient's address line2 |
FromCompany | Sender's company name |
FromEmail | Sender's email name |
FromPhone | Sender's phone name |
FromCountry | Sender's country name |
FromCity | Sender's city name |
FromState | Sender's state name |
FromZip | Sender's postal code |
FromAddressLine1 | Sender's address line1 |
FromAddressLine2 | Sender's address line2 |
SubscriptionName | This would be your subscription name |
AddressHash | This would be your recipient hash |
TokenId | X |
Blockchain | X |
NetworkName | X |
IsTransferred | X |
Category | This would be the category of your document |
IsNft | X |
DocumentHash | This would be the document hash of your used document |
JobType | It would be the type of your job as we are offering multiple jobs like ePostage , Print2Mail, and NFT |
DocumentFileName | It would be your actual file name |
DocumentName | It would be document title |
DocumentPath | Path of your document, later you can use it to download or preview |
COM and COD attributes
KEY | DESCRIPTION |
---|---|
ActualFileName | Filename of your uploaded document as it is to be saved |
S3Path | Destination path of your file |
S3Hash | It would be a Unique File hash |
EventDate | File saved date |
Size | File size |
PageCount | Page count of your file |