listOrganizations
get
/ccadmin/v1/organizations
List Organizations. This operation is used to get the collection of customer organizations from Oracle Commerce Cloud. It can also be used to return the list on a searched string and in a sorted order against various properties of organization.
Request
Supported Media Types
- application/json
Query Parameters
-
exclude(optional): string
As an alternative to the fields parameter, which explicitly specifies the properties to include, you can use the exclude parameter to include all properties except the ones specified. For example, to return all of the properties of organization except paymentMethods.
-
expand(optional): string
Expand query parameter is used to return only basic properties like name, id, active, Organization Logo, parentOrganization and ancestorOrganizations. Possible values for this expand query parameter is 'basic'
-
fields(optional): string
You can use the fields parameter to restrict the set of properties returned to only those you explicitly specify. The properties are specified as a comma-separated list. For example, id and name properties of organization.
-
filterKey(optional): string
Rather than using fields or exclude to explicitly list properties in the URL of a REST call, you can create persistent filters that store the set of properties to include or exclude. You can then specify a filter by name in the URL using the filterKey query parameter. Use Response Filters Admin API to create new persistent filters and use them.
-
limit(optional): string
This is the field to determine number of records to be fetched per REST call.
-
offset(optional): string
This field determines the offset/starting index from which data to be fetched.
-
q(optional): string
Query string built as per the SCIM standards that helps to search entered string across account properties like 'name' and also dynamic account properties.
-
sort(optional): string
This field determines the sort order of the list to be fetched.
-
useAdvancedQParser(optional): boolean
This field determines the parser to be used. Default parser has limitations and nested queries or complex queries cannot be executed using this default parser. It is recommended to use this flag as true.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listOrganizations_response
Type:
Show Source
object
-
items(optional):
array items
list of organizations
-
limit(optional):
string
Number of records to be fetched.
-
offset(optional):
string
The offset provided.
-
total(optional):
string
Total number of records present in database matching the searched string.
-
totalResults(optional):
string
Total number of records present in database matching the searched string.
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
Active status of an Organization. Should be true or false. By default the value is set to true
-
externalOrganizationId(optional):
string
External organization id
-
id(optional):
string
Id of the Organization
-
name(optional):
string
The name for Organization
-
repositoryId(optional):
string
repository Id of the Organization
Example Response (application/json)
{
"total":1,
"totalResults":1,
"offset":0,
"limit":1,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadmin/v1/organizations"
}
],
"items":[
{
"taxReferenceNumber":"REFNUM123",
"organizationLogo":"/general/hero-image1.jpg",
"description":null,
"delegateApprovalManagement":false,
"secondaryAddresses":[
{
"address":{
"country":"US",
"externalAddressId":"EXT_ADDR_1",
"types":[
{
"displayName":"Shipping",
"repositoryId":"ss-10001",
"id":"ss-10001"
},
{
"displayName":"Billing",
"repositoryId":"ss-10002",
"id":"ss-10001"
}
],
"phoneNumber":"973-974-1234",
"address3":"Street 3",
"address2":"Street 2",
"city":"Montgomery",
"address1":"600 Dexter Avenue",
"postalCode":"36130",
"companyName":"Oracle",
"repositoryId":"190001",
"state":"AL"
},
"addressType":"Office Address"
}
],
"externalOrganizationId":"externalOrgId1",
"type":"none",
"parentOrganization":{
"name":"Oracle Sample",
"repositoryId":"100001",
"active":true,
"id":"100001",
"externalOrganizationId":"EXT_ORG_1"
},
"customerType":"Standard",
"organizationLogoURL":"http://localhost:9080/file/general/hero-image1.jpg",
"members":[
{
"repositoryId":"110001",
"id":"110001"
}
],
"id":"2200002",
"dunsNumber":"123456789",
"relativeRoles":[
{
"function":"admin",
"repositoryId":"200004"
},
{
"function":"buyer",
"repositoryId":"200005"
},
{
"function":"approver",
"repositoryId":"200006"
},
{
"function":"accountAddressManager",
"repositoryId":"200007"
},
{
"function":"profileAddressManager",
"repositoryId":"200008"
}
],
"dynamicProperty1":"dynamicProperty1 value",
"contract":{
"terms":{
"terms":"All copyright, trade marks, design rights, patents and other intellectual property rights (registered and unregistered) belong to Us Motor Works Contract",
"repositoryId":"100002"
},
"endDate":"2017-10-10T11:44:26.000Z",
"catalog":{
"repositoryId":"cloudCatalog"
},
"displayName":"Us Motor Works Contract",
"repositoryId":"100003",
"description":"This is a written or spoken agreement, especially one concerning employment, sales, or tenancy, that is intended to be enforceable by law.",
"priceListGroup":{
"repositoryId":"defaultPriceGroup"
},
"creationDate":"2016-04-01T09:34:50.000Z",
"startDate":"2016-10-10T11:44:26.000Z",
"externalContractReference":"UMWCUS001"
},
"active":true,
"taxExemptionCode":"TAXUQ12345",
"vatReferenceNumber":"Vat123123",
"orderPriceLimit":null,
"approvalRequired":false,
"repositoryId":"2200002",
"name":"Oracle",
"shippingAddress":{
"country":"US",
"externalAddressId":"EXT_ADDR_1",
"types":[
{
"displayName":"Shipping",
"repositoryId":"ss-10001",
"id":"ss-10001"
},
{
"displayName":"Billing",
"repositoryId":"ss-10002",
"id":"ss-10001"
}
],
"phoneNumber":"973-974-1234",
"address3":"Street 3",
"address2":"Street 2",
"city":"Montgomery",
"address1":"600 Dexter Avenue",
"postalCode":"36130",
"companyName":"Oracle",
"repositoryId":"190001",
"state":"AL"
},
"ancestorOrganizations":[
{
"name":"Oracle Sample",
"repositoryId":"100001",
"active":true,
"id":"100001",
"externalOrganizationId":"EXT_ORG_1"
}
],
"useExternalApprovalWebhook":false,
"billingAddress":{
"country":"US",
"externalAddressId":"EXT_ADDR_1",
"types":[
{
"displayName":"Shipping",
"repositoryId":"ss-10001",
"id":"ss-10001"
},
{
"displayName":"Billing",
"repositoryId":"ss-10002",
"id":"ss-10001"
}
],
"phoneNumber":"973-974-1234",
"address3":"Street 3",
"address2":"Street 2",
"city":"Montgomery",
"address1":"600 Dexter Avenue",
"postalCode":"36130",
"companyName":"Oracle",
"repositoryId":"190001",
"state":"AL"
},
"uniqueId":"TestIDNumber"
}
]
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|100070|Invalid Query Expression.|
|10002|The value x for parameter 'y' is invalid. 'y' can be 'limit', 'offset' or 'sort'.|
|100018|If invalid input is passed.|
|100019|If there was any internal error while getting organizations list.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code