listOrganizations
get
/ccapp/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):
integer
Number of records to be fetched.
-
offset(optional):
integer
The offset provided.
-
total(optional):
integer
Total number of records present in database matching the searched string.
-
totalResults(optional):
integer
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
-
ancestorOrganizations(optional):
array ancestorOrganizations
List of ancestors for the Organization
-
approvalRequired(optional):
boolean
Approval flag is required for the organization, by default it is set to false
-
billingAddress(optional):
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.
-
contract(optional):
object contract
Contract
-
customerType(optional):
string
Customer Type for Organization
-
delegateApprovalManagement(optional):
boolean
This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.
-
description(optional):
string
Description for Organization
-
dunsNumber(optional):
string
DUNS Number for Organization
-
dynamicProperty(optional):
object dynamicProperty
The value of the dynamic Property
-
externalOrganizationId(optional):
string
External organization id
-
id(optional):
string
Id of the Organization
-
members(optional):
array members
List of contact ids associated with an Organization
-
name(optional):
string
The name for Organization
-
orderPriceLimit(optional):
number
Its order limit value for the organization, if order limit is more than this value then approval is needed for the order
-
organizationLogo(optional):
string
File path of organization logo.
-
organizationLogoURL(optional):
string
Full URL of organization logo.
-
parentOrganization(optional):
object parentOrganization
Parent organization Info.
-
relativeRoles(optional):
array relativeRoles
List of organization roles.
-
repositoryId(optional):
string
repository Id of the Organization
-
secondaryAddresses(optional):
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(optional):
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.
-
taxExemptionCode(optional):
string
Tax exemption code for Organization
-
taxReferenceNumber(optional):
string
Tax Reference number for Organization
-
type(optional):
string
Type for Organization
-
uniqueId(optional):
string
Unique Id of the Organization
-
useExternalApprovalWebhook(optional):
boolean
Flag to enable/disable Order Approval check from External Webhook
-
vatReferenceNumber(optional):
string
Vat reference number for the organization
Nested Schema : ancestorOrganizations
Type:
array
List of ancestors for the Organization
Show Source
Nested Schema : billingAddress
Type:
object
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.
Show Source
-
address1(optional):
string
the address1 of the address
-
address2(optional):
string
the address2 of the address
-
address3(optional):
string
the address3 of the address
-
city(optional):
string
the city of the address
-
companyName(optional):
string
the company name of the address
-
country(optional):
string
the country of the address
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
the phone Number of the address
-
postalCode(optional):
string
the postal Code of the address
-
repositoryId(optional):
string
repository Id of the address
-
state(optional):
string
the state of the address
-
types(optional):
array types
The types tagged to the address
Nested Schema : contract
Type:
object
Contract
Show Source
-
catalog(optional):
object catalog
Catalog associated with contract
-
creationDate(optional):
string
Contract creation date time stamp
-
description(optional):
string
Description for contract
-
displayName(optional):
string
Display name for contract
-
endDate(optional):
string
Contract end date time stamp
-
externalContractReference(optional):
string
External contract reference
-
priceListGroup(optional):
object priceListGroup
Price ListGroup associated with contract
-
repositoryId(optional):
string
Repository Id of the contract
-
startDate(optional):
string
Contract start date time stamp
-
terms(optional):
object terms
Terms and Conditions
Nested Schema : dynamicProperty
Type:
object
The value of the dynamic Property
Nested Schema : parentOrganization
Type:
object
Parent organization Info.
Show Source
-
active(optional):
boolean
Active flag of the parent Organization.
-
externalOrganizationId(optional):
string
External organization id
-
id(optional):
string
Id of the parent Organization.
-
name(optional):
string
Name of the parent organization.
-
repositoryId(optional):
string
Repository Id of the parent organization.
Nested Schema : secondaryAddresses
Type:
array
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'.
Show Source
Nested Schema : shippingAddress
Type:
object
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.
Show Source
-
address1(optional):
string
the address1 of the address
-
address2(optional):
string
the address2 of the address
-
address3(optional):
string
the address3 of the address
-
city(optional):
string
the city of the address
-
companyName(optional):
string
the company name of shipping address
-
country(optional):
string
the country of the address
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
the phone Number of the company address
-
postalCode(optional):
string
the postal Code of the address
-
repositoryId(optional):
string
repository Id of the address
-
state(optional):
string
the state of the address
-
types(optional):
array types
The types tagged to the address
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
Active flag of the Organization.
-
externalOrganizationId(optional):
string
External organization id
-
id(optional):
string
Id of the Organization.
-
name(optional):
string
Name of the organization.
-
repositoryId(optional):
string
Repository Id of the organization.
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositoryId(optional):
string
repository Id of the address type
Nested Schema : catalog
Type:
object
Catalog associated with contract
Show Source
-
repositoryId(optional):
string
Repository Id of the catalog
Nested Schema : priceListGroup
Type:
object
Price ListGroup associated with contract
Show Source
-
repositoryId(optional):
string
Repository Id of the price list group
Nested Schema : terms
Type:
object
Terms and Conditions
Show Source
-
repositoryId(optional):
string
Repository Id of terms and conditions
-
terms(optional):
string
Terms and Conditions
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
Id of the contact
-
repositoryId(optional):
string
Contact Id of contact
Nested Schema : items
Type:
Show Source
object
-
function(optional):
string
Function of the role which can be admin, buyer or approver.
-
repositoryId(optional):
string
Repository Id of the role.
Nested Schema : items
Type:
Show Source
object
-
address(optional):
object address
Address created for the Organization.
-
addressType(optional):
string
Address type represents nick name of account if present else repository ID of address item.
Nested Schema : address
Type:
object
Address created for the Organization.
Show Source
-
address1(optional):
string
The address1 of the secondary address
-
address2(optional):
string
The address2 of the secondary address
-
address3(optional):
string
The address3 of the secondary address
-
city(optional):
string
The city of the secondary address
-
companyName(optional):
string
Company name of the secondary address
-
country(optional):
string
The country of the address
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
Phone Number of the address
-
postalCode(optional):
string
Postal Code of the address
-
repositoryId(optional):
string
repository Id of the address
-
state(optional):
string
The State of the address
-
types(optional):
array types
The types tagged to the address
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositoryId(optional):
string
repository Id of the address type
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositoryId(optional):
string
repository Id of the address type
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