1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Store
  4. Organization Members

listMembers

get

/ccstore/v1/organizationMembers

List Members. This operation is used to get the collection of customer profiles from Oracle Commerce Cloud. Optionally takes the x-ccasset-language headers to get translated content in another language.Also it optionally takes X-CCOrganization to specify current Organization of logged in user. It can also be used to return the list on a searched string and in a sorted order against various properties of profile.

Request

Supported Media Types
Query Parameters
  • This field determines the additional properties to be returned. Possible value for this query parameter is ???accessRights??? to include accessRights of the member.
  • This field filters the users which have the given roles assigned.Possible values are role ids which are comma separated.
  • This field determines if only organizational roles or all roles are to be returned for the member. Default value is 'organizationalRolesForCurrentOrganization'. Possible values are 'organizationalRolesForCurrentOrganization', 'allRolesForCurrentOrganization'.
  • 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 contact properties, 'firstName', 'lastName', 'email' and role
  • Specifies the sorting criteria for returned members. By default, results are sorted by ID in ascending order. You can specify a different field or sorting criteria as needed.
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listMembers_response
Type: object
Show Source
Nested Schema : items
Type: array
list of shopper profiles
Show Source
Nested Schema : sort
Type: array
Sorting criteria.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : parentOrganization
Type: object
This attribute is added for 'Account-Based Commerce', this is required only in case of 'Account-Based Commerce', this is the id of organization to which user is associated
Show Source
Nested Schema : roles
Type: array
List of user roles
Show Source
Nested Schema : billingAddress
Type: object
Default billing address of the organization
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address of the organization
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : associations
Type: array
Associations of the role with the organization member
Show Source
Nested Schema : relativeTo
Type: object
Organization in which the role applies. Present only if type is organizationalRole
Show Source
Nested Schema : items
Type: object
Show Source
  • Organization id to which the role is associated.If the type is global, relatedItemId is null
  • Type of the association.Possible values are - organization,global.
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "total":3,
    "totalResults":3,
    "offset":0,
    "limit":3,
    "sort":[
        {
            "property":"email",
            "order":"asc"
        },
        {
            "property":"firstName",
            "order":"asc"
        },
        {
            "property":"lastName",
            "order":"asc"
        }
    ],
    "items":[
        {
            "lastName":"jetu#$%^&test",
            "firstName":"jetu&",
            "customerContactId":"CRMID_1",
            "profileType":"b2b_user",
            "roles":[
                {
                    "associations":[
                        {
                            "relatedItemId":"or-100003",
                            "type":"organization"
                        }
                    ],
                    "function":"buyer",
                    "relativeTo":{
                        "id":"or-100003"
                    },
                    "repositoryId":"100006",
                    "name":"Buyer",
                    "id":"100006",
                    "type":"organizationalRole"
                }
            ],
            "repositoryId":"120015",
            "receiveEmail":"yes",
            "active":true,
            "id":"120015",
            "locale":"en",
            "parentOrganization":{
                "repositoryId":"100003",
                "name":"sample12",
                "active":true,
                "description":null,
                "shippingAddress":null,
                "secondaryAddresses":{
                },
                "billingAddress":null,
                "id":"100003",
                "externalOrganizationId":"EXT_ORG_1"
            },
            "email":"test&@example.com"
        },
        {
            "lastName":"!@#$%^&*",
            "firstName":"test1",
            "customerContactId":"CRMID_1",
            "profileType":"b2b_user",
            "roles":[
                {
                    "associations":[
                        {
                            "relatedItemId":null,
                            "type":"global"
                        }
                    ],
                    "function":"buyer",
                    "relativeTo":{
                        "id":"or-100003"
                    },
                    "repositoryId":"100006",
                    "name":"Buyer",
                    "id":"100006",
                    "type":"organizationalRole"
                }
            ],
            "repositoryId":"130000",
            "receiveEmail":"yes",
            "active":true,
            "id":"130000",
            "locale":"en",
            "parentOrganization":{
                "repositoryId":"100001",
                "name":"sample1",
                "active":true,
                "description":null,
                "shippingAddress":null,
                "secondaryAddresses":{
                },
                "billingAddress":null,
                "id":"100001",
                "externalOrganizationId":"EXT_ORG_1"
            },
            "email":"test1@abc.com"
        },
        {
            "lastName":"Test",
            "firstName":"test",
            "customerContactId":"CRMID_1",
            "profileType":"b2b_user",
            "roles":[
                {
                    "associations":[
                        {
                            "relatedItemId":"or-100003",
                            "type":"organization"
                        }
                    ],
                    "function":"buyer",
                    "relativeTo":{
                        "id":"or-100003"
                    },
                    "repositoryId":"100006",
                    "name":"Buyer",
                    "id":"100006",
                    "type":"organizationalRole"
                }
            ],
            "repositoryId":"120008",
            "receiveEmail":"yes",
            "active":true,
            "id":"120008",
            "locale":"en",
            "parentOrganization":{
                "repositoryId":"100002",
                "name":"sample2",
                "active":true,
                "description":null,
                "shippingAddress":null,
                "secondaryAddresses":{
                },
                "billingAddress":null,
                "id":"100002",
                "externalOrganizationId":"EXT_ORG_1"
            },
            "email":"test@example.com"
        }
    ]
}

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.| |22000|If the profile id passes is null or empty| |22001|If there was any internal error while getting the profile| |10002|The value x for parameter 'y' is invalid. 'y' can be 'limit', 'offset' or 'sort'.| |23044|If an invalid value for includeRoles query parameter is given|
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