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

getMember

get

/ccstore/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. Optionally takes the x-ccasset-language headers to get translated content in another language.Also it can have optional X-CCOrganization header which is a JSON field to specify current Organization id of logged in user.

Request

Supported Media Types
Path Parameters
Query Parameters
  • This field determines the additional properties to be returned. Possible value for this query parameter is ???accessRights??? to include accessRights of the member.
  • This field determines if only organizational roles or all roles are to be returned for the member. Default value is 'organizationalRolesForCurrentOrganization'. Possible values are 'organizationalRolesForCurrentOrganization', 'allRolesForCurrentOrganization'.
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getMember_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 : associations
Type: array
Associations of the role with the organization member.
Show Source
Nested Schema : relativeTo
Type: object
Organization in which the role applies. Present only if type is organizationalRole
Show Source
Nested Schema : items
Type: object
Show Source
  • Organization id to which the role is associated.If the type is global, relatedItemId is null
  • Type of the association.Possible values are - organization,global.
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",
    "derivedOrderPriceLimit":"800",
    "roles":[
        {
            "associations":[
                {
                    "relatedItemId":"or-100001",
                    "type":"organization"
                }
            ],
            "function":"buyer",
            "relativeTo":{
                "id":"or-100001"
            },
            "repositoryId":"100002",
            "name":"Buyer",
            "id":"100002",
            "type":"organizationalRole"
        }
    ],
    "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| |------------------|------------------| |22000|If the profile id passes 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| |22007|If the profile id passed dosent associate to the logged in user account| |23044|If an invalid value for includeRoles query parameter is given|
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