listOrganizations
get
/ccstore/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.Optionally takes the X-CCOrganization header to specify current Organization id of logged in user.
Request
Supported Media Types
- application/json
Query Parameters
-
includeDetails: boolean
Set to true to include all attributes and properties of the organizations in the response. Default is false.Default Value:
false -
includeUserRoles: boolean
Set to true to include the roles of the currently logged-in user across all organizations they are part of. Default is false.Default Value:
false -
limit: string
This is the field to determine number of records to be fetched per REST call.
-
offset: string
This field determines the offset/starting index from which data to be fetched.
-
q: string
Query string built as per the SCIM standards that helps to search entered string across account properties like 'name'.
-
sort: string
This field determines the sort order of the list to be fetched.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listOrganizations_response
Type:
Show Source
object-
items:
array items
list of organizations
-
limit:
string
Number of records to be fetched.
-
offset:
string
The offset provided.
-
total:
string
Total number of records present in database matching the searched string.
-
totalResults:
string
Total number of records present in database matching the searched string.
Nested Schema : items
Type:
Show Source
object-
active:
boolean
Active status of an Organization. Should be true or false. By default the value is set to true
-
approvalRequired:
boolean
Approval flag is required for the organization, by default it is set to false
-
billingAddress:
object billingAddress
The default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.
-
description:
string
Description for Organization
-
externalOrganizationId:
string
External organization id
-
id:
string
Id of the Organization
-
name:
string
The name for Organization
-
organizationLogo:
string
File path of organization logo.
-
repositoryId:
string
repository Id of the Organization
-
secondaryAddresses:
array secondaryAddresses
List of all the addresses associated with an Organization, if property like 'isDefaultShippingAddress' or 'isDefaultBillingAddress' is set to 'true', then in response the same address will come as a separate attribute with name 'shippingAddress' or 'billingAddress'.
-
shippingAddress:
object shippingAddress
The default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute.
Nested Schema : billingAddress
Type:
objectThe default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.
Show Source
-
address1:
string
the address1 of the address
-
address2:
string
the address2 of the address
-
city:
string
the city of the address
-
companyName:
string
the company name of the address
-
country:
string
the country of the address
-
dynamicProperty:
object dynamicProperty
The value of the dynamic Property
-
externalAddressId:
string
External address id
-
phoneNumber:
string
the phone Number of the address
-
postalCode:
string
the postal Code of the address
-
repositoryId:
string
repository Id of the address
-
state:
string
the state of the address
Nested Schema : secondaryAddresses
Type:
arrayList of all the addresses associated with an Organization, if property like 'isDefaultShippingAddress' or 'isDefaultBillingAddress' is set to 'true', then in response the same address will come as a separate attribute with name 'shippingAddress' or 'billingAddress'.
Show Source
Nested Schema : shippingAddress
Type:
objectThe default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute.
Show Source
-
address1:
string
the address1 of the address
-
address2:
string
the address2 of the address
-
city:
string
the city of the address
-
companyName:
string
the company name of shipping address
-
country:
string
the country of the address
-
dynamicProperty:
object dynamicProperty
The value of the dynamic Property
-
externalAddressId:
string
External address id
-
phoneNumber:
string
the phone Number of the company address
-
postalCode:
string
the postal Code of the address
-
repositoryId:
string
repository Id of the address
-
state:
string
the state of the address
Nested Schema : dynamicProperty
Type:
objectThe value of the dynamic Property
Nested Schema : items
Type:
Show Source
object-
address:
object address
Address created for the Organization.
-
addressType:
string
Address type represents nick name of account if present else repository ID of address item.
Nested Schema : address
Type:
objectAddress created for the Organization.
Show Source
-
address1:
string
The address1 of the secondary address
-
address2:
string
The address2 of the secondary address
-
city:
string
The city of the secondary address
-
companyName:
string
Company name of the secondary address
-
country:
string
The country of the address
-
dynamicProperty:
object dynamicProperty
The value of the dynamic Property
-
externalAddressId:
string
External address id
-
phoneNumber:
string
Phone Number of the address
-
postalCode:
string
Postal Code of the address
-
repositoryId:
string
repository Id of the address
-
state:
string
The State of the address
Nested Schema : dynamicProperty
Type:
objectThe value of the dynamic Property
Nested Schema : dynamicProperty
Type:
objectThe value of the dynamic Property
Example Response (application/json)
{
"total":1,
"totalResults":1,
"offset":0,
"limit":1,
"links":[
{
"rel":"self",
"href":"http://localhost:8080/ccstoreui/v1/organizations?members=bb-110034"
}
],
"sort":[
{
"property":"name",
"order":"asc"
}
],
"items":[
{
"name":"National Discount Auto Parts",
"repositoryId":"or-100001",
"active":true,
"id":"or-100001",
"externalOrganizationId":"EXT_ORG_1"
}
]
}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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code