1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Store
  4. Organization Members

addMember

put

/ccstore/v1/organizationMembers/{id}/add

Add Member to current organization of the logged in user as well as update customer name, email, role, status of a customer profile and contact dynamic properties. Optionally takes the X-CCOrganization headers to specify current Organization id of logged in user.

Request

Supported Media Types
Path Parameters
  • The ID of the shopper profile to be added to current organization of the logged in user.
Header Parameters
Body ()
Root Schema : updateMember_request
Type: object
Show Source
Example:
{
    "firstName":"Leota",
    "lastName":"Dilliard",
    "GDPRProfileP13nConsentGranted":true,
    "profileType":"b2b_user",
    "dynamicProperty1":"dynamicPropertyValue",
    "roles":[
        {
            "function":"admin",
            "relativeTo":{
                "id":"or-100001"
            }
        },
        {
            "function":"buyer",
            "relativeTo":{
                "id":"or-100001"
            }
        }
    ],
    "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 : updateMember_response
Type: object
Show Source
Nested Schema : dynamicProperties
Type: array
List of dynamic properties associated with profile along with meta-data.
Show Source
Nested Schema : parentOrganization
Type: object
This attribute is added for 'Account-Based Commerce', this is required only in case of 'Account-Based Commerce', this is the id of organization to which user is associated
Show Source
Nested Schema : roles
Type: array
List of user roles
Show Source
Nested Schema : secondaryOrganizations
Type: object
This attribute is added for 'Account-Based Commerce', this is required only in case of 'Account-Based Commerce', this is the id of organization to which user is associated
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
Default billing address of the organization
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address of the organization
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
Default billing address of the organization
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address of the organization
Show Source
Example Response (application/json)
{
    "lastName":"K",
    "customerContactId":"CRMID_1",
    "roles":[
        {
            "function":"buyer",
            "relativeTo":{
                "id":"or-100003"
            },
            "repositoryId":"100006"
        },
        {
            "function":"custom",
            "relativeTo":{
                "id":"or-100003"
            },
            "repositoryId":"customOrganizationalRole"
        }
    ],
    "receiveEmail":"yes",
    "active":"true",
    "parentOrganization":{
        "name":"Oracle",
        "repositoryId":"100001",
        "description":"Oracle Org",
        "active":true,
        "shippingAddress":{
        },
        "secondaryAddresses":{
            "Address1":{
                "repositoryId":"110033"
            }
        },
        "id":"100001",
        "billingAddress":{
        },
        "externalOrganizationId":"EXT_ORG_1"
    },
    "locale":"en",
    "dynamicProperty":"dynamicProperty value",
    "firstName":"bcd",
    "profileType":"b2b_user",
    "repositoryId":"110006",
    "id":"110006",
    "email":"abc@abc.com"
}

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| |------------------|------------------| |100088|You cannot remove the Approver role from this contact. The account has no other active Approvers. Approvals are still enabled and/or there are orders pending approval.| |22000|If the profile id passes is null or empty| |100089|You cannot deactivate this contact. The account has no other active Approvers. Approvals are still enabled and/or there are orders pending approval| |22001|If there was any internal error while getting the profile| |22002|If there was no profile found with the given id| |22007|If the profile id passed dosent associate to the logged in user account| |180106|One or more address type ID is invalid| |23041|You cannot activate or inactivate this profile as it is linked to multiple accounts.| |13001|If role function is given as 'custom' but no repositoryId is given| |21022|An internal error occurred while processing input request.| |21023|The user is already a member of the organization: Oracle Org. They cannot be added again.| |21024|The Input profile 1234 cannot be added to the account: Oracle Org.|
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