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

updateMember

put

/ccagent/v1/organizationMembers/{id}

Update Member. This operation is used to update customer name, email, role, status and dynamic properties of a customer profile. 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.

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-CCAgentContext
Type: string
Required: true
The Agent Context is a JSON object with shopperProfileId as a property.
X-CCAsset-Language
Type: string
The asset language of the request
X-CCOrganization
Type: string
The organization Id associated with the shopper profile
X-CCSite
Type: string
The site Id to update the site specific shopper profile properties
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":"Blooming",
    "dynamicProperties":[
    ],
    "roles":[
        {
            "function":"admin",
            "relativeTo":"or-100001",
            "repositoryId":"100001"
        },
        {
            "function":"buyer",
            "relativeTo":"or-100001",
            "repositoryId":"100002"
        },
        {
            "function":"buyer",
            "relativeTo":"or-100002",
            "repositoryId":"100004"
        }
    ],
    "receiveEmail":"yes",
    "active":true,
    "locale":"en",
    "parentOrganization":{
        "approvalRequired":true,
        "repositoryId":"or-100001",
        "name":"National Discount Auto Parts",
        "active":true,
        "description":null,
        "shippingAddress":{
            "repositoryId":"ci-110024"
        },
        "secondaryAddresses":{
            "Address2":{
                "repositoryId":"ci-110024"
            },
            "Address1":{
                "repositoryId":"ci-110023"
            }
        },
        "billingAddress":{
            "repositoryId":"ci-110024"
        },
        "id":"or-100001",
        "orderPriceLimit":50
    },
    "orderPriceLimit":50,
    "firstName":"Ron",
    "profileType":"b2b_user",
    "repositoryId":"bb-110023",
    "links":[
        {
            "rel":"self",
            "href":"ccagent/v1/organizationMembers/bb-110023"
        }
    ],
    "id":"bb-110023",
    "secondaryOrganizations":[
        {
            "approvalRequired":false,
            "repositoryId":"or-100002",
            "name":"US Motor Works, Inc.",
            "active":true,
            "description":"US Motor Works, Inc.",
            "shippingAddress":{
                "repositoryId":"ci-110029"
            },
            "secondaryAddresses":{
                "Address1":{
                    "repositoryId":"ci-110029"
                }
            },
            "billingAddress":{
                "repositoryId":"ci-110029"
            },
            "id":"or-100002",
            "orderPriceLimit":null
        }
    ],
    "email":"ron@example.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| |------------------|------------------| |22000|If the profile id passed is null or empty| |23012|If no last name is specified| |22001|If there was any internal error while getting the profile| |23013|If no first name is specified| |22002|If there was no profile found with the given id| |82005000|If there is an error while processing the AgentContext header. Possible reasons include invalid profileId, incorrect JSON format or other errors| |200019|If an account already exists for the given email address| |23006|If invalid email address is specified| |22007|If the profile id passed is not associated to the account of the profile id passed in the AgentContext header| |22010|If the profile id passed is not associated to the account of the profileId passed in the AgentContext header.| |89103|If no shopperProfileId is passed in the AgentContext header| |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|
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:

{
  "firstName": "Leota",
  "lastName": "Dilliard",
  "roles": [
    {"function": "admin"},
    {"function": "buyer"}
  ],
  "active": true,
  "receiveEmail": "yes",
  "email": "leota@example.com",
  "Age": 28,
  "Nickname": "Leota"
}

Sample Response Payload returned by endpoint:

{
  "lastName": "Blooming",
  "dynamicProperties": [],
  "roles": [
    {
      "function": "admin",
      "relativeTo": "or-100001",
      "repositoryId": "100001"
    },
    {
      "function": "buyer",
      "relativeTo": "or-100001",
      "repositoryId": "100002"
    },
    {
      "function": "buyer",
      "relativeTo": "or-100002",
      "repositoryId": "100004"
    }
  ],
  "receiveEmail": "yes",
  "active": true,
  "locale": "en",
  "parentOrganization": {
    "approvalRequired": true,
    "repositoryId": "or-100001",
    "name": "National Discount Auto Parts",
    "active": true,
    "description": null,
    "shippingAddress": {"repositoryId": "ci-110024"},
    "secondaryAddresses": {
      "Address2": {"repositoryId": "ci-110024"},
      "Address1": {"repositoryId": "ci-110023"}
    },
    "billingAddress": {"repositoryId": "ci-110024"},
    "id": "or-100001",
    "orderPriceLimit": 50
  },
  "orderPriceLimit": 50,
  "firstName": "Ron",
  "profileType": "b2b_user",
  "repositoryId": "bb-110023",
  "links": [{
    "rel": "self",
    "href": "ccagent/v1/organizationMembers/bb-110023"
  }],
  "id": "bb-110023",
  "secondaryOrganizations": [{
    "approvalRequired": false,
    "repositoryId": "or-100002",
    "name": "US Motor Works, Inc.",
    "active": true,
    "description": "US Motor Works, Inc.",
    "shippingAddress": {"repositoryId": "ci-110029"},
    "secondaryAddresses": {"Address1": {"repositoryId": "ci-110029"}},
    "billingAddress": {"repositoryId": "ci-110029"},
    "id": "or-100002",
    "orderPriceLimit": null
  }],
  "email": "ron@example.com"
}