Skip to main content
GET
/
addresses
/
{id}
Retrieve an Address
curl --request GET \
  --url https://commerce.driv.ly/api/addresses/{id}
{
  "data": {
    "id": "<string>",
    "city": {
      "state": "<string>",
      "name": "<string>"
    },
    "zip": "<string>",
    "line1": "<string>",
    "line2": "<string>"
  },
  "success": true
}

Path Parameters

​
id
string
required

Address is uniquely identified by id

Query Parameters

​
depth
integer

The number of levels of related objects to include in the response

Response

Address Found

​
data
Address · object
Example:
{
  "id": "adr_2kj49d1msod2",
  "zip": "62704",
  "city": {
    "name": "Springfield",
    "state": { "code": "IL" }
  },
  "line2": "Apt 201",
  "line1": "456 Elm Street"
}
​
success
boolean