Get location details

API Reference/

Request

Get details for a specific location within the store finder

Path

storeKeystringrequired

Your store finder key

idstringrequired

The location id, identifier or a custom slug

Query

languagestring

The language the location data should be returned in (only applicable if location translation feature is enabled)

Example:language=en

countryArray of strings

Countries to filter for

customFieldsboolean

Should customFields be included in the response

identifierboolean

When true id is the location identifier otherwise its id

reviewRatingsArray of strings

Review ratings to include in the detailed response

Items Enum:"1""2""3""4""5"

slugstring

If a slug was provided as ID which customField should we match it for

fieldMaskArray of strings

The list of fields the response object should contain, in the following format: "fieldMask=name&fieldMask=id"

curl -i -X GET \
  'https://uberall.com/api/store-finders/{storeKey}/locations/{id}?language=en&country=string&customFields=true&identifier=true&reviewRatings=1&slug=string&fieldMask=string'

Responses

Success

Bodyapplication/json

statusstringrequired

Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"

messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

This is a response object that is being used in storefinder calls

Response

{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "addressExtra": "building, floor, etc.",
    "averageRating": 0.1,
    "brands": [ … ],
    "businessId": 0,
    "businessName": "string",
    "businessIdentifier": "string",
    "callToActions": "callToActions: [{ text: 'cta_text1', url: 'cta_url1' }, { text: 'cta_text2', url: 'cta_url2' }]",
    "categories": [ … ],
    "cellphone": "string",
    "city": "string",
    "country": "AF",
    "customItems": [ … ],
    "descriptionLong": "string",
    "descriptionShort": "string",
    "email": "string",
    "events": [ … ],
    "fax": "string",
    "id": 0,
    "identifier": "string",
    "imprint": "string",
    "keywords": [ … ],
    "languages": [ … ],
    "lat": 0.1,
    "lng": 0.1,
    "menus": [ … ],
    "name": "string",
    "nextOpen": { … },
    "openingHours": [ … ],
    "openingHoursNotes": "string",
    "specialOpeningHours": [ … ],
    "openNow": true,
    "paymentOptions": "cash, bank transfer, ...",
    "people": [ … ],
    "faqs": [ … ],
    "phone": "string",
    "photos": [ … ],
    "products": [ … ],
    "province": "string",
    "reviewCount": 0,
    "reviews": [ … ],
    "services": "'catering' for a restaurant",
    "socialProfiles": [ … ],
    "socialPost": {},
    "streetAndNumber": "string",
    "taxNumber": "string",
    "timezone": "string",
    "videos": [ … ],
    "zip": "string",
    "website": "string",
    "googlePlaceId": "string",
    "street": "string",
    "streetNo": "string"
  }
}