Store Locator

This route register the webhook URL of client’s site. Each time, location has some update (except update via api by user with ROLE_STORE_LOCATOR), LOCALTRAC will send POST request to provided URL, sending “secret” parameter equals md5(“webhookSalt”). LOCALTRAC doesn’t send changed fields or the list of changed locations. It’s just a signal that some location(s) was updated. You may use GET “store-locator/locations” route and compare “lastUpdated” to know what location was updated.

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Body (Example)

businessUuid

Uuid of the business to register webhook. Store locator should be enabled for this business.

webhookUrl

URL on clients server/website to be called when location is updated.

webhookSalt

Random string that would be md5 encoded and passed with POST as “secret” parameter.

Headers

Content-Type

application/json

Body

This scenario happens if you sent any content who fails the minimum validation process. For instance, failing to provide businessUuid will lead to the following result

Headers

Content-Type

application/json

Body

Content-Type

application/json

Body

This route will return the list locations for provided business, including all information about location.

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Headers

Content-Type

application/json

Body

data

Array of locations

data[0].uuid

LOCALTRAC unique identifier (uuid) of the location. This is the uuid you should use for any further request associated with the location.

data[0].active

Boolean value representing the status of the location, true for active and false for inactive. When a location is set as inactive, it is not monitored within any directories.

data[0].lastUpdated

Timestamp of the last update on any location’s field

data[0].urls

An associative array for websites and social media URLs.

Supported keys:

• website: Main website of the company or location

• facebook

• twitter

• linkedin

• instagram

• youtube

• pinterest

• tripadvisor

data[0].payments

An associative array of payment methods. The value is a Boolean, true when payment method is accepted or false when it’s not.

Supported keys:

• cash

• interact

• visa

• mastercard

• americanExpress

• paypass

data[0].name

Array of all the location name translations. Each row of the sub array is an associative value of <language> : <name>.

Keep in mind, this route returns “store locator name” if it’s not empty. If it’s empty, it returns general “name” of location.

data[0].description

Array of all the location descriptions. Each row of the sub array is an associative value of <language> : <description>.

data[0].communication

An associative array for the location contact information.

Supported keys:

• contactEmail: primary email address

• primaryPhone: primary phone

• secondaryPhones: An array of alternative phones. Please note that we currently only accept 2 secondary phones due to directory restrictions

• fax: fax number

data[0].storeCode

External id given by the client when the location was created or when imported in LOCALTRAC from a directory.

data[0].locale

Locale of the location. (specified upon creation and used with different directories).

data[0].address

Array containing the full address.

Keep in mind, this route returns “store locator address line 1/2” if it’s not empty. If it’s empty, it returns general “address” of location.

data[0].storeLocator

An associative array for the location store locator related information.

Supported keys:

• tags: array of location’s tags

• categories: array of location’s categories

• images: An array of store locator images.

data[0].schedules

Array of the location’s regular opening hours.

data[0].scheduleExceptions

Array of the location’s schedule exceptions

data[0].averageRating

Average Google rating for the current year for this location.

Headers

Content-Type

application/json

Body

This route will return the list of Store Locator tags, associated to business

Authorization

<token> obtained during the Authentication

Accept

application/json

Content-Type

application/json

uuid

LOCALTRAC unique identifier (uuid) of the tag. This is the uuid you should use for any further request to update tag.

translations

An array of translations of the name of the tag. For the moment only “en” and “fr” languages are supported. Languages are optional (tag can have only one language).

translations.en

English translation of the name

translations.fr

French translation of the name

slug

An array of slug for the translations of the name of the tag. (automatically generated on insert/update of the tag).

slug.en

Slug for English translation

slug.fr

Slug for French translation

Content-Type

application/json

This route will set the list of Store Locator tags, associated to business. (It will clear all the previous data and save the provided list)

Authorization

<token> obtained during the Authentication

Accept

application/json

tags

Array of tags to save

tags[0].uuid (optional)

Uuid of the tag, received from GET route. If provided, tag will be updated (translations will change, uuid stays the same).

tags[0].translations

Array of translations of the tag. Only “en” and “fr” are supported now.

tags[0].translations.en (optional)

English translation of the name

tags[0].translations.fr (optional)

French translation of the name

Content-Type

application/json

Content-Type

application/json

Content-Type

application/json

Content-Type

application/json

This route will add tag to business and associate it to location (if provided).

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Body (Example)

locationUuid (optional)

Uuid of location. Newly created tag will be associated to provided location.

translations

Array of translations of the tag. Only “en” and “fr” are supported now.

translations.en (optional)

English translation of the name

translations.fr (optional)

French translation of the name

Headers

Content-Type

application/json

Body

uuid

LOCALTRAC unique identifier (uuid) of the tag. This is the uuid you should use for any further request to update tag or associate it to locations.

Headers

Content-Type

application/json

Body

Content-Type

application/json

Body

