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
}

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

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

Show child attributes

data.id

string

required

Address is uniquely identified by id

data.city

object

required

Address is located in City

Option 1
City

Show child attributes

data.city.state

required

data.city.name

string

required

data.zip

string

required

Address has ZIP

data.line1

string

required

Address has Address Line 1

data.line2

string

Address has Address Line 2

success

boolean

Create a new Address Update an existing Address

⌘I

Services

Guides

API Reference

Retrieve an Address

Path Parameters

Query Parameters

Response