Oracle Commerce Cloud October 2017

createProfile

post

/ccstore/v1/profiles

Create Profile. If email does not exist in the repository create a new profile with email and password and return the id else return an error message.Optionally takes the x-ccasset-language header to get translated content in another language. Dynamic Properties can also be passed like any other attribute ("dynamicPropertyKey":"dynamicPropertyValue").

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| |22024|{0}({1}) must be a String|

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:

{
  "dynamicPropertyMaritalStatus": "Married",
  "firstName": "kim",
  "lastName": "anderson",
  "password": "kim1234",
  "gender": "female",
  "receiveEmail": "yes",
  "dateOfBirth": "",
  "email": "kim@gmail.com",
  "shippingAddresses": [
    {
      "lastName": "Black",
      "country": "United States",
      "address3": "",
      "address2": "",
      "city": "Wake Forest",
      "prefix": "",
      "address1": "405 Example Street",
      "defaultCountryCode": "US",
      "postalCode": "27587",
      "jobTitle": "",
      "companyName": "",
      "county": "",
      "isDefaultAddress": true,
      "suffix": "",
      "selectedCountry": "US",
      "firstName": "Jack",
      "phoneNumber": "555123456",
      "alias": "Address",
      "faxNumber": "",
      "middleName": "",
      "state": "North Carolina",
      "selectedState": "NC",
      "state_ISOCode": "US-NC"
    },
    {
      "lastName": "Hill",
      "country": "United States",
      "address3": "",
      "address2": "",
      "city": "Wake Forest",
      "prefix": "",
      "address1": "415 Example Road",
      "defaultCountryCode": "US",
      "postalCode": "27587",
      "jobTitle": "",
      "companyName": "",
      "county": "",
      "isDefaultAddress": false,
      "suffix": "",
      "selectedCountry": "US",
      "firstName": "Jill",
      "phoneNumber": "55512345",
      "alias": "Address##0",
      "faxNumber": "",
      "middleName": "",
      "state": "North Carolina",
      "selectedState": "NC",
      "state_ISOCode": "US-NC"
    }
  ]
}

Sample Response Payload returned by endpoint:

{"id": "110026"}