Tracking
Tracking of jobs
You can track the status of your job which you have created recently.
URL Config
Method: POST
Endpoint: https://api-stage.dps.io/api
APIVersion: v1
route: trackings
path:
Method
POST
URL
https://api-stage.dps.io/api/v1/trackings
Request Headers
{
"Content-Type": "application/json",
"x-api-key": "<YOUR_API_KEY>",
"ShipperHash": "<YOUR_SHIPPER_HASH>"
}
Request Body
{
"Mode": "Staging",
"JobType":"Print2Mail",
"JobHash":"3wrFqhNZyoH31vgXd3cXQh"
}
info
- Please follow the below table to use tracking filters.
| Filter | Required | Default | DataType | Example |
|---|---|---|---|---|
| Limit | No | 10 | Int | leave as default |
| Page | No | 1 | Int | leave as default |
| Mode | No | Live or Staging | String | leave as default |
| ToName | No | String | John | |
| ToCompanyName | No | String | abc | |
| CaseName | No | String | topic name, topic subject ( use one of both ) | |
| ArticleNumber | No | String | 42093950**9992544 | |
| LastStatus | No | String | Delivered, Cancelled, Ordered and Mailed (use one of mentioned status) | |
| PostageType | No | String | PRIL, PMAIL, FC, FCSig, ERR and ERRSig (use one of mentioned PostageType) | |
| DateRange | No | String | "1/01/2021, 09/09/2022" (DateRange format should be mm/dd/yyyy) | |
| JobHash | No | String | Your Unique JobHash |
Curl request
curl --location --request POST 'https://api-stage.dps.io/api/v1/trackings' \
--header 'x-api-key: <YOUR API KEY>' \
--header 'ShipperHash: <YOUR SHIPPER HASH>' \
--header 'Content-Type: application/json' \
--data-raw '{
"Mode": "Staging",
"JobType":"Print2Mail",
"JobHash":"<Your Unique JobHash>"
}'
Response Body
{
"Records": [
{
"ShipperHash": "<YOUR SHIPPER HASH>",
"JobHash": "<YOUR UNQIUE JOB HASH>",
"ComInfo": {
"ActualFileName": "COM.pdf",
"S3Path": "UserCertificates/7z2PC****essbzAg/1yQghF****CDPvr8b3/R1/COM.pdf",
"S3Hash": "3a730c3b*****56753301265",
"EventDate": "12/22/2022",
"Size": "2141.82",
"PageCount": 1
},
"CodInfo": {
"ActualFileName": "COD.pdf",
"S3Path": "UserCertificates/7z2PC****essbzAg/1yQghF****CDPvr8b3/R1/COD.pdf",
"S3Hash": "0badfe******c8e9cfe4033a",
"EventDate": "2022-12-22 11:43:00",
"Size": "2089.54",
"PageCount": 1
},
"RecordDate": "2022-12-22 09:32:39.616188+00:00",
"ArticleNumber": "9214890*****804584",
"Mode": "Live",
"Weight": 0.66,
"ApiService": "Print2Mail ",
"PersonName": "John Doe",
"Color": true,
"PrintType": "",
"ReturnEnvelope": false,
"UniqueJobId": null,
"PostageType": "PRIL",
"FromName": "John Michel",
"PostageLabelHash": null,
"PostageLabelPath": null,
"PostageReceiptHash": null,
"PostageReceiptPath": null,
"TopicHash": "5Ufh7O****9eNmoxM3k",
"PageCount": 3,
"LastStatus": "Delivered",
"UspsTracking": "Delivered",
"MailDate": "2022-05-18 00:00:00",
"DeliveryDate": "2022-05-20 11:43:00",
"ToName": "John Doe",
"DispatchDate": null,
"OrderedDate": "2022-06-03 09:32:51.947613+00:00",
"JobId": "15032361",
"IsCanceled": false,
"TopicName": "John",
"TopicSubject": "checkout",
"StorageYears": null,
"Container": null,
"ToCompanyName": "abc",
"ToEmail": null,
"ToPhone": "92****1945",
"ToCountry": "United States",
"ToCity": "Placida",
"ToState": "FL",
"ToZip": "33946",
"ToAddressLine1": "12575 Placida RD",
"ToAddressLine2": "Placida",
"FromCompany": "abc",
"FromEmail": "john@gamil.com",
"FromPhone": "79*****568",
"FromCountry": "united states",
"FromCity": "Capitola",
"FromState": "CA",
"FromZip": "93950",
"FromAddressLine1": "1120 Sills Ct",
"FromAddressLine2": "4",
"AddressHash": "7j4Kd****qqR4gwQJ",
"Category": null,
"DocumentHash": "BabR7m****SEMEdnmZD",
"JobType": "Print2Mail ",
"DocumentFileName": "merged_doc.pdf",
"DocumentName": null,
"DocumentPath": "multi_file_pdf/7z2PCpa***slsessbzAg/BabR7m****SEMEdnmZD/merged_doc.pdf"
}
],
"TotalPageCount": 1,
"CurrentPage": 1,
"NextPage": "",
"TotalRecords": 1
}