createProfileRequest
post
/ccstore/v1/profileRequests
Creates profile request. This operation is used to create profile request in Oracle Commerce Cloud for a customer.
Request
Supported Media Types
- application/json
Root Schema : createProfileRequest_request
Type:
Show Source
object
-
profile:
object profile
Profile
-
requestedOrganization(optional):
object requestedOrganization
Requested Organization
-
requesterComments(optional):
string
Requester comments given at time of creating request
Example:
{
"profile":{
"firstName":"First name",
"lastName":"last name",
"customerContactId":"CRMID_1",
"email":"user@temp.com"
},
"requesterComments":"Some comments",
"requestedOrganization":{
"name":"Oracle"
}
}
Nested Schema : profile
Type:
object
Profile
Show Source
-
customerContactId(optional):
string
The external customer contact id.
-
email:
string
email id of profile
-
firstName:
string
First name of the profile
-
lastName:
string
Last name of the profile
-
receiveEmail(optional):
string
Receive email newsletters
Nested Schema : requestedOrganization
Type:
object
Requested Organization
Show Source
-
id(optional):
string
ID of an Organization
-
name(optional):
string
The name for Organization
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : createProfileRequest_response
Type:
Show Source
object
-
id(optional):
string
Id of Profile Request. This will be removed when enableProfileRegistrationEmailCheck site setting is enabled.
-
message(optional):
string
A descriptive message indicating profile creation will be displayed when enableProfileRegistrationEmailCheck site setting is enabled.
Example Response (application/json)
{
"links":[
{
"rel":"self",
"href":"http://localhost:8080/ccstoreui/v1/profileRequests"
}
],
"message":"Once registration has successfully completed, you'll receive account activation details in your registration email's inbox."
}
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|
|------------------|------------------|
|101015|An existing B2C shopper cannot submit a registration request.|
|00004|Data value too long.|
|101001|Invalid Input for registration request.|
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