API Reference
/
Locations Data
/
Get a list of basic business details

Uberall API (20250204)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.json
swagger.yaml
Overview
URL

https://uberall.com

Support

api@uberall.com

License

Licensed under Uberall

Languages
Servers
Mock server

https://docs.uberall.com/_mock/apis/swagger/

https://uberall.com/api/

Users

Set up - Users

Operations

Business Connections

Set up - Business Connections

Operations

Businesses

Set up - Businesses

Operations

Configuration

Set up - Configuration

Operations

Sales Partners

Set up - Tenancy - Sales Partners

Operations

Monitoring

Set up - API Status

Operations

Product Plans

Set up - Tenancy - Product Plans

Operations

Webhooks

Set up - Tenancy - Sales Partners - Webhooks

Operations

Auto Response

Products - Auto Response

Operations

Brand Data Points

Products - Brand Data Points

Operations

Dashboard

Products - Analytics - Dashboard

Operations

Dashboard Exports

Products - Analytics - Dashboard Exports

Operations

Data Points

Products - Data Points

Operations

Data Point Filters

Products - Data Points - Data Point Filters

Operations

Templates

Products - Response Library - Templates

Operations

Social Posting

Products - Social Posting

Operations

Social Posting Templates

Products - Social Posting - Social Posting Templates

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Batch Operation

Locations Hub - Locations - Batch Operations (excel)

Operations

Categories

Locations Hub - Categories

Operations

Collection Management

Locations Hub - Collections - Collection Management

Operations

Content List

Locations Hub - Collections - Content List

Operations

Locations Data

Locations Hub - Locations Data

Operations

Update a Location

Request

Make changes to a location. Any blank parameter deletes an old value, any unspecified parameter does nothing

Path
idstringrequired

The uberall unique id for the location you want to update

Bodyapplication/jsonrequired

Location object

idinteger(int64)

Output only. The uberall unique id for the location

listingsArray of objects(Listing)unique

Output only. List of this location's online listings together with their sync status

openingHoursArray of objects(OpeningHours)unique

The location's opening hours: e.g.

[ { 
    "dayOfWeek": 1,
    "closed": false,
    "from1": "08:00",
    "to1": "11:00"
  }, 
  {
    "dayOfWeek": 2,
    "closed": false,
    "from1": "08:00",
    "to1": "11:00",
    "from2": "13:00",
    "to2": "21:00"
  },
  {
    "dayOfWeek": 3,
    "closed": true
  }
]

Please note that having more than 2 time periods for each day is not possible.

Example: [{"dayOfWeek":1,"closed":false,"from1":"08:00","to1":"11:00"},{"dayOfWeek":2,"closed":false,"from1":"08:00","to1":"11:00","from2":"13:00","to2":"21:00"},{"dayOfWeek":3,"closed":true}]
specialOpeningHoursArray of objects(SpecialOpeningHours)unique

The location's special opening hours: e.g.

[ {
"date": "2017-06-29",
"closed": true
},
{
"date": "2017-06-30",
"from1": "11:00",
"to1": "14:00",
"from2": 16:00",
"to2": "20:00"
}
]

Please note that having more than 2 time periods for each day is not possible.

Example: [{"date":"2017-06-29","closed":true},{"date":"2017-06-30","from1":"11:00","to1":"14:00","from2":"16:00","to2":"20:00"}]
namestringrequired

The location's name

streetstringrequired

The location's street address

streetNostring

The location's street number

streetTypestring

Required for Spain. One of ALAMEDA, AVENIDA, CALLE, CAMINO, CARRER, CARRETERA, GLORIETA, KALEA, PASAJE, PASEO, PLACA, PLAZA, RAMBLA, RONDA, RUA, SECTOR, TRAVESERA, TRAVESIA, URBANIZACION

Enum"ALAMEDA""AVENIDA""CALLE""CAMINO""CARRER""CARRETERA""GLORIETA""KALEA""PASAJE""PASEO"
addressExtrastring

An address extra: e.g. building, floor...

Example: "building, floor, ..."
zipstring

Zip code, optional only for some countries.

citystringrequired

City

provincestring

Province. Only send when not blank

countrystringrequired

Country of the location

Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
latnumber(double)

The latitude coordinate of the location

lngnumber(double)

The longitude coordinate of the location

addressDisplayboolean

Indicates if the address should be displayed or hidden

phonestring

The location's contact phone number, a valid phone number has to be provided.

faxstring

The location fax number

cellphonestring

A contact mobile phone number

websitestring

A valid url for the location's website (use UTMs to add tracking)

