createMember

post

/ccagent/v1/organizationMembers

Create Member. This operation is used to create a profile in Oracle Commerce Cloud for a customer. Takes X-CCAgentContext header which is a JSON object with 'shopperProfileId' as a property. If 'shopperProfileId' is not provided, it is considered as an anonymous profile. Also it takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
Header Parameters
Body ()
Root Schema : createMember_request
Type: object
Show Source
Example:
{
    "firstName":"Leota",
    "lastName":"Dilliard",
    "GDPRProfileP13nConsentGranted":true,
    "dynamicProperty1":"dynamicPropertyValue",
    "roles":[
        {
            "function":"admin"
        },
        {
            "function":"buyer"
        }
    ],
    "active":true,
    "receiveEmail":"yes",
    "email":"leota@example.com"
}
Nested Schema : dynamicProperty
Type: object
Dynamic property name and value.
Nested Schema : roles
Type: array
List of roles need to associate with the user
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 : createMember_response
Type: object
Show Source
Example Response (application/json)
{
    "links":[
        {
            "rel":"self",
            "href":"ccagent/v1/organizationMembers"
        }
    ],
    "id":"250012"
}

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| |------------------|------------------| |22010|If the profile id passed is not associated to the account of the profileId passed in the AgentContext header.| |23012|If no last name is specified| |23013|If no first name is specified| |82005000|If there is an error while processing the AgentContext header. Possible reasons include invalid profileId, incorrect JSON format or other errors| |22003|If the email passed is null or empty| |200019|If an account already exists for the given email address| |22004|If there was any internal error while creating the profile| |89103|If no shopperProfileId is passed in the AgentContext header| |23006|If invalid email address is specified| |89102|If the shopperProfile passed in the AgentContext header or the associated account is inactive| |89101|If the shopperProfile passed in the AgentContext header is not an administrator for the account| |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