List documents
Get all documents for Shipper
With the help of this section you can get the list of all documents associated with a shipper.
URL Config
Endpoint: https://api.dps.io/api
APIVersion: v1
route: documents
path: <YOUR_SHIPPER_HASH>
Method
GET
URL
https://api.dps.io/api/v1/documents/05K9G*************************BJG6a
Request Headers
{
"Content-Type": "application/json",
"x-api-key": "<YOUR_API_KEY>",
"ShipperHash": "<YOUR_SHIPPER_HASH>"
}
Curl request
curl --location --request GET 'https://api.dps.io/api/v1/documents/05K9G*************************BJG6a' \
--header 'x-api-key: xxxxxxdfjbdjdfjdhfxxxxxxx' \
--header 'ShipperHash: 05K9G*************************BJG6a'
Response
[
{
"Id": 1866,
"DocumentHash": "Dzd7*************************Cw6rL",
"ShipperHash": "05K9G*************************BJG6a",
"useddocumenthashes": null,
"printerdocumentid": null,
"FileHash": null,
"FileName": "sample.pdf",
"Tags": "sample, pdf",
"Description": "Sample PDF document to upload",
"Path": "multi_file_pdf/dev/05K9G*************************BJG6a/rCw6rL.pdf",
"PageCount": 0,
"DocSize": 0.0,
"DocType": "SingleDoc",
"LastModified": "2022-11-08 19:18:21.189836+00:00",
"CreatedDate": "2022-11-08 19:18:20.550041+00:00",
"isdeleted": false,
"isencrypted": null,
"status": "Pending",
"Weight": 0.0,
"DocumentName": "PUMA SOFT RIDE ENZO",
"DocInfo": null,
"ItemId": "PU45856AAA84M",
"Category": "test document",
"uniquedocumentid": "DPSDI-00051-00002"
},
{
"Id": 1867,
"DocumentHash": "GU0p**************************V14",
"ShipperHash": "05K9G*************************BJG6a",
"useddocumenthashes": null,
"printerdocumentid": null,
"FileHash": null,
"FileName": "sample.pdf",
"Tags": "sample, pdf",
"Description": "Sample PDF document to upload",
"Path": "multi_file_pdf/dev/05K9G*************************BJG6a/S5V14.pdf",
"PageCount": 0,
"DocSize": 0.0,
"DocType": "SingleDoc",
"LastModified": "2022-11-08 19:22:27.690697+00:00",
"CreatedDate": "2022-11-08 19:22:27.071170+00:00",
"isdeleted": false,
"isencrypted": null,
"status": "Pending",
"Weight": 0.0,
"DocumentName": "PUMA SOFT RIDE ENZO",
"DocInfo": null,
"ItemId": "PU45856AAA84po",
"Category": "test document",
"uniquedocumentid": "DPSDI-00051-00003"
},
{
"Id": 1868,
"DocumentHash": "HlrC*************************jbV",
"ShipperHash": "05K9G*************************BJG6a",
"useddocumenthashes": "Hlr********************bV",
"printerdocumentid": "",
"FileHash": "4b41a*************************a56a",
"FileName": "sample.pdf",
"Tags": "sample, pdf",
"Description": "Sample PDF document to upload",
"Path": "multi_file_pdf/dev/05K9G*************************BJG6a/H7jbV.pdf",
"PageCount": 2,
"DocSize": 2.96,
"DocType": "SingleDoc",
"LastModified": "2022-11-08 19:28:13.739444+00:00",
"CreatedDate": "2022-11-08 19:24:45.631531+00:00",
"isdeleted": false,
"isencrypted": false,
"status": "Document is ready.",
"Weight": 0.44,
"DocumentName": "PUMA SOFT RIDE ENZO",
"DocInfo": [
{
"Dimension": "8.5*11.0",
"Print2MailAcceptable": true,
"Pages": 2
}
],
"ItemId": "PU45856AAA84p1",
"Category": "test document",
"uniquedocumentid": "DPSDI-00051-00004"
},
{
"Id": 1869,
"DocumentHash": "EFcC*************************K2b",
"ShipperHash": "05K9G*************************BJG6a",
"useddocumenthashes": null,
"printerdocumentid": null,
"FileHash": null,
"FileName": "sample.pdf",
"Tags": "sample, pdf",
"Description": "Sample PDF document to upload",
"Path": "multi_file_pdf/dev/05K9G*************************BJG6a/EK2b.pdf",
"PageCount": 0,
"DocSize": 0.0,
"DocType": "SingleDoc",
"LastModified": "2022-11-08 19:32:16.130713+00:00",
"CreatedDate": "2022-11-08 19:32:15.471044+00:00",
"isdeleted": false,
"isencrypted": null,
"status": "Pending",
"Weight": 0.0,
"DocumentName": "PUMA SOFT RIDE ENZO",
"DocInfo": null,
"ItemId": "PU45856AAA 84p1",
"Category": "test document",
"uniquedocumentid": "DPSDI-00051-00005"
},
{
"Id": 1870,
"DocumentHash": "8fcb*************************mLIp",
"ShipperHash": "05K9G*************************BJG6a",
"useddocumenthashes": null,
"printerdocumentid": null,
"FileHash": null,
"FileName": "sample.pdf",
"Tags": "sample, pdf",
"Description": "Sample PDF document to upload",
"Path": "multi_file_pdf/dev/05K9G*************************BJG6a/mLIp.pdf",
"PageCount": 0,
"DocSize": 0.0,
"DocType": "SingleDoc",
"LastModified": "2022-11-08 19:32:25.191105+00:00",
"CreatedDate": "2022-11-08 19:32:24.471022+00:00",
"isdeleted": false,
"isencrypted": null,
"status": "Pending",
"Weight": 0.0,
"DocumentName": "PUMA SOFT RIDE ENZO",
"DocInfo": null,
"ItemId": null,
"Category": "test document",
"uniquedocumentid": "DPSDI-00051-00006"
},
{
"Id": 1871,
"DocumentHash": "96Ej*************************L42u",
"ShipperHash": "05K9G*************************BJG6a",
"useddocumenthashes": null,
"printerdocumentid": null,
"FileHash": null,
"FileName": "sample.pdf",
"Tags": "sample, pdf",
"Description": "Sample PDF document to upload",
"Path": "multi_file_pdf/dev/05K9G*************************BJG6a/FBL42u.pdf",
"PageCount": 0,
"DocSize": 0.0,
"DocType": "SingleDoc",
"LastModified": "2022-11-08 19:32:42.511228+00:00",
"CreatedDate": "2022-11-08 19:32:41.871770+00:00",
"isdeleted": false,
"isencrypted": null,
"status": "Pending",
"Weight": 0.0,
"DocumentName": "PUMA SOFT RIDE ENZO",
"DocInfo": null,
"ItemId": null,
"Category": "test document",
"uniquedocumentid": "DPSDI-00051-00007"
},
{
"Id": 1872,
"DocumentHash": "2Jimq*************************QUCN",
"ShipperHash": "05K9G*************************BJG6a",
"useddocumenthashes": null,
"printerdocumentid": null,
"FileHash": null,
"FileName": "sample.pdf",
"Tags": "sample, pdf",
"Description": "Sample PDF document to upload",
"Path": "multi_file_pdf/dev/05K9G*************************BJG6a/QUCN.pdf",
"PageCount": 0,
"DocSize": 0.0,
"DocType": "SingleDoc",
"LastModified": "2022-11-11 16:32:35.204489+00:00",
"CreatedDate": "2022-11-11 16:32:34.505236+00:00",
"isdeleted": false,
"isencrypted": null,
"status": "Pending",
"Weight": 0.0,
"DocumentName": "PUMA SOFT RIDE ENZO",
"DocInfo": null,
"ItemId": null,
"Category": "test document",
"uniquedocumentid": "DPSDI-00051-00008"
},
{
"Id": 1873,
"DocumentHash": "5vH********************K8hLg",
"ShipperHash": "05K9G*************************BJG6a",
"useddocumenthashes": null,
"printerdocumentid": null,
"FileHash": null,
"FileName": "sample.pdf",
"Tags": "sample_pdf, pdf_sample",
"Description": "Sample PDF document to upload",
"Path": "multi_file_pdf/dev/05K9G*************************BJG6a/K8hLg.pdf",
"PageCount": 0,
"DocSize": 0.0,
"DocType": "SingleDoc",
"LastModified": "2022-11-14 18:29:38.712241+00:00",
"CreatedDate": "2022-11-14 18:29:38.033662+00:00",
"isdeleted": false,
"isencrypted": null,
"status": "Pending",
"Weight": 0.0,
"DocumentName": "Sample_PDF_for_test",
"DocInfo": null,
"ItemId": null,
"Category": "test document",
"uniquedocumentid": "DPSDI-00051-00009"
}
]