Tracking

Tracking of jobs

You can track the status of your job which you have created recently.

URL Config

Method: POST
Endpoint: https://api.dps.io/api
APIVersion: v1
route: trackings
path: 

Method

POST

URL

https://api.dps.io/api/v1/trackings

Request Headers

{
  "Content-Type": "application/json",
  "x-api-key": "<YOUR_API_KEY>",
  "ShipperHash": "<YOUR_SHIPPER_HASH>"
}

Request Body

{
  "ShipperHash": "7z2PC****************************sbzAg",
  "JobHash": "",
  "Mode": "",
  "ToName": "",
  "ToCompanyName": "",
  "CaseName": "",
  "ArticleNumber": "",
  "LastStatus": "",
  "PostageType":"",
  "Limit": 5,
  "Page": 1,
  "DateRange": "1/01/2021, 09/09/2022"
}

info

• Please follow the below table to use tracking filters.

Filter	Required	Default	DataType	Example
ShipperHash	Yes		String	7z2PC****sbzAg
Limit	No	10	Int	leave as default
Page	No	1	Int	leave as default
Mode	No	Live	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	77oA4Rs7qHV5zEavdM1I7W

Curl request

curl --location --request POST 'https://api.dps.io/api/v1/trackings' \
--header 'x-api-key: xxxxxxdfjbdjdfjdhfxxxxxxx' \
--header 'ShipperHash: 7z2PC****************************sbzAg' \
--header 'Content-Type: application/json' \
--data-raw '{
            "ShipperHash": "7z2PC****************************sbzAg",
            "JobId": "",
            "ToName": "",
            "ToCompanyName": "",
            "CaseName": "",
            "ArticleNumber": "",
            "LastStatus": "",
            "PostageType":"",
            "Limit": 5,
            "Page": 1,
            "DateRange": "1/01/2021, 09/09/2022"
            }'

Response Body

{
  "Records": [
        {
      "ShipperHash": "7z2PC****************************sbzAg",
      "JobHash": "77oA4Rs7qHV5zEavdM1I7W",
      "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": "ePostage ",
      "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",
      "ShipDate": null,
      "JobId": "15032361",
      "IsCanceled": false,
      "NftWalletAddress": "********",
      "TopicName": "John",
      "TopicSubject": "checkout",
      "StorageYears": null,
      "StorageCost": 0.0,
      "CertificateCost": null,
      "CustomerChargedPrice": null,
      "PostagePrice": null,
      "PriceType": 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",
      "SubscriptionName": null,
      "AddressHash": "7j4Kd****qqR4gwQJ",
      "TokenId": null,
      "Blockchain": null,
      "NetworkName": "",
      "IsTransferred": null,
      "Category": null,
      "IsNft": false,
      "DocumentHash": "BabR7m****SEMEdnmZD",
      "JobType": "ePostage ",
      "DocumentFileName": "merged_doc.pdf",
      "DocumentName": null,
      "DocumentPath": "multi_file_pdf/7z2PCpa***slsessbzAg/BabR7m****SEMEdnmZD/merged_doc.pdf"
    }
  ],
  "TotalPageCount": 1,
  "CurrentPage": 1,
  "NextPage": "",
  "TotalRecords": 1
}