REST API for Oracle Commerce Cloud December 2017

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

Properties

active: Type: boolean

This is active status of the profile should be true or false.
derivedOrderPriceLimit: Type: number

Its order limit value for the profile, if order limit is more than this value the approval is needed for the order
email: Type: string

The email address of the profile.
firstName: Type: string

The first name of the profile.
id: Type: string

The ID of the shopper profile.
lastName: Type: string

The last name of the profile.
locale: Type: string

The locale of the request/response.
parentOrganization: Type: object parentOrganization

Additional Properties Allowed:

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
profileType: Type: string

This attribute is added for account-based commerce, It's value is 'b2b_user'.
receiveEmail: Type: string

This is an email marketing flag which indicates to notify user by mail or not, can be yes or no.
repositoryId: Type: string

The repository id of the profile.
roles: Type: array roles

Additional Properties Allowed:

List of user roles

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

Properties

active: Type: boolean

This is active status of the profile should be true or false.
billingAddress: Type: object billingAddress

Additional Properties Allowed:

Default billing address of the organization
description: Type: string

Description of the Organization
id: Type: string

the id of the parent organization
name: Type: string

the name of the parent organization
repositoryId: Type: string

the id of the parent organization
secondaryAddresses: Type: object secondaryAddresses

Additional Properties Allowed:

List of shipping addresses associated with the profile.
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

Default shipping address of the organization

Nested Schema : roles

Type: array

List of user roles

Items

Type: object items

Additional Properties Allowed:

Nested Schema : billingAddress

Type: object

Default billing address of the organization

Properties

repositoryId: Type: string

the id of the billing address

Nested Schema : secondaryAddresses

Type: object

List of shipping addresses associated with the profile.

Properties

AddressType: Type: object AddressType

Additional Properties Allowed:

Address type represents nick-name of address.

Nested Schema : shippingAddress

Type: object

Default shipping address of the organization

Properties

repositoryId: Type: string

the id of the shipping address

Nested Schema : AddressType

Type: object

Address type represents nick-name of address.

Properties

repositoryId: Type: string

Repository ID of the shipping address

Nested Schema : items

Type: object

Properties

function: Type: string

The function of the role which can be admin or buyer.
repositoryId: Type: string

The repository id of the role.

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",
    "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| |------------------|------------------| |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

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

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",
  "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"
}