1. Oracle Commerce Cloud October 2017
  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
  • application/json
Path Parameters
id
Type: string
Required: true
The ID of the requested shopper profile.
Header Parameters
X-CCAsset-Language
Type: string
The asset language of the request. E.g., en,de,fr_CA.
X-CCOrganization
Type: string
Current organization context of the logged in user

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getMember_response
Nested Schema : dynamicProperties
Type: array
List of dynamic properties associated with profile along with meta-data.
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 : 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
Nested Schema : items
Type: object
Nested Schema : billingAddress
Type: object
Default billing address of the organization
Nested Schema : shippingAddress
Type: object
Default shipping address of the organization
Nested Schema : items
Type: object
Nested Schema : billingAddress
Type: object
Default billing address of the organization
Nested Schema : shippingAddress
Type: object
Default shipping address of the organization
Example application/json

{
    "lastName":"K",
    "derivedOrderPriceLimit":"800",
    "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",
    "___etag___":"eyJoYXNoIjoiUm4yay9HcTZnckt1MVFvUmVwS21lbmIzV3FPbU5YZ3huQmYvMDl6Zzk2cz0iLCJ1cmkiOiIvY2NhZG1pbnVpL3YxL3Nob3BwZXJQcm9maWxlcy8xMTAwMDYiLCJ2ZXJzaW9uIjo1fQ==",
    "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| |------------------|------------------| |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|
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": "K",
  "derivedOrderPriceLimit": "800",
  "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",
  "___etag___": "eyJoYXNoIjoiUm4yay9HcTZnckt1MVFvUmVwS21lbmIzV3FPbU5YZ3huQmYvMDl6Zzk2cz0iLCJ1cmkiOiIvY2NhZG1pbnVpL3YxL3Nob3BwZXJQcm9maWxlcy8xMTAwMDYiLCJ2ZXJzaW9uIjo1fQ==",
  "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"
}