Skip to content
API Reference/
/
Delete Several Locations

Uberall API (20260101)

Enhance your application with Uberall's comprehensive API documentation

Download OpenAPI description
swagger.yaml
Overview
URL
https://uberall.com
Support
api@uberall.com
License
Licensed under Uberall
Languages
Servers
https://uberall.com/api
Mock Server
https://docs.uberall.com/_mock/apis/swagger

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 Point Filters

Products - Data Points - Data Point Filters

Operations

Data Points

Products - Data Points

Operations

Digital Asset Management

Products - Digital Asset Management

Operations

Near Me Check

Products - Near Me Check

Operations

Social AI Service

Products - Social AI Service

Operations

Social Posting

Products - Social Posting

Operations

Status Check

Products - Status Check

Operations

Store Finder

Products - Store Finder

Operations

Templates

Products - Response Library - Templates

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

Create a Location

Request

Create a location and add it to an existing business

Security
X-API-KEY or Authorization
Bodyapplication/jsonrequired

Location object

idinteger(int64)

Output only. The uberall unique id for the location

openingHoursArray of objectsunique

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 or nullunique

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"}]
namestring[ 1 .. 128 ] charactersrequired

The location's name

streetstring[ 1 .. 191 ] charactersrequired

The location's street address

streetNostring or null<= 255 characters

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 or null[ 1 .. 64 ] characters

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

Example: "building, floor, ..."
zipstring or null[ 1 .. 32 ] characters

Zip code, optional only for some countries.

citystring[ 1 .. 64 ] charactersrequired

City

provincestring or null[ 1 .. 255 ] characters

Province. Only send when not blank

countrystringrequired

Country of the location

Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
Example: "DE"
latnumber or null(double)[ -90 .. 90 ]

The latitude coordinate of the location

lngnumber or null(double)[ -180 .. 180 ]

The longitude coordinate of the location

addressDisplayboolean

Indicates if the address should be displayed or hidden

normalizationStatusstring
Enum"NOT_NORMALIZED""NORMALIZED""NORMALIZATION_SKIPPED""NORMALIZATION_FAILED"
phonestring or nullnon-empty

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

Example: "+4912345678"
faxstring or nullnon-empty

The location fax number

Example: "+4912345678"
cellphonestring or null[ 1 .. 64 ] characters

A contact mobile phone number

Example: "+4912345678"
websitestring or null[ 1 .. 350 ] characters

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

emailstring or null[ 1 .. 255 ] characters

A contact email for the location

legalIdentstring or null[ 1 .. 512 ] characters

A legal identifier of the location. SIRET number in France

taxNumberstring or null[ 1 .. 255 ] characters

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

emailVerificationstring or null

The locations verification status

