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

listMembers

get

/ccagent/v1/organizationMembers

List Members. This operation is used to get the collection of customer profiles from Oracle Commerce Cloud. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile. Optionally takes the x-ccasset-language header to get translated content in another language. It can also be used to return the list on a searched string and in a sorted order against various properties of profile. Also it takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization.

Request

Supported Media Types
Query Parameters
  • This field filters the users which have the given roles assigned.Possible values are role ids which are comma separated.
  • This query param value if passed true, would give the could of secondary organizations associated with the profile
  • 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
  • This field determines the sort order of the list to be fetched.
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":4,
    "totalResults":4,
    "offset":0,
    "limit":2,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/organizationMembers?limit=2&q=firstName%20co%20%22l%22"
        },
        {
            "rel":"next",
            "href":"http://localhost:9080/ccagentui/v1/organizationMembers?limit=2&q=firstName%20co%20%22l%22&offset=2"
        }
    ],
    "items":[
        {
            "lastName":"Paprocki",
            "GDPRProfileP13nConsentDate":"2018-03-23T09:02:31.955Z",
            "GDPRProfileP13nConsentGranted":true,
            "customerContactId":"CRMID_1",
            "roles":[
                {
                    "associations":[
                        {
                            "relatedItemId":"or-100001",
                            "type":"organization"
                        }
                    ],
                    "function":"buyer",
                    "relativeTo":{
                        "id":"or-100001"
                    },
                    "repositoryId":"100002",
                    "name":"Buyer",
                    "id":"100002",
                    "type":"organizationalRole"
                }
            ],
            "receiveEmail":"yes",
            "active":true,
            "locale":"en",
            "parentOrganization":{
                "repositoryId":"or-100001",
                "punchoutUserId":"100012",
                "name":"National Discount Auto Parts",
                "active":true,
                "description":null,
                "shippingAddress":{
                    "repositoryId":"160063"
                },
                "secondaryAddresses":{
                    "Address2":{
                        "repositoryId":"160063"
                    },
                    "Address1":{
                        "repositoryId":"ci-110023"
                    }
                },
                "billingAddress":{
                    "repositoryId":"160063"
                },
                "id":"or-100001",
                "externalOrganizationId":"EXT_ORG_1"
            },
            "receiveEmailDate":"2018-03-23T09:02:31.955Z",
            "orderPriceLimit":null,
            "firstName":"la",
            "profileType":"b2b_user",
            "repositoryId":"bb-110000",
            "id":"bb-110000",
            "secondaryOrganizations":[
            ],
            "email":"lpaprocki@example.com"
        },
        {
            "lastName":"Dilliard",
            "GDPRProfileP13nConsentDate":"2018-03-23T09:02:31.955Z",
            "GDPRProfileP13nConsentGranted":true,
            "customerContactId":"CRMID_1",
            "roles":[
                {
                    "associations":[
                        {
                            "relatedItemId":"or-100001",
                            "type":"organization"
                        }
                    ],
                    "function":"admin",
                    "relativeTo":{
                        "id":"or-100001"
                    },
                    "repositoryId":"100001",
                    "name":"Administrator",
                    "id":"100001",
                    "type":"organizationalRole"
                },
                {
                    "associations":[
                        {
                            "relatedItemId":"or-100001",
                            "type":"organization"
                        }
                    ],
                    "function":"buyer",
                    "relativeTo":{
                        "id":"or-100001"
                    },
                    "repositoryId":"100002",
                    "name":"Buyer",
                    "id":"100002",
                    "type":"organizationalRole"
                }
            ],
            "receiveEmail":"yes",
            "active":true,
            "locale":"en",
            "parentOrganization":{
                "repositoryId":"or-100001",
                "punchoutUserId":"100012",
                "name":"National Discount Auto Parts",
                "active":true,
                "description":null,
                "shippingAddress":{
                    "repositoryId":"160063"
                },
                "secondaryAddresses":{
                    "Address2":{
                        "repositoryId":"160063"
                    },
                    "Address1":{
                        "repositoryId":"ci-110023"
                    }
                },
                "billingAddress":{
                    "repositoryId":"160063"
                },
                "id":"or-100001",
                "externalOrganizationId":"EXT_ORG_1"
            },
            "receiveEmailDate":"2018-03-23T09:02:31.955Z",
            "orderPriceLimit":null,
            "firstName":"Leota",
            "profileType":"b2b_user",
            "repositoryId":"bb-110006",
            "id":"bb-110006",
            "email":"leota@example.com",
            "secondaryOrganizations":[
            ]
        }
    ],
    "___etag___":"eyJ2ZXJzaW9uIjowLCJ1cmkiOiIvY2NhZ2VudC92MS9vcmdhbml6YXRpb25NZW1iZXJzIiwiaGFzaCI6IlFQMHpsQT09In0="
}

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.| |22010|If the profile id passed is not associated to the account of the profileId passed in the AgentContext header.| |22000|If the profile id passed 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'.| |82005000|If there is an error while processing the AgentContext header. Possible reasons include invalid profileId, incorrect JSON format or other errors| |89103|If no shopperProfileId is passed in the AgentContext header| |89102|If the shopperProfile passed in the AgentContext header or the associated account is inactive| |89101|If the shopperProfile passed in the AgentContext header is not an administrator for the account|
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