Jump to

• Request
• Response

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

• application/json

Header Parameters

• X-CCAgentContext: string
  The Agent Context is a JSON object with shopperProfileId as a property.
• X-CCAsset-Language(optional): string
  The asset language of the request
• X-CCOrganization(optional): string
  The organization Id associated with the shopper profile
• X-CCSite(optional): string
  The site Id to update the site specific shopper profile properties

Body ()

Root Schema : createMember_request

Type: object

Show Source

• active: boolean
  This is active status of the profile should be true or false.
• email: string
  the email address of the profile
• firstName: string
  the first name of the profile
• lastName: string
  the last name of the profile
• receiveEmail: string
  the string representation of whether the user wants to recieve email or not, it should be 'yes' or 'no'
• roles(optional): array roles
  List of role's function that need to associate with the user

{
    "properties":{
        "firstName":{
            "description":"the first name of the profile",
            "type":"string"
        },
        "lastName":{
            "description":"the last name of the profile",
            "type":"string"
        },
        "roles":{
            "description":"List of role's function that need to associate with the user",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "function":{
                        "description":"Function of the role",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"Repository id of the role. Required if function is custom. Ignored in other cases.",
                        "type":"string"
                    }
                }
            }
        },
        "receiveEmail":{
            "description":"the string representation of whether the user wants to recieve email or not, it should be 'yes' or 'no'",
            "type":"string"
        },
        "active":{
            "description":"This is active status of the profile should be true or false.",
            "type":"boolean"
        },
        "email":{
            "description":"the email address of the profile",
            "type":"string"
        }
    },
    "required":[
        "firstName",
        "lastName",
        "receiveEmail",
        "active",
        "email"
    ],
    "example":{
        "dynamicProperty":"dynamicProperty value",
        "firstName":"bcd",
        "lastName":"K",
        "roles":[
            {
                "function":"buyer"
            },
            {
                "function":"custom",
                "repositoryId":"customOrganizationalRole"
            }
        ],
        "receiveEmail":"yes",
        "active":true,
        "email":"[e-mail]"
    }
}

Example:

{
    "dynamicProperty":"dynamicProperty value",
    "firstName":"bcd",
    "lastName":"K",
    "roles":[
        {
            "function":"buyer"
        },
        {
            "function":"custom",
            "repositoryId":"customOrganizationalRole"
        }
    ],
    "receiveEmail":"yes",
    "active":true,
    "email":"[e-mail]"
}

Nested Schema : roles

Type: array

List of role's function that need to associate with the user

Show Source

• Array of: object items

{
    "description":"List of role's function that need to associate with the user",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "function":{
                "description":"Function of the role",
                "type":"string"
            },
            "repositoryId":{
                "description":"Repository id of the role. Required if function is custom. Ignored in other cases.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• function(optional): string
  Function of the role
• repositoryId(optional): string
  Repository id of the role. Required if function is custom. Ignored in other cases.

{
    "type":"object",
    "properties":{
        "function":{
            "description":"Function of the role",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository id of the role. Required if function is custom. Ignored in other cases.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createMember_response

Type: object

Show Source

• id(optional): string
  Repository id of the profile

{
    "properties":{
        "id":{
            "description":"Repository id of the profile",
            "type":"string"
        }
    }
}

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

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top