Enum"UNVERIFIED""VERIFIED"
descriptionShortstring or null<= 200 characters[0-9\\p{L}\\(\\)\\[\\] \\?:;\\/!\\\\,\\.\\-%\...

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

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

descriptionLongstring or null<= 1000 characters[0-9\\p{L}\\(\\)\\[\\] \\?:;\\/!\\\\,\\.\\-%\...

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

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

imprintstring or null<= 20000 characters

The imprint of the location

openingHoursNotesstring or null<= 255 characters[0-9\\p{L}\\(\\)\\[\\] \\?:;\\/!\\\\,\\.\\-%\...

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 or nullunique

Keywords describing the location's activity

callToActionsArray of objects or null

Calls to action available for the location

labelsArray of objects or nullunique

Labels grouping similar locations

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

The brands offered by the location to its customers

paymentOptionsArray of strings or nullunique

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

Example: ["cash","credit card","invoice"]
languagesArray of strings or nullunique

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

categoriesArray of integers(int64)<= 10 items

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

statusstringrequired

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"
firstSyncStartedstring or null(date-time)

Output only. Date and time when the first sync was started for the location

lastSyncStartedstring or null(date-time)

Output only. Date of the last sync for the location

lastSyncCheckEnqueuedstring or null(date-time)

Output only. Date and time when a sync check was last enqueued

lastUnwantedCheckEnqueuedstring or null(date-time)

Output only. Date and time when a duplicate check was last enqueued

deactivatedstring or null(date-time)

Output only. Date and time when the location was deactivated (status INACTIVE or CLOSED)

identifierstring or null[ 1 .. 191 ] characters

The location identifier based on your internal identification system

photosArray of objects or null

The location's photos

translationsArray of objects or null

Translations for the location

nextBillingstring or null(date-time)

Output only. Next billing date for the location

endDatestring or null(date-time)

End date. Nullable.

cancellationDatestring or null(date-time)

Output only. Cancellation date for the location

dateCreatedstring or null(date-time)

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

lastUpdatedstring or null(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.

timezonestring or null

The location's timezone

openingDatestring or null(date)

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

sortableDatastring or null

Internal field for sorting and search data optimization.

wizardStepFinishedinteger or null(int32)

Output only. Last step finished in the creation wizard.

suggestionsArray of objects or null

Community suggestions for the location

serviceAreasArray of objects or null

Service areas available on the location.

locationConnectsArray of objects or null

Connected accounts and directory links

callTrackingNumbersArray of objectsunique

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 objectsunique

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

actionLinksArray of objectsunique

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 or null

Set a location to temporarily closed with the ability to set a re-open date. Temporarily closed is best used if a location will be closed for more than seven days. If less than seven days, use special hours to show the location is closed.

businessNamestring
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

sublocalitystring
evDataobject or null

A description of the EV Charging station's location. Used to help customers find the station more easily

doctorComDataobject or null

Description of the provider

needsReviewArray of objectsunique

Needs review

socialPostIdinteger(int64)
productPlanIdinteger(int64)
featuresArray of stringsunique

Output only. List of features available to the location

Items Enum"ADS""ADS_READ""ADS_WRITE""ADVANCED_ANALYTICS_2_0""AI_KNOWLEDGEBASE""AI_LOCALISATION""AI_LOCATION_INFORMATION""AI_SUGGESTED_REPLIES""APPLE_POSTING""APPLE_POSTING_WRITE"
businessCountrystring
Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
businessTypestring
Enum"SMB""ENTERPRISE"
contentCollectionsobject

Content Collection

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"
listingsBeingUpdatedinteger(int32)

Output only. Number of listings still being updated

suggestionsForFieldsAvailableboolean
moreHoursArray of objectsunique

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

locationNeedsReviewArray of objectsunique
visibilityIndexinteger(int32)

Output only. The location's latest visibility index

skipFacebookPicturesUpdateboolean

When set to true, Uberall will skip publishing any photos to Facebook for this location. This affects both sync checks and updates.

Example: true
activeListingsCountinteger(int32)

Output only. Number of active listings

attributesArray of objects

Google attributes

publishedListingsCountinteger(int32)

Output only. Number of published listings

socialProfilesArray of objectsunique

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

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"
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

servicesArray of objects

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

listingsInSyncinteger(int32)

Output only. The number of listings in sync

mainPhotoobject

The location's main picture

directoriesPublishingStatusArray of strings
locationSyncableboolean
directoriesMissingConnectArray of strings
Items Enum"FOURSQUARE""UBER""GOOGLE""WAZE""GOOGLE_MAPS""YELP_API""MEINESTADT""NOKIA_HERE""FACEBOOK""TOMTOM"
linkedToLocationGroupsArray of objects
activeDirectoriesCountinteger(int32)

Output only. Number of active directories

averageRatingnumber(double)
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

videosArray of objects

The location's videos

businessSyncableboolean
customFieldsArray of objects

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"
    '}'
  ]
cleansingStatusstring

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

Enum"NOT_CLEANSED""PENDING""CLEANSED""INVALID_DATA"
transactionLinksArray of objectsuniqueDeprecated

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. "transactionLinks" in the API still works for Google, but customers are suggested to move to "actionLinks" to support Apple.

curl -i -X POST \
  https://uberall.com/api/locations \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "id": 0,
    "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": "DE",
    "lat": -90,
    "lng": -180,
    "addressDisplay": true,
    "normalizationStatus": "NOT_NORMALIZED",
    "phone": "+4912345678",
    "fax": "+4912345678",
    "cellphone": "+4912345678",
    "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"
    ],
    "callToActions": [
      {
        "text": "string",
        "url": "string"
      }
    ],
    "labels": "['\''Campaign2018'\'', '\''EastCoast'\'']",
    "brands": [
      "string"
    ],
    "paymentOptions": [
      "cash",
      "credit card",
      "invoice"
    ],
    "languages": [
      "string"
    ],
    "categories": [
      0
    ],
    "status": "CREATED",
    "firstSyncStarted": "2019-08-24T14:15:22Z",
    "lastSyncStarted": "2019-08-24T14:15:22Z",
    "lastSyncCheckEnqueued": "2019-08-24T14:15:22Z",
    "lastUnwantedCheckEnqueued": "2019-08-24T14:15:22Z",
    "deactivated": "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",
        "photo": "string",
        "locationId": 0
      }
    ],
    "translations": [
      {}
    ],
    "nextBilling": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "cancellationDate": "2019-08-24T14:15:22Z",
    "dateCreated": "2019-08-24T14:15:22Z",
    "lastUpdated": "2019-08-24T14:15:22Z",
    "autoSync": true,
    "timezone": "string",
    "openingDate": "2019-08-24",
    "sortableData": "string",
    "wizardStepFinished": 0,
    "suggestions": [
      {
        "id": 0,
        "type": "FOURSQUARE",
        "status": "HIDDEN",
        "value": {},
        "directory": "FOURSQUARE"
      }
    ],
    "serviceAreas": [
      {
        "name": "Berlin, Deutschland",
        "placeId": "ChIJAVkDPzdOqEcRcDteW0YgIQQ"
      }
    ],
    "locationConnects": [
      {
        "directoryType": "FOURSQUARE"
      }
    ],
    "callTrackingNumbers": [
      {
        "type": "FOURSQUARE",
        "number": "string"
      }
    ],
    "utms": [
      {
        "type": "FOURSQUARE",
        "parameters": "string"
      }
    ],
    "transactionLinks": [
      {
        "directoryType": "FOURSQUARE",
        "url": "string",
        "type": "APPOINTMENT",
        "appStoreUrl": "string",
        "isPreferred": true
      }
    ],
    "actionLinks": [
      {
        "directoryType": "FOURSQUARE",
        "url": "string",
        "type": "APPOINTMENT",
        "appStoreUrl": "string",
        "isPreferred": true
      }
    ],
    "temporarilyClosed": {
      "temporarilyClosed": true,
      "reopenDate": "string"
    },
    "businessName": "string",
    "nameDescriptor": "string",
    "sublocality": "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,
              "maxPower": 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
      ]
    },
    "needsReview": [
      {
        "description": "string",
        "field": "NAME",
        "type": "CANNOT_START_SYNC",
        "id": 0
      }
    ],
    "socialPostId": 0,
    "productPlanId": 0,
    "features": [
      "ADS"
    ],
    "businessCountry": "AF",
    "businessType": "SMB",
    "contentCollections": {
      "id": 0,
      "identifier": "string",
      "name": "string",
      "description": "string",
      "type": "MENU",
      "contentLists": [
        {
          "id": 0,
          "title": "Lunch Menu",
          "type": "MENU",
          "description": "string",
          "translations": [
            {
              "hu": {
                "title": "Magyar"
              },
              "fr": {
                "title": "Titre Français"
              }
            }
          ],
          "items": [
            {
              "title": "string",
              "description": "string",
              "identifier": "string",
              "listName": "string",
              "id": 0,
              "price": 0,
              "currency": "EUR",
              "category": "Starters, Drinks, Desert, etc.",
              "image": {
                "id": 0,
                "url": "string",
                "type": "LOGO",
                "description": "string",
                "uid": "string"
              },
              "url": "string",
              "priceMax": 0,
              "caloriesLow": 0,
              "caloriesHigh": 0,
              "allergens": "Eggs, Dairy, Wheat, etc.",
              "dietaryRestrictions": "Vegetarian, Halal, etc."
            }
          ]
        }
      ],
      "locationIds": [
        0
      ],
      "isReadOnly": false,
      "cuisineType": "AMERICAN",
      "url": "string"
    },
    "businessId": 1234,
    "cleansingComment": "ADDRESS_DETAILS_VERIFIED",
    "listingsBeingUpdated": 0,
    "suggestionsForFieldsAvailable": true,
    "moreHours": [
      {
        "type": {
          "id": 0
        },
        "hours": [
          {
            "dayOfWeek": 1,
            "from": "08:00",
            "to": "18:00"
          }
        ]
      }
    ],
    "profileCompleteness": 0,
    "locationNeedsReview": [
      {
        "description": "string",
        "field": "NAME",
        "type": "CANNOT_START_SYNC",
        "id": 0
      }
    ],
    "visibilityIndex": 0,
    "skipFacebookPicturesUpdate": true,
    "activeListingsCount": 0,
    "attributes": [
      {
        "externalId": "string",
        "value": "string",
        "displayName": "string",
        "groupDisplayName": "string",
        "valueMetadata": [
          {
            "value": "string",
            "displayName": "string"
          }
        ],
        "valueType": "BOOL, URL, ENUM, REPEATED_ENUM"
      }
    ],
    "publishedListingsCount": 0,
    "socialProfiles": [
      {
        "url": "string",
        "type": "FACEBOOK"
      }
    ],
    "missingMandatoryFields": [
      "NAME"
    ],
    "contentLists": [
      0
    ],
    "dataPoints": 0,
    "services": [
      {
        "title": "string",
        "description": "string",
        "identifier": "string",
        "listName": "string",
        "price": 0,
        "currency": "USD",
        "category": 0,
        "country": "string",
        "googleService": "string",
        "priceMax": 0,
        "url": "string",
        "duration": 0,
        "durationMax": 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",
      "photo": "string",
      "locationId": 0
    },
    "directoriesPublishingStatus": [
      "string"
    ],
    "locationSyncable": true,
    "directoriesMissingConnect": [
      "FOURSQUARE"
    ],
    "linkedToLocationGroups": [
      {
        "id": 0,
        "lastUpdated": "2019-08-24T14:15:22Z",
        "name": "string",
        "status": "ACTIVE",
        "creator": 0,
        "salesPartner": 0,
        "locationsCount": 0,
        "locations": [
          {
            "id": 1,
            "name": "Location 1",
            "status": "ACTIVE"
          }
        ],
        "users": [
          {
            "id": 1,
            "email": "jan.didschuneit@uberall.com",
            "firstName": "Jan",
            "lastName": "Didschuneit",
            "role": "ADMIN",
            "status": "VERIFIED"
          }
        ]
      }
    ],
    "activeDirectoriesCount": 0,
    "averageRating": 0.1,
    "cleansingInvalidDataReason": "string",
    "videos": [
      {
        "id": 0,
        "url": "string",
        "description": "string",
        "type": "YOUTUBE"
      }
    ],
    "businessSyncable": true,
    "customFields": [
      {
        "name": "foo",
        "value": "bar"
      }
    ],
    "cleansingStatus": "NOT_CLEANSED"
  }'