emailstring

A contact email for the location

legalIdentstring

A legal identifier of the location. SIRET number in France

taxNumberstring

The tax number of the location. CIF/NIF in Spain

emailVerificationstring

The locations verification status

Enum"UNVERIFIED""VERIFIED"
descriptionShortstring

A short description - up to 200 characters, all characters must match this regexp: 

[0-9\p'{'L'}'()[] ?:;/!\,.-%\&=\r\n\t_*§²`´·"'+¡¿@°€£$]

descriptionLongstring

A long description - up to 1000 characters, all characters must match this regexp: 

[0-9\p'{'L'}'()[] ?:;/!\,.-%\&=\r\n\t_*§²³`´·"'+¡¿@°€^£$]

imprintstring

The imprint of the location

openingHoursNotesstring

Additional info about opening hours: e.g. 'We never open on bank holidays' - max. 255 characters, all characters must match this regexp: 

[0-9\p'{'L'}'()[] ?:;/!\,.-%\&\r\n\t_*§²`´·"'+¡¿@]

Example: "We never open on bank holidays"
keywordsArray of strings

Keywords describing the location's activity

labelsArray of objects(Label)unique

Labels grouping similar locations

Example: "['Campaign2018', 'EastCoast']"
brandsArray of strings

The brands offered by the location to its customers

paymentOptionsArray of stringsunique

The payment options accepted at the location (eg. cash, bank transfer, ...)

Example: ["cash","credit card","invoice"]
languagesArray of stringsunique

The language(s) in which customers can interact with the location's staff

categoriesArray of objects(Category)

Required to start location sync - A list of category IDs describing the location

statusstring

The status of the location. One of:

  • ACTIVE - will be synced and renewed
  • INACTIVE - will not be synced anymore, claims of listings will be released where possible
  • CANCELLED - will be synced, will not be renewed. Once endDate is reached, location will switch to INACTIVE
  • CLOSED - location has shut down, we'll mark listings as permanently closed or remove listings from the internet where permanently closed status is not supported
Enum"CREATED""ACTIVE""INACTIVE""CANCELLED""DELETED""CLOSED"
lastSyncStartedstring(date-time)

Output only. Date of the last sync for the location

identifierstring

The location identifier based on your internal identification system

photosArray of objects(LocationPhoto)

The location's photos

dateCreatedstring(date-time)

Output only. The date and time the location was created in our database

lastUpdatedstring(date-time)

Output only. Date of the last changes made to the location. Includes updates by users, API, location cleansing, and duplicate checks

autoSyncboolean

When autosync is set to true, information changed for the location in Uberall will automatically be syncronized to all connected listings without the need to explicitly start a sync again after it's been started once.

openingDatestring(date)

The date the location will first open. Must be formatted YYYY-MM-DD

serviceAreasArray of objects(ServiceArea)

Service areas available on the location.

callTrackingNumbersArray of objects(CallTrackingNumber)unique

Add call tracking numbers for distribution to Google, Facebook, and Bing. The call tracking numbers must be different from the location's primary phone number

utmsArray of objects(UTM)unique

UTM parameter to be appended to the location's website. Codes can be sent to Google, Facebook, and Bing.

transactionLinksArray of objects(LocationTransactionLink)unique

Links that appear on some directories for specific types of customer actions, such as food ordering, appointment setting, and booking reservations. Only available for specific business categories.

temporarilyClosedobject

Location Temporarily Closed

featuresArray of stringsunique

Output only. List of features available to the location

Items Enum"NEW_PHOTO_TYPES""ADS""ADS_READ""ADS_WRITE""ADVANCED_ANALYTICS""ADVANCED_ANALYTICS_2_0""AI_KNOWLEDGEBASE""AI_LOCALISATION""AI_LOCATION_INFORMATION""AI_SUGGESTED_REPLIES"
nameDescriptorstring

An addition to the location's name which gives specific info about the location's address (e.g. Mall level 2 OR Inside Departures). Sent only to FACEBOOK

evDataobject

EV Data

doctorComDataobject

Description of the provider

socialPostIdinteger(int64)
customFieldsArray of objects(CustomFieldsDetails)

A Map for identifying the value input for a specific custom field name on the location. Custom fields are created at the business level.


  "customFields": [
    '{'
      "name": "foo",
      "value": "bar"
    '}',
    '{'
      "name": "baz",
      "value": "qux"
    '}'
  ]
servicesArray of objects(ServiceItem)

Services offered at the location. Do not use if Content Collections is enabled. Instead use the Service Item and Collection endpoints

timeZonestring

The location's timezone

videosArray of objects(Video)

The location's videos

visibilityIndexinteger(int32)

Output only. The location's latest visibility index

activeDirectoriesCountinteger(int32)

Output only. Number of active directories

activeListingsCountinteger(int32)

Output only. Number of active listings

attributesArray of objects(AttributeWrapper)

Google attributes

businessIdinteger(int32)

ID of the business this location is linked to. Mandatory when creating a location. Sending a different ID than the current businessId when updating will lead to changing the business. This is only possible in case all connected accounts (Facebook, Google, …) are compatible.

Example: 1234
cleansingCommentstring

Cleansing comment by user, set only when cleansingStatus is INVALID_DATA. Possible Values (ADDRESS_DETAILS_VERIFIED, NAME_ADDRESS_DETAILS_UPDATED, NON_CLOSURE_CONFIRMATION,)

Enum"ADDRESS_DETAILS_VERIFIED""NAME_ADDRESS_DETAILS_UPDATED""NON_CLOSURE_CONFIRMATION"
cleansingInvalidDataReasonstring

Output only. Invalid Cleansing Reason (eg. INCOMPLETE_ADDRESS,ADDRESS_ IS_PO_BOX,ADDRESS_ DOES_NOT_EXIST, LOCATION_IS_CLOSED, INFORMATION_IS_WRONG, LOCATION_IS_MOVED, NON_LATIN_CHARACTERS_ADDRESS, OTHER). Guide on how to fix invalid data issues - http://ubr.al/fix_invalid_data

cleansingStatusstring

Output only. Current cleansing status for the location. Possible values: NOT_CLEANSED, PENDING, CLEANSED, INVALID_DATA

Enum"NOT_CLEANSED""PENDING""CLEANSED""INVALID_DATA"
contentListsArray of integers(int32)

The content list IDs (EVENTS, PRODUCTS, MENU, PEOPLE) describing the location

dataPointsinteger(int32)

Output only. Number of dataPoints (reviews, photos) left by users at this location

listingsBeingUpdatedinteger(int32)

Output only. Number of listings still being updated

listingsInSyncinteger(int32)

Output only. The number of listings in sync

mainPhotoobject

Location Photo

missingMandatoryFieldsArray of stringsunique

Output only. Compile all the fields that are currently missing but mandatory for some directories. They have to be set in the Location object, so that the Listing can be created / updated on the respective platform. List of Strings, e.g. [NAME, ZIP, PHONE]

Items Enum"NAME""NAME_DESCRIPTOR""STREET_NO""STREET""STREET_TYPE""ADDRESS_EXTRA""PROVINCE""ZIP""CITY""COUNTRY"
moreHoursArray of objects(MoreHoursResponse)unique

The location's additional service hours, such as delivery, pickup, happy hours etc. Submitted to Google. e.g.

[{
    "type": "ONLINE_SERVICE_HOURS",
    "hours": [{
        "dayOfWeek": 1,
        "from1": "09:00",
        "to1": "18:00"
    }, {
        "dayOfWeek": 2,
        "from1": "09:00",
        "to1": "13:00"
    }]
}, {
    "type": "ACCESS",
    "hours": [{
        "dayOfWeek": 1,
        "from1": "06:00",
        "to1": "20:00"
    }]
}]
profileCompletenessinteger(int32)

Output only. Number representing completeness of location data, up to 100

publishedListingsCountinteger(int32)

Output only. Number of published listings

socialProfilesArray of objects(SocialProfile)unique

The profiles of the location on social and professional networks (FACEBOOK, FOURSQUARE, INSTAGRAM, LINKEDIN, PINTEREST, TWITTER, VIMEO, XING, YOUTUBE)

curl -i -X PATCH \
  'https://docs.uberall.com/_mock/apis/swagger/locations/{id}' \
  -H 'Content-Type: application/json' \
  -H 'accessToken: YOUR_API_KEY_HERE' \
  -d '{
    "id": 0,
    "listings": [
      {
        "id": 0,
        "type": "FOURSQUARE",
        "syncStatus": "IN_SYNC",
        "claimStatus": "CLAIMABLE",
        "listingId": "string",
        "listingUrl": "string",
        "data": {},
        "lastChecked": "2019-08-24T14:15:22Z",
        "lastSuccessfulUpdate": "2019-08-24T14:15:22Z",
        "accountInfo": {},
        "connectSecret": "string",
        "connectStatus": "CONNECTED",
        "mandatoryFields": [
          "NAME"
        ],
        "status": "ACTIVE",
        "typeName": "string"
      }
    ],
    "openingHours": [
      {
        "dayOfWeek": 1,
        "closed": false,
        "from1": "08:00",
        "to1": "11:00"
      },
      {
        "dayOfWeek": 2,
        "closed": false,
        "from1": "08:00",
        "to1": "11:00",
        "from2": "13:00",
        "to2": "21:00"
      },
      {
        "dayOfWeek": 3,
        "closed": true
      }
    ],
    "specialOpeningHours": [
      {
        "date": "2017-06-29",
        "closed": true
      },
      {
        "date": "2017-06-30",
        "from1": "11:00",
        "to1": "14:00",
        "from2": "16:00",
        "to2": "20:00"
      }
    ],
    "name": "string",
    "street": "string",
    "streetNo": "string",
    "streetType": "ALAMEDA",
    "addressExtra": "building, floor, ...",
    "zip": "string",
    "city": "string",
    "province": "string",
    "country": "AF",
    "lat": 0.1,
    "lng": 0.1,
    "addressDisplay": true,
    "phone": "string",
    "fax": "string",
    "cellphone": "string",
    "website": "string",
    "email": "string",
    "legalIdent": "string",
    "taxNumber": "string",
    "emailVerification": "UNVERIFIED",
    "descriptionShort": "string",
    "descriptionLong": "string",
    "imprint": "string",
    "openingHoursNotes": "We never open on bank holidays",
    "keywords": [
      "string"
    ],
    "labels": "['\''Campaign2018'\'', '\''EastCoast'\'']",
    "brands": [
      "string"
    ],
    "paymentOptions": [
      "cash",
      "credit card",
      "invoice"
    ],
    "languages": [
      "string"
    ],
    "categories": [
      {
        "id": 0,
        "name": "string",
        "parent": {},
        "selectable": true
      }
    ],
    "status": "CREATED",
    "lastSyncStarted": "2019-08-24T14:15:22Z",
    "identifier": "string",
    "photos": [
      {
        "description": "string",
        "sourceUrl": "string",
        "identifier": "string",
        "cropOffsetX": 0,
        "cropOffsetY": 0,
        "cropWidth": 0,
        "cropHeight": 0,
        "type": "MAIN",
        "order": 0,
        "dateCreated": "2019-08-24T14:15:22Z",
        "lastUpdated": "2019-08-24T14:15:22Z",
        "url": "string"
      }
    ],
    "dateCreated": "2019-08-24T14:15:22Z",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "autoSync": true,
    "openingDate": "2019-08-24",
    "serviceAreas": [
      {
        "name": "Berlin, Deutschland",
        "placeId": "ChIJAVkDPzdOqEcRcDteW0YgIQQ"
      }
    ],
    "callTrackingNumbers": [
      {
        "number": "string",
        "type": "FOURSQUARE"
      }
    ],
    "utms": [
      {
        "parameters": "string",
        "type": "FOURSQUARE"
      }
    ],
    "transactionLinks": [
      {
        "url": "string",
        "isPreferred": true,
        "type": "APPOINTMENT"
      }
    ],
    "temporarilyClosed": {
      "temporarilyClosed": true,
      "reopenDate": "string"
    },
    "features": [
      "NEW_PHOTO_TYPES"
    ],
    "nameDescriptor": "string",
    "evData": {
      "type": "ON_STREET",
      "owner": "string",
      "operator": "string",
      "subOperator": "string",
      "timezone": "string",
      "isChargingClosed": true,
      "updateTime": "2019-08-24T14:15:22Z",
      "supplyEquipments": [
        {
          "uid": "string",
          "evseId": "string",
          "physicalReference": "string",
          "updateTime": "2019-08-24T14:15:22Z",
          "connectors": [
            {
              "identifier": "string",
              "standard": "CHADEMO",
              "format": "CABLE",
              "powerType": "AC_1_PHASE",
              "voltage": 0,
              "amperage": 0,
              "updateTime": "2019-08-24T14:15:22Z"
            }
          ],
          "parkingRestrictions": [
            "CUSTOMERS"
          ]
        }
      ]
    },
    "doctorComData": {
      "npi": "string",
      "hospitals": [
        {
          "hospitalName": "string",
          "hospitalCity": "string",
          "hospitalState": "string"
        }
      ],
      "educations": [
        {
          "educationName": "string",
          "educationType": "string",
          "startedYear": 0,
          "graduationYear": 0
        }
      ],
      "insurances": [
        {
          "companyName": "string",
          "insurancePlan": "string"
        }
      ],
      "credentials": "string",
      "university": "string",
      "hospitalAffiliations": "string",
      "insurancesAccepted": "string",
      "isProvider": true,
      "practiceName": "string",
      "providerTitle": "string",
      "providerFirstname": "string",
      "providerMiddlename": "string",
      "providerSurname": "string",
      "doctorCategories": [
        0
      ]
    },
    "socialPostId": 0,
    "customFields": [
      {
        "name": "foo",
        "value": "bar"
      }
    ],
    "services": [
      {
        "title": "string",
        "description": "string",
        "identifier": "string",
        "listName": "string",
        "price": 0,
        "currency": {},
        "category": 0,
        "country": "string",
        "googleService": "string"
      }
    ],
    "timeZone": "string",
    "videos": [
      {
        "id": 0,
        "url": "string",
        "description": "string",
        "type": "YOUTUBE"
      }
    ],
    "visibilityIndex": 0,
    "activeDirectoriesCount": 0,
    "activeListingsCount": 0,
    "attributes": [
      {
        "externalId": "string",
        "value": "string",
        "displayName": "string",
        "groupDisplayName": "string",
        "valueMetadata": [
          {
            "value": "string",
            "displayName": "string"
          }
        ],
        "valueType": "BOOL, URL, ENUM, REPEATED_ENUM"
      }
    ],
    "businessId": 1234,
    "cleansingComment": "ADDRESS_DETAILS_VERIFIED",
    "cleansingInvalidDataReason": "string",
    "cleansingStatus": "NOT_CLEANSED",
    "contentLists": [
      0
    ],
    "dataPoints": 0,
    "listingsBeingUpdated": 0,
    "listingsInSync": 0,
    "mainPhoto": {
      "description": "string",
      "sourceUrl": "string",
      "identifier": "string",
      "cropOffsetX": 0,
      "cropOffsetY": 0,
      "cropWidth": 0,
      "cropHeight": 0,
      "type": "MAIN",
      "order": 0,
      "dateCreated": "2019-08-24T14:15:22Z",
      "lastUpdated": "2019-08-24T14:15:22Z",
      "url": "string"
    },
    "missingMandatoryFields": [
      "NAME"
    ],
    "moreHours": [
      {
        "type": {
          "id": 0
        },
        "hours": [
          {
            "dayOfWeek": 1,
            "from": "08:00",
            "to": "18:00"
          }
        ]
      }
    ],
    "profileCompleteness": 0,
    "publishedListingsCount": 0,
    "socialProfiles": [
      {
        "url": "string",
        "type": "FACEBOOK"
      }
    ]
  }'

Responses

Location successfully edited

Bodyapplication/json
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

response.​locationobject

Location

Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "location": { … }
  }
}

Get a list of basic business details

Request

Get a list of basic business details containing "id" and "name", that can be viewed by the current user.

Query
querystring

Value used to filter the results. The value will be searched for in the following fields: "name", "streetAndNo", "zip", "city", "country", "identifier".

sortstring

The business property to sort by. Can be "id" or "name".

maxstring

Used for pagination. Maximum number of results per page. Default: 1000

offsetstring

Offset used for pagination. Default: 0

orderstring

Sets the sorting order. Default: "asc".

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/locations/businesses?max=string&offset=string&order=string&query=string&sort=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Successfully retrieved Businesses

Body*/*
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

Response
No content

Get the keywords for locations

Request

Get the keywords for locations

Query
locationIdsArray of strings

The location ids that should have keywords returned

businessIdsArray of strings

The business ids for the locations that should be returned

excludedLocationIdsArray of strings

List of location ids which should be excluded from keywords search

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/locations/keywords?businessIds=string&excludedLocationIds=string&locationIds=string' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

Keywords for locations successfully retrieved

Body*/*
statusstringrequired
Enum"SUCCESS""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER""WRONG_PARAMETER_TYPE"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

response.​keywordsArray of strings
Response
No content

Custom Items

Locations Hub - Collections - Custom Items

Operations

Events

Locations Hub - Collections - Events

Operations

Listings

Locations Hub - Locations - Listings

Operations

Labels

Locations Hub - Labels

Operations

Location Groups

Locations Hub - Location Groups

Operations

Menu Items

Locations Hub - Locations - Menu Items

Operations

Persons

Locations Hub - Locations - Persons

Operations

Locations Photos

Locations Hub - Locations Photos

Operations

Products

Locations Hub - Locations - Product

Operations

Service Items

Locations Hub - Locations - Service Items

Operations

Suggestions

Locations Hub - Locations - Suggestions

Operations