Get all Addresses of an Address Book

You can get a list of all the addresses associated with an address book.

Note

All addresses depend on the address book, in other words, an address is the attribute of the Address Book module thus the URL route is pointing to the address book.

Please read more about AddressBook

URL Config

Endpoint: https://api-stage.dps.io/api
APIVersion: v1
route: address
path: addressbook/<YOUR_ADDRESS_BOOK_ID>

Method

GET

URL

https://api-stage.dps.io/api/v1/addressbook/<YOUR_ADDRESS_BOOK_ID>/address

Request Headers

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

Curl request

curl --location --request GET 'https://api-stage.dps.io/api/v1/addressbook/<YOUR_ADDRESS_BOOK_ID>/address' \
--header 'x-api-key: xxxxxxdfjbdjdfjdhfxxxxxxx' \
--header 'ShipperHash: 05K9****************************JG6a' \

Response

[
  {
    "AddressId": <ADDRESS ID>,
    "AddressBookId": <YOUR_ADDRESS_BOOK_ID>,
    "IsVerified": false,
    "ShipperHash": "05K9****************************JG6a",
    "CompanyName": "My Test Company 2",
    "PersonName": "John Doe",
    "AddressLine1": "12575 Placida RD",
    "AddressLine2": "Plaicda",
    "City": "Placida",
    "State": "FL",
    "Country": "US",
    "Zip": "33946",
    "Email": "test@dps.io",
    "Phone": "9729729721",
    "CreatedDate": "2022-11-10 22:34:03.568433",
    "LastModified": "2022-11-10 22:34:03.568433"
  }
]