GETapi.synup.com/api/v4/locations-by-store-codes
Get locations by store codes
This API retrieves location details based on specified store codes. Using unique store codes, allows businesses to fetch location-specific information such as name, address, contact details, business hours, and other relevant attributes.
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Parameters
Query
| Name | Type | Required | Description |
|---|---|---|---|
storeCodes | string | required | Array of store codes in JSON string format. |
Request
Request
curl -X GET 'https://api.synup.com/api/v4/locations-by-store-codes?storeCodes=' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json'const res = await fetch('https://api.synup.com/api/v4/locations-by-store-codes?storeCodes=', {
method: 'GET',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
});
const data = await res.json();import requests
res = requests.get(
"https://api.synup.com/api/v4/locations-by-store-codes?storeCodes=",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
)
data = res.json()req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/locations-by-store-codes?storeCodes=", nil)
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
200 | Successful response |
400 | Bad request - Invalid store codes format |
401 | Unauthorized - Invalid or missing API key |
404 | One or more store codes not found |
Example response
{
"data": {
"getLocationsByStoreCodes": [
{
"accountId": 11073,
"name": "Sample Store",
"storeId": "jio678",
"city": "Chicago",
"countryIso": "US"
}
]
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | |
data.getLocationsByStoreCodes | array of object | required | |
data.getLocationsByStoreCodes[].accountId | integer | optional | |
data.getLocationsByStoreCodes[].addOns | array of string | optional | |
data.getLocationsByStoreCodes[].additionalCategoryIds | array of string | optional | |
data.getLocationsByStoreCodes[].additionalCategoryNames | array of string | optional | |
data.getLocationsByStoreCodes[].additionalInfo | null | optional | |
data.getLocationsByStoreCodes[].additionalPhones | array of string | optional | |
data.getLocationsByStoreCodes[].approved | string | optional | |
data.getLocationsByStoreCodes[].archivalScheduledAt | null | optional | |
data.getLocationsByStoreCodes[].archived | boolean | optional | |
data.getLocationsByStoreCodes[].archivedAt | null | optional | |
data.getLocationsByStoreCodes[].bizUrl | string | optional | |
data.getLocationsByStoreCodes[].bizUrlUtm | boolean | optional | |
data.getLocationsByStoreCodes[].bookingUrl | null | optional | |
data.getLocationsByStoreCodes[].businessHours | array of string | optional | |
data.getLocationsByStoreCodes[].cancellationScheduledAt | null | optional | |
data.getLocationsByStoreCodes[].categoryId | integer | optional | |
data.getLocationsByStoreCodes[].city | string | optional | |
data.getLocationsByStoreCodes[].contentPreferredLanguage | string | optional | |
data.getLocationsByStoreCodes[].countryCode | string | optional | |
data.getLocationsByStoreCodes[].countryIso | string | optional | |
data.getLocationsByStoreCodes[].createErrors | array of string | optional | |
data.getLocationsByStoreCodes[].createdDate | string | optional | |
data.getLocationsByStoreCodes[].customAttributes | array of object | optional | |
data.getLocationsByStoreCodes[].customAttributes[].archived | boolean | required | |
data.getLocationsByStoreCodes[].customAttributes[].enumValues | array of string | required | |
data.getLocationsByStoreCodes[].customAttributes[].name | string | required | |
data.getLocationsByStoreCodes[].customAttributes[].slug | string | required | |
data.getLocationsByStoreCodes[].customAttributes[].type | string | required | |
data.getLocationsByStoreCodes[].customAttributes[].value | array of string | required | |
data.getLocationsByStoreCodes[].databaseId | integer | optional | |
data.getLocationsByStoreCodes[].description | string | optional | |
data.getLocationsByStoreCodes[].enabledSiteIds | array of string | optional | |
data.getLocationsByStoreCodes[].facebookUrl | null | optional | |
data.getLocationsByStoreCodes[].folderId | string | optional | |
data.getLocationsByStoreCodes[].folderName | string | optional | |
data.getLocationsByStoreCodes[].franchise | boolean | optional | |
data.getLocationsByStoreCodes[].googleAdsPhone | null | optional | |
data.getLocationsByStoreCodes[].googleVerificationStatus | object | optional | |
data.getLocationsByStoreCodes[].googleVerificationStatus.message | null | required | |
data.getLocationsByStoreCodes[].googleVerificationStatus.status | string | required | |
data.getLocationsByStoreCodes[].googleplusUrl | null | optional | |
data.getLocationsByStoreCodes[].hideAddress | boolean | optional | |
data.getLocationsByStoreCodes[].id | string | optional | |
data.getLocationsByStoreCodes[].instagramUrl | null | optional | |
data.getLocationsByStoreCodes[].isRestaurant | boolean | optional | |
data.getLocationsByStoreCodes[].lastUpdatedDate | string | optional | |
data.getLocationsByStoreCodes[].latitude | string | optional | |
data.getLocationsByStoreCodes[].linkedinUrl | null | optional | |
data.getLocationsByStoreCodes[].locationPhotos | array of object | optional | |
data.getLocationsByStoreCodes[].locationPhotos[].databaseId | integer | required | |
data.getLocationsByStoreCodes[].locationPhotos[].fileSize | integer | required | |
data.getLocationsByStoreCodes[].locationPhotos[].id | string | required | |
data.getLocationsByStoreCodes[].locationPhotos[].name | string | required | |
data.getLocationsByStoreCodes[].locationPhotos[].starred | boolean | required | |
data.getLocationsByStoreCodes[].locationPhotos[].thumbnailUrl | string | required | |
data.getLocationsByStoreCodes[].locationPhotos[].type | string | required | |
data.getLocationsByStoreCodes[].locationPhotos[].url | string | required | |
data.getLocationsByStoreCodes[].longitude | string | optional | |
data.getLocationsByStoreCodes[].managedServiceSiteBuckets | array of string | optional | |
data.getLocationsByStoreCodes[].managedServiceSites | array of string | optional | |
data.getLocationsByStoreCodes[].moreHours | array of string | optional | |
data.getLocationsByStoreCodes[].name | string | optional | |
data.getLocationsByStoreCodes[].offeringsUrl | null | optional | |
data.getLocationsByStoreCodes[].ownerEmail | null | optional | |
data.getLocationsByStoreCodes[].ownerName | null | optional | |
data.getLocationsByStoreCodes[].package | string | optional | |
data.getLocationsByStoreCodes[].paymentMethods | array of string | optional | |
data.getLocationsByStoreCodes[].phone | null | optional | |
data.getLocationsByStoreCodes[].pinterestUrl | null | optional | |
data.getLocationsByStoreCodes[].planId | integer | optional | |
data.getLocationsByStoreCodes[].planName | string | optional | |
data.getLocationsByStoreCodes[].postalCode | string | optional | |
data.getLocationsByStoreCodes[].publisherAttributes | array of string | optional | |
data.getLocationsByStoreCodes[].reservationUrl | null | optional | |
data.getLocationsByStoreCodes[].serviceItems | array of object | optional | |
data.getLocationsByStoreCodes[].serviceItems[].categoryId | string | required | |
data.getLocationsByStoreCodes[].serviceItems[].countryIso | null | required | |
data.getLocationsByStoreCodes[].serviceItems[].currencyCode | null | required | |
data.getLocationsByStoreCodes[].serviceItems[].description | null | required | |
data.getLocationsByStoreCodes[].serviceItems[].id | string | required | |
data.getLocationsByStoreCodes[].serviceItems[].languageCode | null | required | |
data.getLocationsByStoreCodes[].serviceItems[].name | string | required | |
data.getLocationsByStoreCodes[].serviceItems[].price | null | required | |
data.getLocationsByStoreCodes[].stateIso | string | optional | |
data.getLocationsByStoreCodes[].stateName | string | optional | |
data.getLocationsByStoreCodes[].storeId | string | optional | |
data.getLocationsByStoreCodes[].street | null | optional | |
data.getLocationsByStoreCodes[].street1 | null | optional | |
data.getLocationsByStoreCodes[].subCategoryId | integer | optional | |
data.getLocationsByStoreCodes[].subCategoryName | string | optional | |
data.getLocationsByStoreCodes[].tagline | null | optional | |
data.getLocationsByStoreCodes[].tags | array of string | optional | |
data.getLocationsByStoreCodes[].temporarilyClosed | boolean | optional | |
data.getLocationsByStoreCodes[].tiktokUrl | null | optional | |
data.getLocationsByStoreCodes[].toplineMessage | null | optional | |
data.getLocationsByStoreCodes[].toplineMessageText | null | optional | |
data.getLocationsByStoreCodes[].twitterUrl | null | optional | |
data.getLocationsByStoreCodes[].uid | string | optional | |
data.getLocationsByStoreCodes[].updatedAt | string | optional | |
data.getLocationsByStoreCodes[].videos | array of string | optional | |
data.getLocationsByStoreCodes[].voiceStatus | integer | optional | |
data.getLocationsByStoreCodes[].yearOfIncorporation | null | optional | |
data.getLocationsByStoreCodes[].youtubeUrl | null | optional |