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

listOrganizations

get

/ccagent/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. nIt has support for fields also

Request

Supported Media Types
Query Parameters
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":5,
    "totalResults":5,
    "offset":0,
    "limit":20,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/organizations?limit=20&offset=0&q=name%20co%20%22US%22"
        }
    ],
    "sort":[
        {
            "property":"name",
            "order":"asc"
        }
    ],
    "items":[
        {
            "approvalRequired":false,
            "repositoryId":"or-100005",
            "name":"US Motor Works - Wholesale",
            "active":true,
            "description":null,
            "shippingAddress":{
                "country":"US",
                "externalAddressId":"EXT_ADDR_1",
                "phoneNumber":"440-780-8425",
                "address2":"Geauga County",
                "city":"Chagrin Falls",
                "address1":"98 Connecticut Ave Nw",
                "companyName":"US Motor Works - Wholesale",
                "postalCode":"44023",
                "repositoryId":"ci-110028",
                "state":"OH"
            },
            "secondaryAddresses":{
                "Address1":{
                    "country":"US",
                    "externalAddressId":"EXT_ADDR_1",
                    "phoneNumber":"440-780-8425",
                    "address2":"Geauga County",
                    "city":"Chagrin Falls",
                    "address1":"98 Connecticut Ave Nw",
                    "companyName":"US Motor Works - Wholesale",
                    "postalCode":"44023",
                    "repositoryId":"ci-110028",
                    "state":"OH"
                }
            },
            "billingAddress":{
                "country":"US",
                "externalAddressId":"EXT_ADDR_1",
                "phoneNumber":"440-780-8425",
                "address2":"Geauga County",
                "city":"Chagrin Falls",
                "address1":"98 Connecticut Ave Nw",
                "companyName":"US Motor Works - Wholesale",
                "postalCode":"44023",
                "repositoryId":"ci-110028",
                "state":"OH"
            },
            "id":"or-100005",
            "externalOrganizationId":"EXT_ORG_1"
        },
        {
            "approvalRequired":false,
            "repositoryId":"or-100002",
            "name":"US Motor Works, Inc.",
            "active":true,
            "description":"US Motor Works, Inc.",
            "shippingAddress":{
                "country":"US",
                "externalAddressId":"EXT_ADDR_1",
                "phoneNumber":"408-752-3500",
                "address2":"Santa Clara County",
                "city":"San Jose",
                "address1":"7 W Jackson Blvd",
                "companyName":"US Motor Works, Inc.",
                "postalCode":"95111",
                "repositoryId":"ci-110029",
                "state":"CA"
            },
            "secondaryAddresses":{
                "Address1":{
                    "country":"US",
                    "externalAddressId":"EXT_ADDR_1",
                    "phoneNumber":"408-752-3500",
                    "address2":"Santa Clara County",
                    "city":"San Jose",
                    "address1":"7 W Jackson Blvd",
                    "companyName":"US Motor Works, Inc.",
                    "postalCode":"95111",
                    "repositoryId":"ci-110029",
                    "state":"CA"
                }
            },
            "billingAddress":{
                "country":"US",
                "externalAddressId":"EXT_ADDR_1",
                "phoneNumber":"408-752-3500",
                "address2":"Santa Clara County",
                "city":"San Jose",
                "address1":"7 W Jackson Blvd",
                "companyName":"US Motor Works, Inc.",
                "postalCode":"95111",
                "repositoryId":"ci-110029",
                "state":"CA"
            },
            "id":"or-100002",
            "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| |------------------|------------------| |100020|Invalid Input| |100019|Internal Error| |100000|If input passed is invalid| |100001|If there was no organization found with the given id|
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