1. REST API for Oracle Commerce Cloud 21C
  2. Tasks
  3. Agent
  4. Customers

createProfile

post

/ccagent/v1/profiles

Create Profile. Creates new user and generates password , if user does not exists for a given email id. Dynamic Properties of profile can be added to the request using the key value pair structure ("dynamicPropertyKey":"dynamicPropertyValue"). These property values can take the type from any of boolean, date, float, string, timestamp, enumerated, big string. Takes additonal header parameter x-ccsite corresponding to which site specific properties should be set. If x-ccsite value is not provided, it indicates default site.

Request

Supported Media Types
Header Parameters
Body ()
Root Schema : createProfile_request
Type: object
Show Source
Example:
{
    "dynamicPropertyMaritalStatus":"Married",
    "firstName":"kim",
    "lastName":"anderson",
    "password":"kim1234",
    "GDPRProfileP13nConsentGranted":false,
    "gender":"female",
    "receiveEmail":"yes",
    "dateOfBirth":"",
    "email":"kim@example.com",
    "shippingAddresses":[
        {
            "lastName":"Black",
            "country":"United States",
            "types":[
                {
                    "id":"ss-100001"
                }
            ],
            "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",
            "types":[
                {
                    "id":"ss-100001"
                }
            ],
            "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"
        }
    ]
}
Nested Schema : shippingAddress
Type: object
Default shipping address of the profile (Deprecated, please use 'shippingAddresses' instead).
Show Source
Nested Schema : shippingAddresses
Type: array
List of shipping addresses associated with profile.
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : createProfile_response
Type: object
Show Source
  • The ID of the profile to retrieve. This will be removed when enableProfileRegistrationEmailCheck site setting is enabled.
  • 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:9080/ccagent/v1/profiles"
        }
    ],
    "id":"428738"
}

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| |------------------|------------------| |23012|No last name specified| |23013|No first name specified| |22003|Email Id passed in is null or empty| |200019|There was a problem creating your account. Please try again.| |22004|An internal error occurred while processing input request.| |23006|Invalid email address specified| |22024|{0}({1}) must be a String| |13036|One of the dynamic properties is not writable by the Agent user|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top