Get Locations

GET v2/locations/search

Location search by placeId, address or location through URL querying.

** Note ** Invalid filters will not return an error, it will return an empty array of results.

Examples

GET https://api.test.archer-app.com/v2/locations/search?placeId=ChIJzUvMdeN16IkROWnyTWMR8C0

GET https://api.test.archer-app.com/v2/locations/search?address=869%20Washington%20Blvd,%20Montebello

GET http://api.test.archer-app.com/v2/locations/search?location=logist&zip=90000

Body Object

None

Example Body

None


Response

Returns an array of Location objects.

Response Properties

Name
Type
Description

id

int

Location ID.

name

string

Location name.

contact

string

Contact at location.

phone

string

Location phone number.

ltlAccessorials

string array

Array of LTL accessorial objects

tlAccessorials

string array

Array of TL accessorial objects

formattedAddress

string

Formatted address.

line1

string

Address line 1.

line2

string

Address line 2.

city

string

City.

state

string

State.

zip

string

Zipcode.

country

string

Country.

latitude

float

The latitude of the Location.

longitude

float

The longitude of the Location.

timezone

string

The timezone of Location.

verified

bool

Verification status of this Location.

placeId

string

Unique Id for this location.

Example Response

[
  {
    "id": 100000,
    "name": "Company Alpha",
    "contact": "Jane",
    "phone": "222-333-5555",
    "accessorials": {
      "ltlAccessorials": [],
      "tlAccessorials": []
    },
    "address": {
      "formattedAddress": "5555 Indian River Road, Orange, CT, United States",
      "line1": "5555 Indian River Rd",
      "line2": "",
      "city": "Orange",
      "state": "CT",
      "zip": "0600",
      "country": "",
      "latitude": 51.2662,
      "longitude": -12.998,
      "timezone": "America/New_York",
      "verified": true,
      "placeId": "ChIJzUvMasdfN16IkROWnyTWMR8C0"
    }
  }
]


Last updated