1. REST API for Oracle Commerce Cloud December 2017
  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
  • 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 contact properties, 'firstName', 'lastName', 'email' and role
sort
Type: string
This field determines the sort order of the list to be fetched.
Header Parameters
X-CCAsset-Language
Type: string
The asset language of the request
X-CCOrganization
Type: string
Current organization context of the logged in user

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : listMembers_response
Nested Schema : items
Type: array
list of shopper profiles
Nested Schema : items
Type: object
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
Nested Schema : roles
Type: array
List of user roles
Nested Schema : billingAddress
Type: object
Default billing address of the profile
Nested Schema : secondaryAddresses
Type: object
List of shipping addresses associated with the profile.
Nested Schema : shippingAddress
Type: object
Default shipping address of the profile
Nested Schema : AddressType
Type: object
Address type represents nick-name of address.
Nested Schema : items
Type: object
Example application/json

{
    "total":3,
    "totalResults":3,
    "offset":0,
    "limit":3,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/organizationMembers?limit=20&offset=0&sort=email:asc&q=lastName%20co%20%22test%22%20or%20email%20co%20%22test%22%20and%20profileType%20eq%20%22b2b_user%22%20and%20parentOrganization%20eq%20%22null%22%20and%20roles.function%20eq%20%22buyer%22"
        }
    ],
    "sort":[
        {
            "property":"email",
            "order":"asc"
        },
        {
            "property":"firstName",
            "order":"asc"
        },
        {
            "property":"lastName",
            "order":"asc"
        }
    ],
    "items":[
        {
            "lastName":"jetu#$%^&test",
            "firstName":"jetu&",
            "profileType":"b2b_user",
            "roles":[
                {
                    "function":"buyer",
                    "repositoryId":"100006"
                }
            ],
            "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"
            },
            "email":"test&@test.com"
        },
        {
            "lastName":"!@#$%^&*",
            "firstName":"test1",
            "profileType":"b2b_user",
            "roles":[
                {
                    "function":"buyer",
                    "repositoryId":"100006"
                }
            ],
            "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"
            },
            "email":"test1@abc.com"
        },
        {
            "lastName":"Test",
            "firstName":"test",
            "profileType":"b2b_user",
            "roles":[
                {
                    "function":"buyer",
                    "repositoryId":"100006"
                }
            ],
            "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"
            },
            "email":"test@test.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'.|
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": 3,
  "totalResults": 3,
  "offset": 0,
  "limit": 3,
  "links": [{
    "rel": "self",
    "href": "http://localhost:8080/ccstore/v1/organizationMembers?limit=20&offset=0&sort=email:asc&q=lastName%20co%20%22test%22%20or%20email%20co%20%22test%22%20and%20profileType%20eq%20%22b2b_user%22%20and%20parentOrganization%20eq%20%22null%22%20and%20roles.function%20eq%20%22buyer%22"
  }],
  "sort": [
    {
      "property": "email",
      "order": "asc"
    },
    {
      "property": "firstName",
      "order": "asc"
    },
    {
      "property": "lastName",
      "order": "asc"
    }
  ],
  "items": [
    {
      "lastName": "jetu#$%^&test",
      "firstName": "jetu&",
      "profileType": "b2b_user",
      "roles": [{
        "function": "buyer",
        "repositoryId": "100006"
      }],
      "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"
      },
      "email": "test&@test.com"
    },
    {
      "lastName": "!@#$%^&*",
      "firstName": "test1",
      "profileType": "b2b_user",
      "roles": [{
        "function": "buyer",
        "repositoryId": "100006"
      }],
      "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"
      },
      "email": "test1@abc.com"
    },
    {
      "lastName": "Test",
      "firstName": "test",
      "profileType": "b2b_user",
      "roles": [{
        "function": "buyer",
        "repositoryId": "100006"
      }],
      "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"
      },
      "email": "test@test.com"
    }
  ]
}