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
- application/json
Query Parameters
-
includeSecondaryOrganizationsCount(optional): string
This query param value if passed true, would give the could of secondary organizations associated with the profile
-
limit(optional): string
This is the field to determine number of records to be fetched per REST call.
-
offset(optional): string
This field determines the offset/starting index from which data to be fetched.
-
q(optional): string
Query string built as per the SCIM standards that helps to search entered string across contact properties, 'firstName', 'lastName', 'email' and role
-
sort(optional): string
This field determines the sort order of the list to be fetched.
Header Parameters
-
X-CCAgentContext: string
The Agent Context is a JSON object with shopperProfileId as a property.
-
X-CCAsset-Language(optional): string
The asset language of the request
-
X-CCOrganization(optional): string
The organization Id associated with the shopper profile
-
X-CCSite(optional): string
The site Id to retrieve the site specific shopper profile properties
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listMembers_response
Type:
Show Source
object
-
items(optional):
array items
list of shopper profiles
-
limit(optional):
string
Number of records to be fetched.
-
total(optional):
string
Total number of records present in database matching the searched string.
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
This is active status of the profile should be true or false.
-
customerContactId(optional):
string
The external customer contact id.
-
email(optional):
string
the email address of the profile
-
firstName(optional):
string
the first name of the profile
-
id(optional):
string
the id of the profile to retrieve
-
lastName(optional):
string
the last name of the profile
-
locale(optional):
string
the locale of the request/response
-
parentOrganization(optional):
object parentOrganization
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
-
profiletype(optional):
string
This attribute is added for account-based commerce. It's value is 'b2b_user'
-
receiveEmail(optional):
string
this is email marketing flag. can be yes or no
-
repositoryId(optional):
string
the id of the profile
-
roles(optional):
array roles
List of user roles
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
-
active(optional):
boolean
This is active status of the profile should be true or false.
-
billingAddress(optional):
object billingAddress
Default billing address of the profile
-
description(optional):
string
the description of the parent organization
-
externalOrganizationId(optional):
string
External organization id
-
id(optional):
string
the id of the parent organization
-
name(optional):
string
the name of the parent organization
-
repositoryId(optional):
string
the id of the parent organization
-
secondaryAddresses(optional):
object secondaryAddresses
List of shipping addresses associated with the profile.
-
shippingAddress(optional):
object shippingAddress
Default shipping address of the profile
Nested Schema : billingAddress
Type:
object
Default billing address of the profile
Show Source
-
repositoryId(optional):
string
the id of the billing address
Nested Schema : secondaryAddresses
Type:
object
List of shipping addresses associated with the profile.
Show Source
-
AddressType(optional):
object AddressType
Address type represents nick-name of address.
Nested Schema : shippingAddress
Type:
object
Default shipping address of the profile
Show Source
-
repositoryId(optional):
string
the id of the shipping address
Nested Schema : AddressType
Type:
object
Address type represents nick-name of address.
Show Source
-
repositoryId(optional):
string
Repository ID of the shipping address
Nested Schema : items
Type:
Show Source
object
-
function(optional):
string
the function of the role
-
repositoryId(optional):
string
the repository id of the role
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":[
{
"function":"buyer",
"relativeTo":"or-100002",
"repositoryId":"100002"
}
],
"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":[
{
"function":"admin",
"repositoryId":"100001"
},
{
"function":"buyer",
"repositoryId":"100002"
}
],
"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|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code