Instructions

...

GET {url}/localtrac/location/<location_uuid>

This route returns all location “Information” fields, with the exception of schedule related information.

Request

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Response (200) - Success

Headers

Content-type

application/json

Cache-Control

no-cache,private

Body (Example)

This example is a fake location generated by our test system.

Bloc de code

language	json

{
  "uuid": "b11f9a4b-2b50-3e65-ae90-42fcef743ace",
  "storeCode": "GV86170S47S60498U6YSU595",
  "name": {
    "en_CA": "D'Amore, Deckow and Kozey #540",
    "fr_CA": "D'Amore, Deckow and Kozey #540"
  },
  "address": {
    "address1": "77421 Route Sylvie, St-Augustin-des-Pins, ON T1T 7R3",
    "address2": "",
    "city": "Saint-Manon-du-Ha! Ha!",
    "state": "ON",
    "country": "CA",
    "zipcode": "H5M9T4",
    "lat": "-69.56438",
    "long": "-68.360965"
  },
  "description": {
    "fr_CA": "Eligendi ducimus sit totam aperiam ex est aliquid ut. Suscipit sit sint necessitatibus totam sequi. Et hic fugit dolore voluptas. Deleniti assumenda sunt sed maiores sunt distinctio.",
    "en_CA": "Iste qui quia expedita sed. Ipsam quis fuga ex occaecati. Est reiciendis est neque corporis quia."
  },
  "communication": {
    "contactEmail": "mueller.tianna@wunsch.info",
    "primaryPhone": "(810) 594-0448",
    "secondaryPhones": [
      "(810) 555-5215"
    ],
    "fax": ""
  },
  "urls": {
    "website": "http:\/\/www.herman.com\/molestiae-illo-quia-hic-ducimus\/D%27Amore%2C+Deckow+and+Kozey+%23540",
    "facebook": "https:\/\/www.facebook.com\/754553701341",
    "twitter": "https:\/\/twitter.com\/909074187486",
    "linkedin": "https:\/\/www.linkedin.com\/181822059751",
    "instagram": "https:\/\/www.instagram.com\/myloftssalonstudios\/306493669050",
    "youtube": "https:\/\/www.youtube.com\/channel\/302619054339",
    "pinterest": "https:\/\/www.pinterest.ca\/piscinestrevi\/37867198515",
    "tripadvisor": "https:\/\/www.tripadvisor.ca\/893155122501"
  },
  "payments": {
    "cash": true,
    "interact": true,
    "visa": true,
    "mastercard": false,
    "americanExpress": true,
    "paypass": true
  },
  "active": true,
  "businessKeywords": [
    {
      "keyword": "veni"
    },
    {
      "keyword": "vidi"
    },
    {
      "keyword": "vici"
    }
  ],
  "keywords": [
    {
      "keyword": "superKeyword!!!"
    },
    {
      "keyword": "Royal victoria"
    }
  ]
}

uuid

LOCALTRAC unique identifier (uuid) of the location. This is the uuid you should use for any further request that requires a <location_uuid> within the url.

storecode

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

name

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

We currently only support <locale> fr_CA and en_CA.

address

Array containing the full address.

description

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

We currently only support <locale> fr_CA and en_CA.

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

urls

An associative array for websites and social media URLs.

Supported keys:

website: Main website of the company or location

facebook

twitter

We support lot of different phone formats, with or without country code. You can set anything with () and - until the total number of numbers do not exceed 20 characters.

So, the following formats are accepted:

514 444-22-11
(514) 444 22-11
(514-)()4442211
1(514) 444-22-11
+1(514) 444-22-11
…etc.

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

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

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.

businessKeywords

An array of keywords, associated to business

keywords

An array of keywords, associated to loaction

Response (403) - Forbidden access

Headers

Content-type

application/json

Cache-Control

no-cache,private

Body

Bloc de code

language	json

{
  "message": "You do not have the required permission to obtain this resource: location(<(string) uuid of the location>)"
}

...

POST {url}/localtrac/location/<location_uuid>

A POST on this route indicates that you want to update the location fields.

Each sub key (name, address, description, communication, urls, …) can be updated individually. Any sub key not provided will be ignored and will remain unchanged.

Request

Headers

Authorization

<token> obtained during the Authentication

Accept

application/json

Content-Type

application/json

Body (Example)

This example is a fake location generated by our test system.

Bloc de code

language	json

