REST API

As of version 3.8.1, Locatoraid provides a number of REST API endpoints to query, update and manage the store locations database.

This is the unique feature for tech-savvy web developers out there who are looking to further enhance Locatoraid store locator features and options. You can use these REST interfaces to connect or synchronize your store locator with other tools, services, and apps.

List locations

GET /locatoraid/v3/locations

Get the list of your current store locations.

Arguments

page
per_page
search

Examples

GET https://www.yoursite.com/wp-json/locatoraid/v3/locations

GET https://www.yoursite.com/wp-json/locatoraid/v3/locations?page=2&per_page=100

GET https://www.yoursite.com/wp-json/locatoraid/v3/locations?search=helsinki

Retrieve a location

GET /locatoraid/v3/locations/<id>

Get the details of a specific store location from your locator database.

Examples

GET https://www.yoursite.com/wp-json/locatoraid/v3/locations/<id>

Delete a location

DELETE /locatoraid/v3/locations/<id>

Delete a specific location from your store locator database.

Headers

X-WP-Locatoraid-AuthCode [required]

Examples

You can also supply the list of ids separated by hyphen (-).

DELETE https://www.yoursite.com/wp-json/locatoraid/v3/locations/123

DELETE https://www.yoursite.com/wp-json/locatoraid/v3/locations/123-234-345

Create a location

POST /locatoraid/v3/locations

Add a new store location to the location management system.

Headers

X-WP-Locatoraid-AuthCode [required]

Arguments

name
street1
street2
city
state
zip
country
phone
website
latitude
longitude

With the Pro version, the following arguments are also available (custom fields):

misc1
misc2
misc3
misc4
misc5
misc6
misc7
misc8
misc9
misc10
misc11
misc12
misc13
misc14
misc15
misc16
misc17
misc18
misc19
misc20

Examples

POST https://www.yoursite.com/wp-json/locatoraid/v3/locations

You can always get the up-to date documentation on all the available REST options by clicking the following menu in your WordPress admin area: Locatoraid, REST API.