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

updateMember

put

/ccstore/v1/organizationMembers/{id}

Update Member. This operation is used to 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
  • application/json
Path Parameters
id
Type: string
Required: true
The ID of the shopper profile to be updated.
Header Parameters
X-CCAsset-Language
Type: string
The asset language of the request
X-CCOrganization
Type: string
Current organization context of the logged in user
Body Parameter
Root Schema : updateMember_request
Nested Schema : roles
Type: object
List of role's function that need to associate with the user

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : updateMember_response
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
Nested Schema : roles
Type: array
List of user roles
Nested Schema : billingAddress
Type: object
Default billing address of the organization
Nested Schema : secondaryAddresses
Type: object
List of shipping addresses associated with the profile.
Nested Schema : shippingAddress
Type: object
Default shipping address of the organization
Nested Schema : AddressType
Type: object
Address type represents nick-name of address.
Nested Schema : items
Type: object
Example application/json

{
    "lastName":"K",
    "roles":[
        {
            "function":"buyer",
            "repositoryId":"100006"
        }
    ],
    "receiveEmail":"yes",
    "active":"true",
    "parentOrganization":{
        "name":"Oracle",
        "repositoryId":"100001",
        "description":"Oracle Org",
        "active":true,
        "shippingAddress":{
        },
        "secondaryAddresses":{
            "Address1":{
                "repositoryId":"110033"
            }
        },
        "id":"100001",
        "billingAddress":{
        }
    },
    "locale":"en",
    "dynamicProperty":"dynamicProperty value",
    "firstName":"bcd",
    "profileType":"b2b_user",
    "repositoryId":"110006",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/organizationMembers/110006?offset=0&limit=2&sort=firstName%3Adesc"
        }
    ],
    "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|
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Request:

{
  "dynamicProperty": "dynamicProperty value",
  "firstName": "kim",
  "lastName": "Anderson",
  "roles": [{"function": "buyer"}],
  "receiveEmail": "yes",
  "active": true,
  "email": "kim@example.com",
  "daytimeTelephoneNumber": "212-555-1977"
}

Sample Response Payload returned by endpoint:

{
  "lastName": "K",
  "roles": [{
    "function": "buyer",
    "repositoryId": "100006"
  }],
  "receiveEmail": "yes",
  "active": "true",
  "parentOrganization": {
    "name": "Oracle",
    "repositoryId": "100001",
    "description": "Oracle Org",
    "active": true,
    "shippingAddress": {},
    "secondaryAddresses": {"Address1": {"repositoryId": "110033"}},
    "id": "100001",
    "billingAddress": {}
  },
  "locale": "en",
  "dynamicProperty": "dynamicProperty value",
  "firstName": "bcd",
  "profileType": "b2b_user",
  "repositoryId": "110006",
  "links": [{
    "rel": "self",
    "href": "http://localhost:8080/ccstore/v1/organizationMembers/110006?offset=0&limit=2&sort=firstName%3Adesc"
  }],
  "id": "110006",
  "email": "abc@abc.com"
}