{
  "name": {
    "en_CA": "D'Amore, Deckow and Kozey #540",
    "fr_CA": "D'Amore, Deckow and Kozey #540"
  },
  "address": {
    "address1": "77421 Route Sylvie, St-Augustin-des-Pins, ON T1T 7R3",
    "address2": "",
    "city": "Saint-Manon-du-Ha! Ha!",
    "state": "ON",
    "country": "CA",
    "zipcode": "H5M9T4",
    "lat": "-69.56438",
    "long": "-68.360965"
  },
  "description": {
    "fr_CA": "Eligendi ducimus sit totam aperiam ex est aliquid ut. Suscipit sit sint necessitatibus totam sequi. Et hic fugit dolore voluptas. Deleniti assumenda sunt sed maiores sunt distinctio.",
    "en_CA": "Iste qui quia expedita sed. Ipsam quis fuga ex occaecati. Est reiciendis est neque corporis quia."
  },
  "communication": {
    "contactEmail": "mueller.tianna@wunsch.info",
    "primaryPhone": "(810) 594-0448",
    "secondaryPhones": [
      "(810) 555-5215"
    ],
    "fax": "(111) 111-1111"
  },
  "urls": {
    "website": "http:\/\/www.herman.com\/molestiae-illo-quia-hic-ducimus\/D%27Amore%2C+Deckow+and+Kozey+%23540",
    "facebook": "https:\/\/www.facebook.com\/754553701341",
    "twitter": "https:\/\/twitter.com\/909074187486",
    "linkedin": "https:\/\/www.linkedin.com\/181822059751",
    "instagram": "https:\/\/www.instagram.com\/myloftssalonstudios\/306493669050",
    "youtube": "https:\/\/www.youtube.com\/channel\/302619054339",
    "pinterest": "https:\/\/www.pinterest.ca\/piscinestrevi\/37867198515",
    "tripadvisor": "https:\/\/www.tripadvisor.ca\/893155122501"
  },
  "payments": {
    "cash": true,
    "interact": true,
    "visa": true,
    "mastercard": false,
    "americanExpress": true,
    "paypass": true
  },
  "schedules": {
    "sunday": [
      {
        "start": null,
        "end": null
      }
    ],
    "monday": [
      {
        "start": "02:00",
        "end": "23:00"
      }
    ],
    "tuesday": [
      {
        "start": "02:00",
        "end": "23:59"
      }
    ],
    "wednesday": [],
    "thursday": [],
    "friday": [
      {
        "start": "08:00",
        "end": "23:00"
      }
    ],
    "saturday": [
      {
        "start": "08:00",
        "end": "23:00"
      }
    ]
  },
  "storeLocatorFields": {
    "externalId": "some_external_id"
  },
  "storeLocatorName": {
    "name": {
		"en": "english name 1",
		"fr": "quebec name"
	}
  },
  "storeLocatorAddress": {
    "address": {
		"en": "first line of english address",
		"fr": "rue Address 1"
	},
	"address1": {
		"en": "second line of english address",
		"fr": "rue Address 2"
	}
  }

}

name (optionnal)

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

We currently only support <locale> fr_CA and en_CA.

address (optionnal)

Array containing the full address.

description (optionnal)

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

We currently only support <locale> fr_CA and en_CA.

communication (optionnal)

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
faxefax: fax number

We support lot of different phone formats, with or without country code. You can set anything with () and - until the total number of numbers do not exceed 20 characters.

So, the following formats are accepted:

514 444-22-11
(514) 444 22-11
(514-)()4442211
1(514) 444-22-11
+1(514) 444-22-11
…etc.

urls (optionnal)

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

payments (optionnal)

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

Schedules (optionnal)

An associative array where each key is one day of the week. The value of each key is a range of opening hours with “start” and “end” key for each period within a day. The sub array allows multiple values since a day can be opened and closed multiple times per day.

If there is no key provided for a specific day of week, this means there won’t be any action performed (data in LOCALTRAC will remain unchanged)
If nothing is provide for a day, this means the day is closed
Bloc de code
"sunday": [],
If array with “start: null” and “end: null” is provided, this means the day is closed
Bloc de code
"sunday": [ { "start": null, "end": null } ],

If “start: HH:ii” and “end: HH:ii” is provided, this interval will be considered open. Multiple interval can be provided.

Bloc de code
"sunday": [ { "start": "08:00", "end": "12:00" }, { "start": "13:00", "end": "23:00" } ],

storeLocatorFields

Array of custom store locator fields. For the moment, only “externalId” key is supported. You can use this field to store any data, associated to location.

storeLocatorName

Array of custom translations of the location’s name, used by store locator

storeLocatorAddress

Array of custom translations of the locations’s address line.

Response (200) - Success

Headers

Content-type

application/json

Cache-Control

no-cache,private

Body

Bloc de code

language	json

{
  "name": "Name updated",
  "address": "Address updated",
  "description": "Description updated",
  "communication": "Communication updated",
  "urls": "Urls updated",
  "payments": "Payments updated"
}

Response (400) - Validation Error

This scenario happens if you sent any content who fails the minimum validation process. For instance, providing a wrong zip code would lead to the following result

Headers

Content-type

application/json

Cache-Control

no-cache,private

Body

Bloc de code

language	json

{
  "message": "Provided data contains error(s). See each entry in [errors]",
  "errors": {
    "address.zipcode": "This value is not valid."
  }
}

message

Always the same error message, indicating that an error happened during the validation process

errors

An associative array where the key represents the logical path to the data in error and the value represents the error found with the given data.

If a key contains “.” character, this means nested array. In the case of an array without keys, the logical number would be taken (ex: communication.secondaryPhones.1 would represent the first entry provided in secondaryPhones)

Response (403) - Forbidden access

Headers

Content-type

application/json

Cache-Control

no-cache,private

Body

Bloc de code

language	json

{
  "message": "You do not have the required permission to obtain this resource: location(<(string) uuid of the location>)"
}

...

Version	Ancienne version 10	Nouvelle version 11
Modifications effectuées par	Iaroslav Sheveliuk (Unlicensed)	Melissa Cote
Sauvegardée le	févr. 14, 2022	mai 09, 2022

Comparaison des versions

Légende

Instructions

GET {url}/localtrac/location/<location_uuid>

Request

Response (200) - Success

Response (403) - Forbidden access

POST {url}/localtrac/location/<location_uuid>

Request

Response (200) - Success

Response (400) - Validation Error

Response (403) - Forbidden access

Content Comparison

Comparaison des versions

Légende

GET {url}/localtrac/location/<location_uuid>

Request

Response (200) - Success

Response (403) - Forbidden access

POST {url}/localtrac/location/<location_uuid>

Request

Response (200) - Success

Response (400) - Validation Error

Response (403) - Forbidden access