1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Store
  4. Profiles

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
Nested Schema : shippingAddress
Type: object
Default shipping address of the profile (Deprecated, please use 'shippingAddresses' instead).
Nested Schema : shippingAddresses
Type: array
List of shipping addresses associated with profile.
Nested Schema : items
Type: object

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : createProfile_response
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
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

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"}