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
Get Sales Companies | ||
---|---|---|
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: |
|
HTTP Method |
GET |
|
Request Body Parameters | None | |
Response Body Parameters | The list of sales companies |
https://sitename.oracle.com/rest/v17/salesCompanies
{ "items": [{ "name": "A1BM1", "login": "a_Co1BM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users", "name": "users" } ] }, { "name": "A2BM1", "login": "a_Co2BM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co2BM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co2BM/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co2BM/users", "name": "users" } ] }, { "name": "A3BM1", "login": "a_Co3BM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co3BM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co3BM/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co3BM/users", "name": "users" } ] }, { "name": "A4BM1", "login": "a_Co4BM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co4BM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co4BM/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co4BM/users", "name": "users" } ] }, { "name": "A5BM1", "login": "a_Co5BM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co5BM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co5BM/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co5BM/users", "name": "users" } ] }, { "name": "A6BM1", "login": "a_Co6BM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co6BM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co6BM/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co6BM/users", "name": "users" } ] }, { "name": "A7BM1", "login": "a_Co7BM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co7BM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co7BM/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co7BM/users", "name": "users" } ] }, { "name": "cpqqa214", "login": "cpqqa214", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/cpqqa214" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/cpqqa214/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/cpqqa214/users", "name": "users" } ] }, { "name": "po1", "login": "po1", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/po1" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/po1/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/po1/users", "name": "users" } ] }, { "name": "po2", "login": "po2", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/po2" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/po2/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/po2/users", "name": "users" } ] }, { "name": "po3", "login": "po3", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/po3" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/po3/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/po3/users", "name": "users" } ] }, { "name": "po4", "login": "po4", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/po4" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/po4/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/po4/users", "name": "users" } ] }, { "name": "po5", "login": "po5", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/po5" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/po5/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/po5/users", "name": "users" } ] }, { "name": "A8BM1", "login": "s_Co8BM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/s_Co8BM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/s_Co8BM/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/s_Co8BM/users", "name": "users" } ] }, { "name": "Test", "login": "test", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/test" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/test/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/test/users", "name": "users" } ] }, { "name": "test2", "login": "test2", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/test2" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/test2/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/test2/users", "name": "users" } ] }, { "name": "Test3", "login": "test3", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/test3" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/test3/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/test3/users", "name": "users" } ] }, { "name": "test_unit", "login": "test_unit", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/test_unit" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/test_unit/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/test_unit/users", "name": "users" } ] }, { "name": "Translations", "login": "Translations", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/Translations" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/Translations/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/Translations/users", "name": "users" } ] } ], "offset": 0, "limit": 1000, "count": 19, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/companies" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/companies?offset=0&limit=1000" } ] }
https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM
{ "name": "A1BM1", "login": "a_Co1BM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/groups", "name": "groups" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users", "name": "users" } ] }
https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/groups
{ "items": [{ "label": "AGroup1", "variableName": "aGroup1", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/groups/aGroup1" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/groups" } ] } ], "offset": 0, "limit": 1000, "count": 1, "hasMore": false, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/groups" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/groups?offset=0&limit=1000" } ] }
https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/groups/aGroup1
{ "label": "AGroup1", "variableName": "aGroup1", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/groups/aGroup1" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/groups" } ] }
https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users
{ "items": [{ "login": "FA_date4", "firstName": "duncin", "lastName": "salesagent", "userKey": "d453a7df-b6d1-4dbf-8ebe-9507e0740d16", "email": "junk@bigmachines.com", "dateAdded": "2011-02-09T22:55:11.000Z", "dateModified": "2024-05-14T04:19:16.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users/FA_date4" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users" } ] }, { "login": "QA_BA_FA1", "firstName": "TestUser", "lastName": "NameMy", "userKey": "14767e4a-7aa0-4be9-93b0-b0663c6c3cfd", "email": "junk@bigmachines.com", "dateAdded": "2011-02-09T22:44:33.000Z", "dateModified": "2024-05-14T04:19:12.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users/QA_BA_FA1" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users" } ] }, { "login": "SA_EURO_Number2", "firstName": "Test", "lastName": "Euro", "userKey": "4bc2c2ab-474a-4a2e-8871-ebdfdbc8c129", "email": "junk@bigmachines.com", "dateAdded": "2011-02-09T23:05:43.000Z", "dateModified": "2024-05-14T04:19:12.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users/SA_EURO_Number2" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users" } ] }, { "login": "SA_EURO_Number3", "firstName": "Test", "lastName": "Euro", "userKey": "4b02c5f4-31ce-4021-8ea7-61274834a1e4", "email": "junk@bigmachines.com", "dateAdded": "2011-02-09T23:08:05.000Z", "dateModified": "2024-05-14T04:19:11.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users/SA_EURO_Number3" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users" } ] } ], "offset": 0, "limit": 1000, "count": 4, "hasMore": false, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users?offset=0&limit=1000" } ] }
https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users/FA_date4
{ "login": "FA_date4", "firstName": "duncin", "lastName": "salesagent", "userKey": "d453a7df-b6d1-4dbf-8ebe-9507e0740d16", "email": "junk@bigmachines.com", "dateAdded": "2011-02-09T22:55:11.000Z", "dateModified": "2024-05-14T04:19:16.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users/FA_date4" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/salesCompanies/a_Co1BM/users" } ] }
https://sitename.oracle.com/rest/v17/salesUsers
{ "items": [{ "firstName": "Automation_UserType_RestrictedAccess", "lastName": null, "dateModified": "2021-09-17T00:22:17.000Z", "key": "restuser1", "dateAdded": "2008-05-05T03:29:53.000Z", "email": "firstname.lastname@yourcompany.com", "links": [{ "rel": "self", "href": "https://localhost:8080/rest/v17/salesUsers/4131038" } ] }, { "firstName": "Super", "lastName": "User", "dateModified": "2021-10-11T18:20:13.000Z", "key": "user1234", "dateAdded": "2004-07-07T04:06:31.000Z", "email": "john.jones@yourcompany.com", "links": [{ "rel": "self", "href": "https://localhost:8080/rest/v17/salesUsers/4119220" } ] } }
https://sitename.oracle.com/rest/v17/salesUsers/user1234
{ "key": "user1234", "firstName": "John", "lastName": "Jones", "email": "john.jones@yourcompany.com" }
https://sitename.oracle.com/rest/v17/salesGroups
{ "items": [{ "variableName": "technicalGroup", "dateModified": "2013-12-20T22:32:15.000Z", "id": 5671402, "label": "No Longer Used 21", "dateAdded": "2008-05-14T12:45:17.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesGroups/5671402" }, { "kind": "", "rel": "child", "name": "translations", "href": "https://sitename.oracle.com/rest/v17/salesGroups/5671402/translations" } ] }, { "variableName": "a100kAccounts", "dateModified": "2020-05-18T21:41:13.000Z", "id": 9898200, "label": "100k Accounts", "dateAdded": "2011-01-18T06:06:27.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesGroups/9898200" }, { "kind": "", "rel": "child", "name": "translations", "href": "https://sitename.oracle.com/rest/v17/salesGroups/9898200/translations" } ] } ] }
https://sitename.oracle.com/rest/v17/salesGroups/5671402
{ "variableName": "technicalGroup", "dateModified": "2013-12-20T22:32:15.000Z", "id": 5671402, "label": "No Longer Used 21", "dateAdded": "2008-05-14T12:45:17.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/salesGroups/5671402" }, { "kind": "", "rel": "child", "name": "translations", "href": "https://sitename.oracle.com/rest/v17/salesGroups/5671402/translations" }] }