Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Customer address and search criteria

customer_address
object
required
max_distance
number<float>
default:5
required

Maximum distance in miles to search for locations

Response

List of nearby locations ordered by distance

code
string

Response status code

locations
object[]

Array of nearby locations ordered by distance (ascending)