Skip to main content
GET
/
addresses
/
{id}
Get a single Address by its id
curl --request GET \
  --url https://commerce.driv.ly/api/addresses/{id} \
  --header 'Authorization: <api-key>'
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "name": "<string>",
  "street": "<string>",
  "suite": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "country": "<string>",
  "deals": [
    123
  ],
  "tenants": 123,
  "customer": [
    123
  ],
  "contact": [
    123
  ]
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { addresses } from '@drivly/commerce'

const sdk = new SDK(...)

const addresses = await sdk.addresses.findOne(addressesId: string): Promise<addresses>

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string
required

id of the Address

Query Parameters

​
depth
number

number of levels to automatically populate relationships and uploads

​
locale
string

retrieves document(s) in a specific locale

​
fallback-locale
string

specifies a fallback locale if no locale value exists

​
sort
string

sort by field

​
where
Where clause · object

pass a where query to constrain returned documents (complex type, see documentation)

Example:
{
  "or": [
    { "color": { "equals": "mint" } },
    {
      "and": [
        { "color": { "equals": "white" } },
        { "featured": { "equals": false } }
      ]
    }
  ]
}
​
limit
number

limit the returned documents to a certain number

​
page
number

get a specific page of documents

Response

ok

​
updatedAt
string
required
​
createdAt
string
required
​
name
string | null
​
street
string | null
​
suite
string | null
​
city
string | null
​
state
string | null
​
zip
string | null
​
country
string | null
​
deals
(number | Deal · object)[] | null
​
tenants
​
customer
(number | Customer · object)[] | null
​
contact
(number | Contact · object)[] | null