Oracle Commerce Cloud October 2017

createProfile

post

/ccadmin/v1/profiles

Create Profile. This operation is used to create a profile in Oracle Commerce Cloud for a customer. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types

application/json

Header Parameters

X-CCAsset-Language: Type: string

The asset language of the request

Body Parameter

Root Schema : createProfile_request

Example


{
    "dynamicPropertyMaritalStatus":"Single",
    "firstName":"Pratiksha",
    "lastName":"Oracle123",
    "receiveEmail":"no",
    "email":"abc@ora.com"
}

Properties

email: Type: string

Required: true

Specifies email id of a customer.
firstName: Type: string

Required: true

Specifies first name of a customer.
lastName: Type: string

Required: true

Specifies last name of a customer.
login: Type: string

Login id to be used.Defaults for email if not passed.
receiveEmail: Type: string

Required: true

Indicates whether the customer should receive marketing emails on the current site. Can be yes or no.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : createProfile_response

Properties

id: Type: string

The customer profile id.

Example application/json


{
    "id":"110026"
}

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| |------------------|------------------| |22003|If the email passed is null or empty| |22004|If there was any internal error while creating the profile| |22005|If the password passed is null or empty| |22007|If invalid input is provided| |89001|If invalid roles are provided| |22024|{0}({1}) must be a String| |22025|Format for loyaltyPrograms is incorrect. Please refer to API doc for more information| |22026|{0} is either missing or incorrect.| |22027|Invalid state is provided.

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{
  "firstName": "bcd",
  "lastName": "K",
  "profileType": "b2b_user",
  "gender": "female",
  "loyaltyPrograms": [
    {
      "programName": "XTRAREWARDS",
      "membershipId": "abc123",
      "programId": "prog1",
      "status": "Enrolled"
    },
    {
      "programName": "XTRAREWARDS",
      "membershipId": "xyz123",
      "programId": "prog2",
      "status": "RequestForEnrollment"
    }
  ],
  "roles": [{
    "function": "buyer",
    "relativeTo": {"id": "900004"}
  }],
  "receiveEmail": "yes",
  "active": true,
  "dateOfBirth": null,
  "parentOrganization": "900004",
  "email": "bcd@abc.com",
  "daytimeTelephoneNumber": "212-555-1977"
}

Sample Response Payload returned by endpoint:

{"id": "110026"}