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

getMember

get

/ccagent/v1/organizationMembers/{id}

Get Member. This operation is used to get the profile information of a customer that is associated to an account from Oracle Commerce Cloud. 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. Optionally takes the x-ccasset-language header to get translated content in another language. 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. This endpoint is different from getProfile endpoint. Certain additional details like hasIncompleteOrder property, etc which are necessary for creating or editing orders are returned by getProfile endpoint, whereas only profile and account specific details are returned by getMember endpoint.

Request

Supported Media Types
  • application/json
Path Parameters
id
Type: string
Required: true
The ID of the requested shopper profile.
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. E.g., en,de,fr_CA.
X-CCOrganization
Type: string
The organization Id associated with the shopper profile
X-CCSite
Type: string
The site Id to retrieve the site specific shopper profile properties

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getMember_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| |------------------|------------------| |22010|If the profile id passed is not associated to the account of the profileId passed in the AgentContext header.| |22000|If the profile id passed is null or empty| |22001|If there was any internal error while getting the profile| |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| |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| |22007|If the profile id passed is not associated to the account of the profileId passed in the AgentContext header.|
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 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"
}