1. Oracle Commerce Cloud October 2017
  2. Tasks
  3. Store
  4. Organizations

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
limit
Type: string
This is the field to determine number of records to be fetched per REST call.
offset
Type: string
This field determines the offset/starting index from which data to be fetched.
q
Type: string
Query string built as per the SCIM standards that helps to search entered string across account properties like 'name'.
sort
Type: 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.
Body
Root Schema : listOrganizations_response
Nested Schema : items
Type: array
list of organizations
Nested Schema : items
Type: object
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.
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'.
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.
Nested Schema : items
Type: object
Nested Schema : address
Type: object
Address created for the Organization.
Example application/json

{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "lastPublishedTime":-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"
        }
    ],
    "___etag___":"eyJ2ZXJzaW9uIjowLCJ1cmkiOiJvcmdhbml6YXRpb25zL2xpc3QiLCJoYXNoIjoiaWhxdkFRPT0ifQ=="
}
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
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{
  "total": 1,
  "totalResults": 1,
  "offset": 0,
  "limit": 1,
  "lastPublishedTime": -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"
  }],
  "___etag___": "eyJ2ZXJzaW9uIjowLCJ1cmkiOiJvcmdhbml6YXRpb25zL2xpc3QiLCJoYXNoIjoiaWhxdkFRPT0ifQ=="
}