- Update a Location
Make changes to a location. Any blank parameter deletes an old value; any unspecified parameter is left unchanged.
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.
Location object
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.
[ { "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 } ]
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.
[ { "date": "2017-06-29", "closed": true }, { "date": "2017-06-30", "from1": "11:00", "to1": "14:00", "from2": "16:00", "to2": "20:00" } ]
Required for Spain. One of ALAMEDA, AVENIDA, CALLE, CAMINO, CARRER, CARRETERA, GLORIETA, KALEA, PASAJE, PASEO, PLACA, PLAZA, RAMBLA, RONDA, RUA, SECTOR, TRAVESERA, TRAVESIA, URBANIZACION
An address extra: e.g. building, floor...
Country of the location
The location's address-normalization state. On input, only NOT_NORMALIZED and NORMALIZATION_SKIPPED are accepted; other values are system-managed and assigned automatically as the location moves through the normalization pipeline.
The location's contact phone number, a valid phone number has to be provided.
A valid url for the location's website (use UTMs to add tracking)
A contact email for the location
A legal identifier of the location. SIRET number in France
A short description - up to 200 characters, all characters must match this regexp:
[0-9\p'{'L'}'()[] ?:;/!\,.-%\&=\r\n\t_*§²`´·"'+¡¿@°€£$] A long description - up to 1000 characters, all characters must match this regexp:
[0-9\p'{'L'}'()[] ?:;/!\,.-%\&=\r\n\t_*§²³`´·"'+¡¿@°€^£$] 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_*§²`´·"'+¡¿@] Calls to action available for the location. Excess entries are silently truncated, not rejected.
Labels grouping similar locations
The payment options accepted at the location. To remove a specific option, prefix its value with '-' (e.g. ["-cash"] removes the 'cash' option). Sending the full list replaces all options.
[ "-cash", "credit card", "invoice" ]
The language(s) in which customers can interact with the location's staff
Required to start location sync - A list of category IDs describing the location
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
Output only. Date and time when the first sync was started for the location. Set together with lastSyncStarted; either both fields are populated or both are null.
Output only. Date and time when a sync check was last enqueued
Output only. Date and time when a duplicate check was last enqueued
Output only. Date and time when the location was deactivated (status INACTIVE or CLOSED)
The location identifier based on your internal identification system
Translations for location fields in different languages. In GET responses, returned as an array of translation objects (see LocationTranslation schema). In POST/PATCH requests, provide as a nested map: locale code → field property name → translated value.
{ "en": { "name": "English name", "descriptionShort": "Short description in English" }, "de": { "name": "German name", "descriptionShort": "Kurze Beschreibung auf Deutsch" } }
Subscription/contract end date for this location. When set, indicates the date on which the location's subscription is scheduled to end. Distinct from cancellationDate (which records when a cancellation was requested). Nullable.
Output only. The date and time the location was created in our database
Output only. Date of the last changes made to the location. Includes updates by users, API, location cleansing, and duplicate checks
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.
The date the location will first open. Must be formatted YYYY-MM-DD
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
UTM parameter to be appended to the location's website. Codes can be sent to Google, Facebook, and Bing.
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.
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.
Output only. List of features available to the location
Combined street address and street number as a single string (e.g. "Main St 42" or "42 Main St" depending on the country's convention). In responses, this field is always populated from the stored 'street' and 'streetNo' values. In create/update requests, 'streetAndNumber' can be used as an alternative to sending separate 'street' and 'streetNo' fields — useful when only a combined "Address Line 1" value is available. When provided, the system attempts to automatically extract the street number from the combined value.
If 'street' or 'streetNo' is also present in the same request, 'streetAndNumber' is ignored.
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
A description of the EV Charging station's location. Used to help customers find the station more easily
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.
Cleansing comment by user, set only when cleansingStatus is INVALID_DATA. Possible Values (ADDRESS_DETAILS_VERIFIED, NAME_ADDRESS_DETAILS_UPDATED, NON_CLOSURE_CONFIRMATION,)
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
Output only. Current cleansing status for the location. Possible values: NOT_CLEANSED, PENDING, CLEANSED, INVALID_DATA
The content list IDs (EVENTS, PRODUCTS, MENU, PEOPLE) describing the location
Output only. Number of dataPoints (reviews, photos) left by users at this location
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]
Defines the physical containment relationship of this location within another place (e.g. a mall or airport). Each entry references an external place by its directory-specific ID and describes whether the location is a department of or an independent establishment within that place. At most one entry per directoryType is allowed; currently only GOOGLE is supported. Required fields: placeId (max 1024 chars), relationType. Optional: directoryType. Place details (placeName, placeAddress, coordinates) are resolved automatically from downstream APIs (e.g. Google Places).
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"
}]
}]Output only. Number representing completeness of location data, up to 100
When set to true, Uberall will skip publishing any photos to Facebook for this location. This affects both sync checks and updates.
Services offered at the location. Do not use if Content Collections is enabled. Instead use the Service Item and Collection endpoints
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.
- https://uberall.com/apihttps://uberall.com/api/locations/{id}
- Mock Serverhttps://docs.uberall.com/_mock/apis/swagger/locations/{id}
- X-API-KEY
- Authorization
curl -i -X PATCH \
'https://uberall.com/api/locations/{id}' \
-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": "Coffee House Berlin",
"street": "Friedrichstraße",
"streetNo": "45A",
"streetType": "ALAMEDA",
"addressExtra": "Suite 304",
"zip": "10115",
"city": "Berlin",
"province": "Berlin",
"country": "DE",
"lat": 52.52,
"lng": 13.405,
"addressDisplay": true,
"normalizationStatus": "NOT_NORMALIZED",
"phone": "+4912345678",
"fax": "+4912345678",
"cellphone": "+4912345678",
"website": "https://www.example.com",
"email": "info@example.com",
"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,
"url": "string"
}
],
"translations": {
"en": {
"name": "English name",
"descriptionShort": "Short description in English"
},
"de": {
"name": "German name",
"descriptionShort": "Kurze Beschreibung auf Deutsch"
}
},
"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"
},
"features": [
"ADS"
],
"streetAndNumber": "string",
"needsReview": [
{
"description": "string",
"field": "NAME",
"type": "CANNOT_START_SYNC",
"id": 0
}
],
"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
],
"doctorCategoriesDetailed": [
{
"id": 111,
"nuccTaxonomyCode": "207RI0011X"
}
]
},
"customFields": [
{
"name": "foo",
"value": "bar"
}
],
"businessSyncable": true,
"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,
"averageRating": 0.1,
"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,
"url": "string"
},
"missingMandatoryFields": [
"NAME"
],
"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"
}
]
}
],
"locatedIn": [
{
"directoryType": "FOURSQUARE",
"placeId": "ChIJAVkDPzdOqEcRcDteW0YgIQQ",
"relationType": "DEPARTMENT_OF",
"id": 0
}
],
"directoriesPublishingStatus": [
"string"
],
"locationSyncable": true,
"suggestionsForFieldsAvailable": true,
"moreHours": [
{
"type": {
"id": 0
},
"hours": [
{
"dayOfWeek": 1,
"from": "08:00",
"to": "18:00"
}
]
}
],
"lodgingFields": [
{
"value": "true",
"id": 0,
"externalId": "string",
"category": "string"
}
],
"profileCompleteness": 0,
"publishedListingsCount": 0,
"socialProfiles": [
{
"url": "string",
"type": "FACEBOOK"
}
],
"videos": [
{
"id": 0,
"url": "string",
"description": "string",
"type": "YOUTUBE"
}
],
"visibilityIndex": 0,
"skipFacebookPicturesUpdate": true,
"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"
},
"locationNeedsReview": [
{
"description": "string",
"field": "NAME",
"type": "CANNOT_START_SYNC",
"id": 0
}
],
"services": [
{
"title": "string",
"description": "string",
"identifier": "string",
"listName": "string",
"price": 0,
"currency": "USD",
"url": "string",
"category": 0,
"country": "string",
"googleService": "string",
"priceMax": 0,
"duration": 0,
"durationMax": 0
}
]
}'Location successfully edited
{ "status": "SUCCESS", "message": "string", "warnings": [ "string" ], "response": { "location": { … } } }