Sales Companies, Groups, and Users REST APIs

Overview

The Sales Companies, Groups, and Users endpoints are used to identify sales groups and sales users for sharing Favorites. In addition, they can be used to identify sales companies, company groups, and company users for commerce process actions. These endpoints are available to administrators as well as buy-side/sales users.

Administration

ClosedGet Sales Companies

Get Sales CompaniesGET Method

Description

Use this endpoint to retrieve a list of sales companies accessible for the current user.

URI Endpoint

/rest/v17/salesCompanies
Query Parameters

This endpoint supports the following optional parameters: limit, offset, and totalResults.
Refer to Manage Collections for additional information.

HTTP Method

GET
Request Body Parameters None
Response Body Parameters The list of sales companies

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/salesCompanies

ClosedResponse Sample

ClosedGet Sales Company

Get Sales CompanyGET Method

Description

Use this endpoint to retrieve the specified sale company.

URI Endpoint

/rest/v17/salesCompanies/{companyLogin}
Endpoint Parameters

companyLogin

 The unique variable name to identify the company

HTTP Method

GET
Request Body Parameters None
Response Body Parameters

links

A list of links for the specified sales company

login

The sales company login

name

The sales company name

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM

ClosedResponse Sample

ClosedGet Sales Company Groups

Get Sales Company GroupsGET Method

Description

Use this endpoint to retrieve a list of all sales company groups.

URI Endpoint

/rest/v17/salesCompanies/{companyLogin}/groups
Endpoint Parameters

companyLogin

The unique variable name to identify the company

HTTP Method

GET
Request Body Parameters None
Response Body Parameters The list of sales company groups

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/groups

ClosedResponse Sample

ClosedGet Sales Company Group

Get Sales Company GroupGET Method

Description

Use this endpoint to retrieve the specified sales company group.

URI Endpoint

/rest/v17/salesCompanies/{companyLogin}/groups/{groupVarName}
Endpoint Parameters

companyLogin

The unique variable name to identify the company

groupVarName

The unique variable name for the sales group

HTTP Method

GET
Request Body Parameters None
Response Body Parameters

label

The sales company group label

links

A list of links for the specified sales company group

variableName

The sales company group variable name

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/groups/aGroup1

ClosedResponse Sample

ClosedGet Sales Company Users

Get Sales Company UsersGET Method

Description

Use this endpoint to retrieve a list of users for the specified sales company.

URI Endpoint

/rest/v17/salesCompanies/{companyLogin}/users
Endpoint Parameters

companyLogin

The unique variable name to identify the company

HTTP Method

GET
Request Body Parameters None
Response Body Parameters The list of sales company users

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users

ClosedResponse Sample

ClosedGet Sales Company User

Get Sales Company UserGET Method

Description

Use this endpoint tor retrieve the specified sales company user.

URI Endpoint

/rest/v17/salesCompanies/{companyLogin}/users/{userLoginName}
Endpoint Parameters

companyLogin

The unique variable name to identify the company

userLoginName

The unique login of the sales user

HTTP Method

GET
Request Body Parameters None
Response Body Parameters

dateAdded

The date the sales company user was added

dateModified

The date the sales company user was last modified

email

The sales user company email

firstName

The first name of the sales company user

lastName

The last name of the sales company user

links

A list of links for the specified sales company user

login

The unique login of the sales user

userKey

The user's globally unique identifier

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users/FA_date4

ClosedResponse Sample

ClosedGet Sales Users

Get Sales UsersGET Method

Description

Use this endpoint to retrieve a list of all sales users.

URI Endpoint

/rest/v17/salesUsers
Endpoint Parameters None

HTTP Method

GET
Request Body Parameters None
Response Body Parameters The JSON data for the sales user

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/salesUsers

ClosedResponse Sample

ClosedGet Sales User

Get Sales UserGET Method

Description

Use this endpoint to retrieve the specified the sales user.

URI Endpoint

/rest/v17/salesUsers/{key}
Endpoint Parameters

key

 The identifier for the sales user

HTTP Method

GET
Request Body Parameters None
Success Response The JSON data for the sales user

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/salesUsers/user1234

ClosedResponse Sample

ClosedGet Sales Groups

Get Sales GroupsGET Method

Description

Use this endpoint to retrieve a list of all sales groups available to a user. User are only able to view Sales Groups that are part of their same organization (partner organization or host company).

URI Endpoint

/rest/v17/salesGroups
Endpoint Parameters None

HTTP Method

GET
Request Body Parameters None
Response Body Parameters The JSON data for the collection of sales groups accessible to the current user

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/salesGroups

ClosedResponse Sample

ClosedGet Sales Group

Get Sales GroupGET Method

Description

Use this endpoint to retrieve the specified sales group. User are only able to view Sales Groups that are part of their same organization (partner organization or host company).

URI Endpoint

/rest/v17/salesGroups/{id}

Endpoint Parameters

id

 The identifier for a sales group

This endpoint will only get sales group users that satisfy the following criteria:

  • The sales group user is part of the same organization (partner organization or host company) as the querying user.
  • The sales group user is in one or more sales groups, not including Admin groups.

HTTP Method

GET
Request Body Parameters None
Response Body Parameters The JSON data for the sales user

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v17/salesGroups/5671402

ClosedResponse Sample

 

Related Topics

Related Topics Link IconSee Also