Skip to main content
POST
/
addresses
Create a new Address
curl --request POST \
  --url https://commerce.driv.ly/api/addresses \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "adr_2kj49d1msod2",
  "zip": "62704",
  "city": {
    "name": "Springfield",
    "state": {
      "code": "IL"
    }
  },
  "line2": "Apt 201",
  "line1": "456 Elm Street"
}'
{
  "data": {
    "id": "adr_2kj49d1msod2",
    "zip": "62704",
    "city": {
      "name": "Springfield",
      "state": {
        "code": "IL"
      }
    },
    "line2": "Apt 201",
    "line1": "456 Elm Street"
  },
  "success": true
}

Query Parameters

​
depth
integer

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

Body

application/json
​
city
object
required

Address is located in City

  • Option 1
  • City
​
zip
string
required

Address has ZIP

​
line1
string
required

Address has Address Line 1

​
id
string

Address is uniquely identified by id

​
line2
string

Address has Address Line 2

Response

Address Created

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