API Reference
/
Sales Partners
/
Get a single SalesPartner

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

Create child SalesPartner

Request

Can be used to create new child SalesPartner that will be then associated to your parent SalesPartner.

Bodyapplication/jsonrequired

SalesPartner data to create a new child SalesPartner

addressstringrequired

Full address string of the new child SalesPartner (Be aware: Can't be NULL or empty)

aggregateInvoicesToParentboolean

Indicates if the invoice for this SalesPartner should be aggregated to the parent invoice

attributionobject

Attribution Model

canSeePricesboolean

Indicates if the child SalesPartner should be allowed to see price information for e.g. product plans

countrystring

Country of the new child SalesPartner

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

Accounting email of the new child SalesPartner

emailCustomerSupportstring

Customer support email of the new child SalesPartner

emailProjectLeadstring

Project lead email of the new child SalesPartner

identifierstring

Identifier of the new child SalesPartner (e.g. your own customer ID for better reference)

minPasswordLengthinteger(int32)

Minimum password length for all users of the new child SalesPartner

namestringrequired

Name of child SalesPartner (Be aware: Can't be NULL or empty)

parentinteger(int64)required

Parent ID of the associated parent SalesPartner. (Be aware: You need the Uberall SalesPartner ID of the parent)

phonestring

Phone number of the new child SalesPartner

preferredLanguageobject

Preferred language of the new child SalesPartner, for invoice purpose (either 'de' oder 'en')

salesPartnerStatusstring

Sales Partner Status Enum

Enum"CREATED""APPROVED""DECLINED""DELETED""INACTIVE"
vatIdstring

VAT (Value-Added Tax) ID number of the SalesPartner (e.g. for Germany: DE123456789)

curl -i -X POST \
  https://docs.uberall.com/_mock/apis/swagger/sales-partners \
  -H 'Content-Type: application/json' \
  -H 'accessToken: YOUR_API_KEY_HERE' \
  -d '{
    "address": "string",
    "aggregateInvoicesToParent": true,
    "attribution": {
      "name": "string",
      "url": "string",
      "id": 0,
      "logo": {
        "url": "string",
        "type": "LOGO",
        "description": "string"
      }
    },
    "canSeePrices": true,
    "country": "AF",
    "emailAccounting": "string",
    "emailCustomerSupport": "string",
    "emailProjectLead": "string",
    "identifier": "string",
    "minPasswordLength": 0,
    "name": "string",
    "parent": 0,
    "phone": "string",
    "preferredLanguage": {},
    "salesPartnerStatus": "CREATED",
    "vatId": "string"
  }'

Responses

Successfully created child SalesPartner

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

Sales Partner Model

Response
No content

Get a single SalesPartner

Request

Can be used for retrieving informations about a single SalesPartner. This could either be your own SalesPartner or if your SalesPartner is a parent an associated child SalesPartner.

Path
idstringrequired

ID of the SalesPartner

curl -i -X GET \
  'https://docs.uberall.com/_mock/apis/swagger/sales-partners/{id}' \
  -H 'accessToken: YOUR_API_KEY_HERE'

Responses

SalesPartner 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.​salesPartnerobject

Sales Partner Model

Response
No content

Update a single SalesPartner

Request

Can be used to either update your own SalesPartner or if your SalesPartner is a parent you will be able to also update associated child SalesPartners.

Path
idstringrequired

ID of the SalesPartner

Bodyapplication/jsonrequired

SalesPartner data to update

addressstring

Full address string of the new child SalesPartner (Be aware: Can't be NULL or empty)

aggregateInvoicesToParentboolean

Indicates if the invoice for this SalesPartner should be aggregated to the parent invoice

attributionobject

Attribution Model

canSeePricesboolean

Indicates if the child SalesPartner should be allowed to see price information for e.g. product plans

countrystring

Country of the new child SalesPartner

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

Accounting email of the new child SalesPartner

emailCustomerSupportstring

Customer support email of the new child SalesPartner

emailProjectLeadstring

Project lead email of the new child SalesPartner

identifierstring

Identifier of the new child SalesPartner (e.g. your own customer ID for better reference)

minPasswordLengthinteger(int32)

Minimum password length for all users of the new child SalesPartner

namestring

Name of child SalesPartner (Be aware: Can't be NULL or empty)

phonestring

Phone number of the new child SalesPartner

preferredLanguageobject

Preferred language of the new child SalesPartner, for invoice purpose (either 'de' oder 'en')

salesPartnerStatusstring

Sales Partner Status Enum

Enum"CREATED""APPROVED""DECLINED""DELETED""INACTIVE"
vatIdstring

VAT (Value-Added Tax) ID number of the SalesPartner (e.g. for Germany: DE123456789)

curl -i -X PUT \
  'https://docs.uberall.com/_mock/apis/swagger/sales-partners/{id}' \
  -H 'Content-Type: application/json' \
  -H 'accessToken: YOUR_API_KEY_HERE' \
  -d '{
    "address": "string",
    "aggregateInvoicesToParent": true,
    "attribution": {
      "name": "string",
      "url": "string",
      "id": 0,
      "logo": {
        "url": "string",
        "type": "LOGO",
        "description": "string"
      }
    },
    "canSeePrices": true,
    "country": "AF",
    "emailAccounting": "string",
    "emailCustomerSupport": "string",
    "emailProjectLead": "string",
    "identifier": "string",
    "minPasswordLength": 0,
    "name": "string",
    "phone": "string",
    "preferredLanguage": {},
    "salesPartnerStatus": "CREATED",
    "vatId": "string"
  }'

Responses

Successfully edited SalesPartner

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

Sales Partner Model

Response
No content

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

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