1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Admin
  4. Organizations

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
Query Parameters
  • 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 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'
  • 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.
  • 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.
  • This is the field to determine number of records to be fetched per REST call.
  • This field determines the offset/starting index from which data to be fetched.
  • Query string built as per the SCIM standards that helps to search entered string across account properties like 'name' and also dynamic account properties.
  • This field determines the sort order of the list to be fetched.
  • 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.
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listOrganizations_response
Type: object
Show Source
Nested Schema : items
Type: array
list of organizations
Show Source
Nested Schema : items
Type: object
Show Source
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
Nested Schema : contract
Type: object
Contract
Show Source
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Nested Schema : members
Type: array
List of contact ids associated with an Organization
Show Source
Nested Schema : parentOrganization
Type: object
Parent organization Info.
Show Source
Nested Schema : relativeRoles
Type: array
List of organization roles.
Show Source
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
Nested Schema : items
Type: object
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : catalog
Type: object
Catalog associated with contract
Show Source
Nested Schema : priceListGroup
Type: object
Price ListGroup associated with contract
Show Source
Nested Schema : terms
Type: object
Terms and Conditions
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : address
Type: object
Address created for the Organization.
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
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.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top