This route will return the list of Store Locator tags, associated to location

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Headers

Content-Type

application/json

Body

uuid

LOCALTRAC unique identifier (uuid) of the tag. This is the uuid you should use for any further request to update tag.

translations

An array of translations of the name of the tag. For the moment only “en” and “fr” languages are supported. Languages are optional (tag can have only one language).

translations.en

English translation of the name

translations.fr

French translation of the name

slug

An array of slug for the translations of the name of the tag. (automatically generated on insert/update of the tag).

slug.en

Slug for English translation

slug.fr

Slug for French translation

Headers

Content-Type

application/json

Body

This route will set the list of Store Locator tags, associated to location. (It will clear all the previous data and save the provided list)

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Body (Example)

tags

Array of tags to associate to location

tags[0].uuid

Uuid of the tag, to associate.

Content-Type

application/json

Headers

Content-Type

application/json

Body

Headers

Content-Type

application/json

Body

Content-Type

application/json

Body

This route will return the list of Store Locator categories, associated to business

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Headers

Content-Type

application/json

Body

uuid

LOCALTRAC unique identifier (uuid) of the category. This is the uuid you should use for any further request to update category.

translations

An array of translations of the name of the category. For the moment only “en” and “fr” languages are supported. Languages are optional (category can have only one language).

translations.en

English translation of the name

translations.fr

French translation of the name

slug

An array of slug for the translations of the name of the category. (automatically generated on insert/update of the category).

slug.en

Slug for English translation

slug.fr

Slug for French translation

Headers

Content-Type

application/json

Body

This route will set the list of Store Locator categories, associated to business. (It will clear all the previous data and save the provided list)

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Body (Example)

categories

Array of categories to save

categories[0].uuid (optional)

Uuid of the category, received from GET route. If provided, category will be updated (translations will change, uuid stays the same).

categories[0].translations

Array of translations of the category. Only “en” and “fr” are supported now.

categories[0].translations.en (optional)

English translation of the name

categories[0].translations.fr (optional)

French translation of the name

Headers

Content-Type

application/json

Body

Headers

Content-Type

application/json

Body

Headers

Content-Type

application/json

Body

Content-Type

application/json

Body

This route will add category to business and associate it to location (if provided).

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Body (Example)

locationUuid (optional)

Uuid of location. Newly created category will be associated to provided location.

translations

Array of translations of the categories. Only “en” and “fr” are supported now.

translations.en (optional)

English translation of the name

translations.fr (optional)

French translation of the name

Headers

Content-Type

application/json

Body

uuid

LOCALTRAC unique identifier (uuid) of the category. This is the uuid you should use for any further request to update category or associate it to locations.

This scenario happens if you sent any content who fails the minimum validation process. For instance, failing to provide translations will lead to the following result

Headers

Content-Type

application/json

Body

This scenario happens if you sent non-existing businessUuid or locationUuid

Content-Type

application/json

Body

This route will return the list of Store Locator categories, associated to location

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Headers

Content-Type

application/json

Body

uuid

LOCALTRAC unique identifier (uuid) of the category. This is the uuid you should use for any further request to update category or associate it to locations.

translations

An array of translations of the name of the category. For the moment only “en” and “fr” languages are supported. Languages are optional (category can have only one language).

translations.en

English translation of the name

translations.fr

French translation of the name

slug

An array of slug for the translations of the name of the category. (automatically generated on insert/update of the category).

slug.en

Slug for English translation

slug.fr

Slug for French translation

Headers

Content-Type

application/json

Body

This route will set the list of Store Locator categories, associated to location. (It will clear all the previous data and save the provided list)

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Body (Example)

categories

Array of categories associate to location

categories[0].uuid

Uuid of the category, to associate.

Headers

Content-Type

application/json

Body

Headers

Content-Type

application/json

Body

Headers

Content-Type

application/json

Body

Content-Type

application/json

Body

This route will return the list of Store Locator images, associated to location

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Headers

Content-Type

application/json

Body

uuid

LOCALTRAC unique identifier (uuid) of the store locator image for this location.

url

Url to original image

thumbnail

Url to resized image (95x95 thumbnail).

mime

Image mime type

description

Image description

createdAt

Timestamp

Headers

Content-Type

application/json

Body

This route will assign an image to location as store locator image

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Body (Example)

image_uuid

Uuid of image

location_uuid

Uuid of location

description

Image description

Headers

Content-Type

application/json

Body

uuid

LOCALTRAC unique identifier (uuid) of the store locator image.

url

Url to original image

thumbnail

Url to resized image (95x95 thumbnail).

Headers

Content-Type

application/json

Body

Content-Type

application/json

Body

This route will delete store locator image.

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Headers

Content-Type

application/json

Body

Content-Type

application/json

Body

This route will return the list of Store Locator fields, associated to location. For the moment, only “externalId” is supported as a custom field.

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Headers

Content-Type

application/json

Body

Headers

Content-Type

application/json

Body