The Locations resource is the primary way our system stores structured information about a Business location. It is a sub-resource of "Business" and also one or multiple locations can be assigned to a Site.
Location Model
Location object
A location object contains the following fields
Example object:
{"added": "2012-12-19T15:27:59","automatic_latlon": true,"business_id": 12345,"city": "Seattle","contact_emails": ["contact@ourdomain.com","contact2@ourdomain.com"],"country": "US","country_name": "United States of America","custom_fields": {"headline_one":"Example headline one","headline_two":"Example headline two","bullet_points": ["Bullet point one","Bullet point two" ] },"description": "<p>This is a business description</p>","directions_url": "https://maps.google.com/maps/dir//...","extra_schema": {"menu":"http://www.example.com/menu","acceptsReservations":"True" },"facebook_url": "http://www.facebook.com/mypage/","formatted_address": "555 Main St, Seattle, WA 98109","geocoded": "555 Main St, Seattle, WA 98109, USA","google_places_id": "ChIJgUbEo8cfqokR5lP9_Wh_DaM","gplus_url": null,"homepage_url": "","hours": [ {"type":"primary","hours": [ [["09:00:00","17:00:00"]], [["09:00:00","17:00:00"]], [["09:00:00","17:00:00"]], [["09:00:00","17:00:00"]], [["09:00:00","17:00:00"]], [], [] ],"notes":"Open on saturday by appointment only","special_hours": [ {"hours": [],"start_date":"2020-09-07","end_date":"2020-09-07" }, {"hours": [["10:00:00","15:00:00"]],"start_date":"2020-09-11","end_date":"2020-09-14" } ] }, {"type":"secondary","hours": [ [["09:00:00","17:00:00"]], [["09:00:00","17:00:00"]], [["09:00:00","17:00:00"]], [["09:00:00","17:00:00"]], [["09:00:00","17:00:00"]], [], [] ] } }"id": 1234,"instagram_url": null,"lat": "47.65015390000000","linkedin_url": null,"location_name": "Belltown","location_url": null,"lon": "-122.37786910000000","modified": "2012-12-19T15:34:32","neighborhood": "Queen Anne","partner_location_id": "location-12345","partner_location_sub_id": "region-1","payment_forms": ["visa","mastercard","american-express"],"payment_forms_notes": null,"phonemap": {"phone":"(206) 930-7689" },"phonemap_e164": {"phone":"+12065555555" },"phones": [ {"disable_autoformat":false,"e164":"(206) 930-7689","extension":null,"id":4321,"location_id":1234,"number":"(206) 930-7689","resource_uri":"/api/v2/phones/4321/","type":"phone" } ],"pinterest_url": null,"postal_code": "98109","price_range": 3,"private_street": null,"published": true,"resource_uri": "/api/v2/locations/1234/","service_area_only": false,"service_areas": "Belltown, Downtown, South Lake Union","services_tags": ["service-one","service-two"],"state": "WA","state_name": "Washington","street": "555 Main St","street2": "Apt 555","tagline": null,"twitter_url": "https://twitter.com/mypage/","user_id": 123,"year_opened": null,"yelp_url": null,"youtube_url": null}
Phone object (phones)
A phone object contains the following fields
Hours of operation (hours)
Except for the special case formatting, this object is a list of 7 items which represent each day.
Each day can can have one-four time ranges. For example, two time ranges denotes a "lunch-break". No time ranges denotes closed.
9am-5pm [["09:00:00", "17:00:00"]]
9am-12pm and 1pm-5pm [["09:00:00", "12:00:00"], ["13:00:00", "17:00:00"]]
Our platform auto-generates location-based JSON-LD schema.org values for each location. This is embedded into any site that is published on the platform to syndicate these values to web search engines.
The extra_schema gives that ability to extend or replace the existing auto-generated schema values.
These are structured tags that can be assigned to a location. These are primarily used for filtering Location Finder results. But these tags can also be used within templates to hide and show content or build a list of applicable services.
These tags should be lowercase and can contain alphanumeric and dashes (-) characters.
"services_tags": ["service-one","service-two"]
Create a location
POST /api/v2/locations/
Required fields - Normal location
Required fields - Service area only location
List locations
List all locations for all businesses
GET/api/v2/locations/
List all locations for a particular business
GET/api/v2/locations/?business_id=12345
Parameters
Distance search
Locations can be searched and ordered by distance from a particular point or searched location (near_location) string like a postal code or city/state.
If you already have the search location (latitude and longitude), you can pass those directly into the request using near_lat and near_lon to speed up the response time and avoid an API call to geocode the search.
