Skip to main content

Get Address Book

This object is used to get the address book with the help of the shipper hash or address book id.

URL Config
Endpoint: https://api.dps.io/api
APIVersion: v1
route: addressbook
path: <YOUR_SHIPPER_HASH>/<YOUR_ADDRESS_BOOK_ID>
Method
GET
URL
https://api.dps.io/api/v1/addressbook
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/addressbook/05K9****************************JG6a/199' \
--header 'x-api-key: xxxxxxdfjbdjdfjdhfxxxxxxx' \
--header 'ShipperHash: 05K9****************************JG6a' \
--data-raw ''
Response
[
    {
        "Id": 199,
        "ShipperHash": "05K9****************************JG6a",
        "Name": "My First address Book",
        "Description": "This is a Test Address book description",
        "Tags": "TagsTagsTags",
        "CreatedDate": "2022-11-10 21:17:37.118692",
        "LastModified": "2022-11-10 21:17:37.118692"
    }
]