Responses

Location successfully created

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": { … }
  }
}

Delete Several Locations

Request

Delete several locations identified by their uberall unique ids. Locations can be deleted only if they are inactivated (status = INACTIVE) and are no longer billed (endDate < now).

Security
X-API-KEY or Authorization
Query
locationsArray of stringsrequired

The uberall unique ids for the locations you want to delete

curl -i -X DELETE \
  'https://uberall.com/api/locations?locations=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Locations successfully deleted

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.​deletedCountinteger(int32)

Total count of deleted items

Example: 10
response.​failedCountinteger(int32)

Total count of failed items

Example: 2
response.​deletedIdsArray of integers(int64)
response.​failedArray of strings
Response
No content

Update Several Locations

Request

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

Caution! Changing the Location Name, Country, Street, ZIP, City, Province, Phone Number, or Primary Business Category may cause your listings to become unverified on Google, which could temporarily impact your visibility.

Security
X-API-KEY or Authorization
Body*/*required

List of Maps with both location id and params to update : [{id: 123, status: CANCELLED}, ...]

Array [
idinteger(int64)

Output only. The uberall unique id for the location

openingHoursArray of objectsunique

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 or nullunique

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"}]
namestring[ 1 .. 128 ] charactersrequired

The location's name

streetstring[ 1 .. 191 ] charactersrequired

The location's street address

streetNostring or null<= 255 characters

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 or null[ 1 .. 64 ] characters

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

Example: "building, floor, ..."
zipstring or null[ 1 .. 32 ] characters

Zip code, optional only for some countries.

citystring[ 1 .. 64 ] charactersrequired

City

provincestring or null[ 1 .. 255 ] characters

Province. Only send when not blank

countrystringrequired

Country of the location

Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
Example: "DE"
latnumber or null(double)[ -90 .. 90 ]

The latitude coordinate of the location

lngnumber or null(double)[ -180 .. 180 ]

The longitude coordinate of the location

addressDisplayboolean

Indicates if the address should be displayed or hidden

normalizationStatusstring
Enum"NOT_NORMALIZED""NORMALIZED""NORMALIZATION_SKIPPED""NORMALIZATION_FAILED"
phonestring or nullnon-empty

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

Example: "+4912345678"
faxstring or nullnon-empty

The location fax number

Example: "+4912345678"
cellphonestring or null[ 1 .. 64 ] characters

A contact mobile phone number

Example: "+4912345678"
websitestring or null[ 1 .. 350 ] characters

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

emailstring or null[ 1 .. 255 ] characters

A contact email for the location

legalIdentstring or null[ 1 .. 512 ] characters

A legal identifier of the location. SIRET number in France

taxNumberstring or null[ 1 .. 255 ] characters

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

emailVerificationstring or null

The locations verification status

Enum"UNVERIFIED""VERIFIED"
descriptionShortstring or null<= 200 characters[0-9\\p{L}\\(\\)\\[\\] \\?:;\\/!\\\\,\\.\\-%\...

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

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

descriptionLongstring or null<= 1000 characters[0-9\\p{L}\\(\\)\\[\\] \\?:;\\/!\\\\,\\.\\-%\...

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

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

imprintstring or null<= 20000 characters

The imprint of the location

openingHoursNotesstring or null<= 255 characters[0-9\\p{L}\\(\\)\\[\\] \\?:;\\/!\\\\,\\.\\-%\...

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 or nullunique

Keywords describing the location's activity

callToActionsArray of objects or null

Calls to action available for the location

labelsArray of objects or nullunique

Labels grouping similar locations

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

The brands offered by the location to its customers

paymentOptionsArray of strings or nullunique

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

Example: ["cash","credit card","invoice"]
languagesArray of strings or nullunique

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

categoriesArray of integers(int64)<= 10 items

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

statusstringrequired

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"
firstSyncStartedstring or null(date-time)

Output only. Date and time when the first sync was started for the location

lastSyncStartedstring or null(date-time)

Output only. Date of the last sync for the location

lastSyncCheckEnqueuedstring or null(date-time)

Output only. Date and time when a sync check was last enqueued

lastUnwantedCheckEnqueuedstring or null(date-time)

Output only. Date and time when a duplicate check was last enqueued

deactivatedstring or null(date-time)

Output only. Date and time when the location was deactivated (status INACTIVE or CLOSED)

identifierstring or null[ 1 .. 191 ] characters

The location identifier based on your internal identification system

photosArray of objects or null

The location's photos

translationsArray of objects or null

Translations for the location

nextBillingstring or null(date-time)

Output only. Next billing date for the location

endDatestring or null(date-time)

End date. Nullable.

cancellationDatestring or null(date-time)

Output only. Cancellation date for the location

dateCreatedstring or null(date-time)

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

lastUpdatedstring or null(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.

timezonestring or null

The location's timezone

openingDatestring or null(date)

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

sortableDatastring or null

Internal field for sorting and search data optimization.

wizardStepFinishedinteger or null(int32)

Output only. Last step finished in the creation wizard.

suggestionsArray of objects or null

Community suggestions for the location

serviceAreasArray of objects or null

Service areas available on the location.

locationConnectsArray of objects or null

Connected accounts and directory links

callTrackingNumbersArray of objectsunique

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 objectsunique

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

actionLinksArray of objectsunique

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 or null

Set a location to temporarily closed with the ability to set a re-open date. Temporarily closed is best used if a location will be closed for more than seven days. If less than seven days, use special hours to show the location is closed.

businessNamestring
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

sublocalitystring
evDataobject or null

A description of the EV Charging station's location. Used to help customers find the station more easily

doctorComDataobject or null

Description of the provider

needsReviewArray of objectsunique

Needs review

socialPostIdinteger(int64)
productPlanIdinteger(int64)
featuresArray of stringsunique

Output only. List of features available to the location

Items Enum"ADS""ADS_READ""ADS_WRITE""ADVANCED_ANALYTICS_2_0""AI_KNOWLEDGEBASE""AI_LOCALISATION""AI_LOCATION_INFORMATION""AI_SUGGESTED_REPLIES""APPLE_POSTING""APPLE_POSTING_WRITE"
businessCountrystring
Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
businessTypestring
Enum"SMB""ENTERPRISE"
contentCollectionsobject

Content Collection

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"
listingsBeingUpdatedinteger(int32)

Output only. Number of listings still being updated

suggestionsForFieldsAvailableboolean
moreHoursArray of objectsunique

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

locationNeedsReviewArray of objectsunique
visibilityIndexinteger(int32)

Output only. The location's latest visibility index

skipFacebookPicturesUpdateboolean

When set to true, Uberall will skip publishing any photos to Facebook for this location. This affects both sync checks and updates.

Example: true
activeListingsCountinteger(int32)

Output only. Number of active listings

attributesArray of objects

Google attributes

publishedListingsCountinteger(int32)

Output only. Number of published listings

socialProfilesArray of objectsunique

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

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"
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

servicesArray of objects

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

listingsInSyncinteger(int32)

Output only. The number of listings in sync

mainPhotoobject

The location's main picture

directoriesPublishingStatusArray of strings
locationSyncableboolean
directoriesMissingConnectArray of strings
Items Enum"FOURSQUARE""UBER""GOOGLE""WAZE""GOOGLE_MAPS""YELP_API""MEINESTADT""NOKIA_HERE""FACEBOOK""TOMTOM"
linkedToLocationGroupsArray of objects
activeDirectoriesCountinteger(int32)

Output only. Number of active directories

averageRatingnumber(double)
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

videosArray of objects

The location's videos

businessSyncableboolean
customFieldsArray of objects

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"
    '}'
  ]
cleansingStatusstring

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

Enum"NOT_CLEANSED""PENDING""CLEANSED""INVALID_DATA"
transactionLinksArray of objectsuniqueDeprecated

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. "transactionLinks" in the API still works for Google, but customers are suggested to move to "actionLinks" to support Apple.

]
curl -i -X PATCH \
  https://uberall.com/api/locations \
  -H 'Content-Type: */*' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '[object Object]'

Responses

Locations successfully updated

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.​updatedCountinteger(int32)

Total count of updated items

Example: 10
response.​failedCountinteger(int32)

Total count of failed items

Example: 2
response.​missingIdCountinteger(int32)

Total count of missing IDs

Example: 1
response.​updatedIdsArray of integers(int64)
response.​failedArray of strings
response.​warningsArray of strings
Response
application/json
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "updatedCount": 10,
    "failedCount": 2,
    "missingIdCount": 1,
    "updatedIds": [ … ],
    "failed": [ … ],
    "warnings": [ … ]
  }
}

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

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