searchProfiles
get
/ccappagent/v1/profiles
Search Profiles. Get profiles by the search criteria entered. The search criteria include First Name, Last Name, Email, Postal Code, Phone Number .
Request
Supported Media Types
- application/json
Query Parameters
-
fields(optional): string
This controls which fields are returned in the response body. Applicable when queryFormat=SCIM
-
limit(optional): integer
This is the field to specify the number of records to be fetched per REST call. Applicable when queryFormat=SCIM
-
offset(optional): integer
This field specifies the offset/starting index from which data to be fetched. Applicable when queryFormat=SCIM
-
q: string
Search criteria - Following are the fields supported by this param: |Field|Type|Description| |------------------|------------------|------------------| |firstName|string|First name of the profile| |lastName|string|Last name of the profile| |phoneNumber|string|The phone Number of the shipping address.| |pageNumber|integer|The page number for pagination| |postalCode|string|The postal Code of the shipping address| |limit|integer|The batch size of the order records to be fetched together.| |email|string|email of the profile| Search criteria in SCIM Format should be as: firstName co "Kim". Searching with custom properties: For Text Search, add prefix "dynProps_" (case sensitive) to the name of custom property being searched. For example: For a custom property with name as isVipCustomer, use search criteria field as dynProps_isVipCustomer. For SCIM Search, use the custom property name as the search criteria field without any prefix. For example: For a custom property with name as isVipCustomer, use search criteria field as isVipCustomer.
-
queryFormat(optional): string
Should be SCIM if we are searching using SCIM query format
-
sort(optional): string
This field specifies the sort order of the list to be fetched. Applicable when queryFormat=SCIM
-
totalResults(optional): boolean
Indicates if the total results should be included in the response. Applicable when queryFormat=SCIM
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : searchProfiles_response
Type:
Show Source
object
-
items(optional):
array items
List of customer profiles. SCIM query response contains this property.
-
limit(optional):
integer
Limit of number of profiles. SCIM query response contains this property.
-
offset(optional):
integer
Numeric offset of the first item returned. SCIM query response contains this property.
-
profileList(optional):
array profileList
List of profiles. Non-SCIM query response contains this property.
-
sort(optional):
array sort
An array that specifies the sort order. SCIM query response contains this property.
-
total(optional):
integer
Total number of profiles. Deprecated. SCIM query response contains this property.
-
totalNoOfProfiles(optional):
integer
Total number of customer profiles present in search result. Non-SCIM query response contains this property.
-
totalResults(optional):
integer
Total number of profiles. SCIM query response contains this property.
Nested Schema : items
Type:
array
List of customer profiles. SCIM query response contains this property.
Show Source
Nested Schema : profileList
Type:
array
List of profiles. Non-SCIM query response contains this property.
Show Source
Nested Schema : sort
Type:
array
An array that specifies the sort order. SCIM query response contains this property.
Show Source
Nested Schema : items
Type:
Show Source
object
-
customerContactId(optional):
string
The external customer contact id.
-
email(optional):
string
Email.
-
firstName(optional):
string
First name.
-
id(optional):
string
Profile ID.
-
lastName(optional):
string
Last name.
-
parentOrganization(optional):
object parentOrganization
The parent Organization associated with the B2B customer profile.
-
profileType(optional):
string
The type of the user. Possible values are b2b_user and b2c_user.
-
repositoryId(optional):
string
Profile ID.
-
secondaryOrganizations(optional):
array secondaryOrganizations
The secondary organizations associated with the B2B customer profile.
-
shippingAddress(optional):
object shippingAddress
Default shipping address of the profile (Deprecated, please use ???shippingAddresses??? instead).
Nested Schema : parentOrganization
Type:
object
The parent Organization associated with the B2B customer profile.
Show Source
-
active(optional):
boolean
Indicates whether the organization is active
-
externalOrganizationId(optional):
string
External organization id
-
name(optional):
string
The name of the organization.
-
repositoryId(optional):
string
The repository id of the comment record.
Nested Schema : secondaryOrganizations
Type:
array
The secondary organizations associated with the B2B customer profile.
Show Source
Nested Schema : shippingAddress
Type:
object
Default shipping address of the profile (Deprecated, please use ???shippingAddresses??? instead).
Show Source
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
The phone Number of the shipping address.
-
postalCode(optional):
string
The postal Code of the shipping address.
-
repositoryId(optional):
string
ID of shipping address.
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
Indicates whether the organization is active
-
externalOrganizationId(optional):
string
External organization id
-
name(optional):
string
The name of the organization.
-
repositoryId(optional):
string
The repository id of the comment record.
Nested Schema : items
Type:
Show Source
object
-
hasIncompleteOrder(optional):
boolean
Indicates whether profile has incomplete order or not.
-
latestOrderId(optional):
string
Id of latest order placed by customer.
-
numberOfOrders(optional):
integer
Total number of orders for the customer profile.
-
profileDetail(optional):
object profileDetail
Details of the customer profile
Nested Schema : profileDetail
Type:
object
Details of the customer profile
Show Source
-
customerContactId(optional):
string
The external customer contact id.
-
email(optional):
string
Email.
-
firstName(optional):
string
First name.
-
id(optional):
string
Profile ID.
-
lastName(optional):
string
Last name.
-
repositoryId(optional):
string
Profile ID.
-
shippingAddress(optional):
object shippingAddress
Default shipping address of the profile (Deprecated, please use ???shippingAddresses??? instead).
Nested Schema : shippingAddress
Type:
object
Default shipping address of the profile (Deprecated, please use ???shippingAddresses??? instead).
Show Source
-
externalAddressId(optional):
string
External address id
-
phoneNumber(optional):
string
The phone Number of the shipping address.
-
postalCode(optional):
string
The postal Code of the shipping address.
-
repositoryId(optional):
string
ID of shipping address.
Nested Schema : items
Type:
Show Source
object
-
order(optional):
string
Whether this property should be sorted ascending ("asc") or descending ("dsc"). SCIM query response contains this property.
-
property(optional):
string
The name of the property to use for sorting. SCIM query response contains this property.
Example Response (application/json)
{
"profileList":[
{
"profileDetail":{
"firstName":"Kim",
"lastName":"Anderson",
"customerContactId":"CRMID_1",
"repositoryId":"se-570031",
"shippingAddress":{
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":"212-555-1977",
"postalCode":"13202",
"repositoryId":"se-980031"
},
"id":"se-570031",
"parentOrganization":null,
"email":"kim@example.com"
},
"numberOfOrders":43,
"latestOrderId":"o10042",
"hasIncompleteOrder":false
}
],
"hasMore":false,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagentui/v1/profiles?q=%7BfirstName=kim%2ClastName=%22%22%2Climit=20%2CpageNumber=0%2CrequireCount=false%7D"
}
],
"totalNoOfProfiles":1
}
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:
Below is the list of error codes specific to Text Search:
|Error Code|Description|
|------------------|------------------|
|100001|Search client internal error.|
|100002|Invalid date format|
|100003|No pagination info passed in the search reuqest.|
|100004|Invalid search criteria passed in search request.|
|100006|Invalid boolean value.|
|100013|Text search configuration is not enabled. Please enable text search to fetch the records
|300001|Internal error occurred while performing search operation|
|300002|One or more properties entered in the search criteria are invalid|
|300003|One or more properties entered in the search criteria are not accessible by the Agent user|
|300004|The property types of multiple dynamic properties entered in a single search criteria are not compatible with each other|
Below is the list of error codes specific to SCIM Search:
|Error Code|Description|
|------------------|------------------|
|85003|Invalid attribute in query
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