1. REST API for Oracle Commerce Cloud 21C
  2. Tasks
  3. Admin
  4. Profiles

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
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)
{
    "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| |100200|Invalid profile type passed.| |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.| |180106|One or more address type ID is invalid| |
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