Skip to content
API Reference/
/
Migrate the Business to a...

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

Update a Business

Request

Edit information of the business with the given id. Current user needs UserRole ADMIN, ACCOUNT_MANAGER or BUSINESS_MANAGER.

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id for the business

Bodyapplication/jsonrequired

A Business object

idinteger(int64)

The uberall unique id for the business

namestring

The business's name

typestring

Business type. One of SMB or ENTERPRISE

Enum"SMB""ENTERPRISE"
Example: "[SMB, ENTERPRISE]"
streetAndNostring

Address of the business

addressLine2string

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

Example: "building, floor..."
provincestring

Province. Only send when not blank

zipstring

Zipcode of the business

citystring

City of the business

identifierstring

The business identifier based on your internal identification system

countrystring

Country of the business

Enum"AF""AX""AL""DZ""AS""AD""AO""AI""AQ""AG"
phonestring

Business's phone number

productPlanobject

The chosen product plan

preSyncboolean

Pre sync

dateCreatedstring(date-time)

The date and time the business was created in uberall database

statusstring

Business's status

Enum"CREATED""NOT_CONFIRMED""ACTIVE""DELETED"
countryPricesArray of objectsunique

List of country specific prices

defaultPriceinteger(int32)

Business default price in cent

defaultOriginalPriceinteger(int32)

Default Original Price in cent

defaultPriceSetupinteger(int32)

Business default setup price in cent

priceRetailinteger(int64)

Retail price

contractDurationinteger(int64)

Contract duration of the chosen product plan in months

defaultPriceMininteger(int64)
defaultCurrencystring
businessSyncableboolean

True if the business is allowed to start a sync. Only relevant for Businesses with more than 10 locations.

numOfLocationsinteger(int32)

Number of active locations

effectiveDatestring(date-time)

Date when the business automatically changes its product plan to the new product plan (defined by nextProductPlanId)

nextProductPlanIdinteger(int64)

ID of the next product plan applied for the business on the defined effectiveDate

customFieldsstring

Custom fields allow for additional information to be added at the location level. All locations within the business will have the same list of custom fields.

dateExpirationstring(date-time)

The date the business's contract expires

curl -i -X PATCH \
  'https://uberall.com/api/businesses/{id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "id": 0,
    "name": "string",
    "type": "[SMB, ENTERPRISE]",
    "streetAndNo": "string",
    "addressLine2": "building, floor...",
    "province": "string",
    "zip": "string",
    "city": "string",
    "identifier": "string",
    "country": "AF",
    "phone": "string",
    "productPlan": {
      "defaultPlan": true,
      "description": "string",
      "identifier": "string",
      "name": "string",
      "status": "ACTIVE",
      "automationDirectories": [
        "FOURSQUARE"
      ],
      "billingPeriod": 0,
      "countryPrices": [
        {
          "country": "AF",
          "price": 0,
          "marketDevelopmentFunds": 99,
          "priceSetup": 0
        }
      ],
      "defaultMarketDevelopmentFunds": 0,
      "defaultOriginalPrice": 0,
      "defaultPrice": 0,
      "defaultPriceSetup": 0,
      "duration": 0,
      "features": [
        "ADS"
      ],
      "initialBillingPeriod": 0,
      "initialDuration": 0
    },
    "preSync": true,
    "dateCreated": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "countryPrices": [
      {
        "country": "AF",
        "price": 0,
        "marketDevelopmentFunds": 99,
        "priceSetup": 0
      }
    ],
    "defaultPrice": 0,
    "defaultOriginalPrice": 0,
    "defaultPriceSetup": 0,
    "priceRetail": 0,
    "contractDuration": 0,
    "defaultPriceMin": 0,
    "defaultCurrency": "string",
    "businessSyncable": true,
    "numOfLocations": 0,
    "effectiveDate": "2019-08-24T14:15:22Z",
    "nextProductPlanId": 0,
    "customFields": "string",
    "dateExpiration": "2019-08-24T14:15:22Z"
  }'

Responses

Successfully edited Business

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.​businessobject

Business Model

Response
No content

Migrate the Business to a new SalesPartner

Request

Migration is only possible from parent sales partner to child sales partner or between children sales partners.

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id for the business

Query
targetSalesPartnerIdstringrequired

ID of the sales partner where the business should be migrated

targetWhiteLabelIdentifierstring

If the target sales partner has more then one whitelabel, please specify which one has to be chosen

curl -i -X POST \
  'https://uberall.com/api/businesses/{id}/migrate?targetSalesPartnerId=string&targetWhiteLabelIdentifier=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully migrated Business

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.​businessobject

Business Model

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

Get the product plans for businesses

Request

Get the product plans assigned to a business

Security
X-API-KEY or Authorization
Query
querystring

Restricts the response to the Product Plans that contain this name

activeOnlyboolean

If true, only active Product Plans are returned. Default: false

maxinteger(int64)

Maximum number of items to return

offsetinteger(int64)

Offset used for pagination. Default: 0

curl -i -X GET \
  'https://uberall.com/api/businesses/product-plans?query=string&activeOnly=true&max=0&offset=0' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Postcodes successfully retrieved

Response
No content

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

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