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

getProfile

get

/ccagent/v1/profiles/{id}

Get Profile. Get details of a customer profile. Optionally takes X-CCOrganization & x-ccsite header.

Request

Supported Media Types
  • application/json
Path Parameters
id
Type: string
Required: true
The customer profile id.
Header Parameters
X-CCOrganization
Type: string
The organization Id to which the profile belongs to
x-ccsite
Type: string
the site id corresponding to which site specific properties should be shown

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getProfile_response
Nested Schema : profileComments
Type: array
The list of all logged comments for the customer profile.
Nested Schema : profileDetail
Type: object
The details of the customer profile.
Nested Schema : items
Type: object
Nested Schema : catalog
Type: object
The catalog associated with this profile.
Nested Schema : contactBillingAddress
Type: object
The default billing address for B2B contact.
Nested Schema : contactShippingAddress
Type: object
The default shipping address for B2B contact
Nested Schema : dynamicProperties
Type: array
Read-only list of dynamic properties associated with profile along with meta-data.
Nested Schema : parentOrganization
Type: object
The parent Organization associated with the B2B customer profile.
Nested Schema : secondaryAddresses
Type: object
Secondary addresses for B2B contact.
Nested Schema : shippingAddress
Type: object
The default shipping address for the customer profile
Nested Schema : shippingAddresses
Type: array
The shipping addresses associated with the customer profile.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Example application/json

{
    "profileDetail":{
        "lastName":"Butt",
        "catalog":{
            "repositoryId":"cloudLakeCatalog"
        },
        "dynamicProperties":[
            {
                "id":"dynamicPropertyMaritalStatus",
                "label":"Marital Status",
                "type":"string",
                "value":"Single"
            }
        ],
        "contactBillingAddress":{
            "lastName":"Anderson",
            "firstName":"Kim",
            "country":"US",
            "phoneNumber":"212-555-2150",
            "address2":null,
            "city":"Buffalo",
            "address1":"451 Brooks Ave",
            "postalCode":"14201",
            "county":null,
            "repositoryId":"se-990031",
            "state":"NY"
        },
        "receiveEmail":"no",
        "secondaryAddresses":{
            "Work":{
                "lastName":"Anderson",
                "firstName":"Kim",
                "country":"US",
                "phoneNumber":"212-555-2150",
                "address2":null,
                "city":"Buffalo",
                "address1":"451 Brooks Ave",
                "postalCode":"14201",
                "county":null,
                "repositoryId":"se-970031",
                "state":"NY"
            },
            "Mom' s house":{
                "lastName":"Anderson",
                "firstName":"Dolores",
                "country":"US",
                "phoneNumber":"212-555-4321",
                "address2":null,
                "city":"Dewitt",
                "address1":"41 Wexford Rd ",
                "postalCode":"13214",
                "county":null,
                "repositoryId":"se-140010",
                "state":"NY"
            },
            "Home":{
                "lastName":"dd",
                "firstName":"sdf",
                "country":"US",
                "phoneNumber":"1231231231",
                "address2":"f",
                "city":"f",
                "address1":"dd",
                "postalCode":"36123",
                "county":null,
                "repositoryId":"se-980031",
                "state":"AL"
            }
        },
        "contactShippingAddress":{
            "lastName":"dd",
            "firstName":"sdf",
            "country":"US",
            "phoneNumber":"1231231231",
            "address2":"f",
            "city":"f",
            "address1":"dd",
            "postalCode":"36123",
            "county":null,
            "repositoryId":"se-980031",
            "state":"AL"
        },
        "parentOrganization":{
            "name":"Oracle India Pvt Ltd",
            "repositoryId":"oracle",
            "id":"oracle"
        },
        "firstName":"James",
        "profileType":"b2b_user",
        "repositoryId":"120099",
        "shippingAddress":{
            "lastName":"Butt",
            "firstName":"James",
            "country":"United States",
            "phoneNumber":"504-845-1427",
            "address2":"",
            "city":"New Orleans",
            "address1":"6649 N Blue Gum St",
            "postalCode":"70116",
            "county":"Orleans",
            "repositoryId":"140010",
            "state":"Los Angeles"
        },
        "id":"120099",
        "email":"jbutt@gmail.com",
        "daytimeTelephoneNumber":"",
        "shippingAddresses":[
            {
                "lastName":"Anderson",
                "country":"United States",
                "address3":"",
                "address2":"",
                "city":"Syracuse",
                "prefix":"",
                "address1":"21 Cedar Ave",
                "postalCode":"13202",
                "jobTitle":"",
                "companyName":"",
                "county":"",
                "isDefaultAddress":false,
                "suffix":"",
                "selectedCountry":"US",
                "firstName":"Kim",
                "phoneNumber":"212-555-1977",
                "faxNumber":"",
                "middleName":"",
                "state":"New York",
                "selectedState":"NY",
                "state_ISOCode":"US-NY"
            },
            {
                "lastName":"Butt",
                "country":"United States",
                "address3":"",
                "address2":"",
                "city":"New Orleans",
                "prefix":"",
                "address1":"6649 N Blue Gum St",
                "postalCode":"70116",
                "jobTitle":"",
                "companyName":"",
                "county":"Orleans",
                "isDefaultAddress":true,
                "suffix":"",
                "selectedCountry":"US",
                "firstName":"James",
                "phoneNumber":"504-845-1427",
                "faxNumber":"",
                "middleName":"",
                "state":"Los Angeles",
                "selectedState":"LA",
                "state_ISOCode":"US-LA"
            }
        ]
    },
    "profileComments":[
        {
            "repositoryId":"100002",
            "comment":"Item not received.",
            "creationDate":"2014-06-25 01:50:28.0"
        },
        {
            "repositoryId":"100001",
            "comment":"Issue with shipping address.",
            "creationDate":"2014-06-25 01:50:20.0"
        }
    ],
    "hasIncompleteOrder":false
}
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| |------------------|------------------| |100094|Organization passed in the header is currently inactive| |100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization| |22000|Profile Id passed is null or empty.| |22001|Internal error occured while processing the request.| |100101|The shopper profile does not belong to organization passed in the header| |200006|Profile comment retrieval failed.| |22002|No profile found with profile id| |100102|Organization passed in the header is invalid or does not exist| |200016|Internal error occurred while processing the profile orders request.|
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:

{
  "profileDetail": {
    "lastName": "Butt",
    "catalog": {"repositoryId": "cloudLakeCatalog"},
    "dynamicProperties": [{
      "id": "dynamicPropertyMaritalStatus",
      "label": "Marital Status",
      "type": "string",
      "value": "Single"
    }],
    "contactBillingAddress": {
      "lastName": "Anderson",
      "firstName": "Kim",
      "country": "US",
      "phoneNumber": "212-555-2150",
      "address2": null,
      "city": "Buffalo",
      "address1": "451 Brooks Ave",
      "postalCode": "14201",
      "county": null,
      "repositoryId": "se-990031",
      "state": "NY"
    },
    "receiveEmail": "no",
    "secondaryAddresses": {
      "Work": {
        "lastName": "Anderson",
        "firstName": "Kim",
        "country": "US",
        "phoneNumber": "212-555-2150",
        "address2": null,
        "city": "Buffalo",
        "address1": "451 Brooks Ave",
        "postalCode": "14201",
        "county": null,
        "repositoryId": "se-970031",
        "state": "NY"
      },
      "Mom' s house": {
        "lastName": "Anderson",
        "firstName": "Dolores",
        "country": "US",
        "phoneNumber": "212-555-4321",
        "address2": null,
        "city": "Dewitt",
        "address1": "41 Wexford Rd ",
        "postalCode": "13214",
        "county": null,
        "repositoryId": "se-140010",
        "state": "NY"
      },
      "Home": {
        "lastName": "dd",
        "firstName": "sdf",
        "country": "US",
        "phoneNumber": "1231231231",
        "address2": "f",
        "city": "f",
        "address1": "dd",
        "postalCode": "36123",
        "county": null,
        "repositoryId": "se-980031",
        "state": "AL"
      }
    },
    "contactShippingAddress": {
      "lastName": "dd",
      "firstName": "sdf",
      "country": "US",
      "phoneNumber": "1231231231",
      "address2": "f",
      "city": "f",
      "address1": "dd",
      "postalCode": "36123",
      "county": null,
      "repositoryId": "se-980031",
      "state": "AL"
    },
    "parentOrganization": {
      "name": "Oracle India Pvt Ltd",
      "repositoryId": "oracle",
      "id": "oracle"
    },
    "firstName": "James",
    "profileType": "b2b_user",
    "repositoryId": "120099",
    "shippingAddress": {
      "lastName": "Butt",
      "firstName": "James",
      "country": "United States",
      "phoneNumber": "504-845-1427",
      "address2": "",
      "city": "New Orleans",
      "address1": "6649 N Blue Gum St",
      "postalCode": "70116",
      "county": "Orleans",
      "repositoryId": "140010",
      "state": "Los Angeles"
    },
    "id": "120099",
    "email": "jbutt@gmail.com",
    "daytimeTelephoneNumber": "",
    "shippingAddresses": [
      {
        "lastName": "Anderson",
        "country": "United States",
        "address3": "",
        "address2": "",
        "city": "Syracuse",
        "prefix": "",
        "address1": "21 Cedar Ave",
        "postalCode": "13202",
        "jobTitle": "",
        "companyName": "",
        "county": "",
        "isDefaultAddress": false,
        "suffix": "",
        "selectedCountry": "US",
        "firstName": "Kim",
        "phoneNumber": "212-555-1977",
        "faxNumber": "",
        "middleName": "",
        "state": "New York",
        "selectedState": "NY",
        "state_ISOCode": "US-NY"
      },
      {
        "lastName": "Butt",
        "country": "United States",
        "address3": "",
        "address2": "",
        "city": "New Orleans",
        "prefix": "",
        "address1": "6649 N Blue Gum St",
        "postalCode": "70116",
        "jobTitle": "",
        "companyName": "",
        "county": "Orleans",
        "isDefaultAddress": true,
        "suffix": "",
        "selectedCountry": "US",
        "firstName": "James",
        "phoneNumber": "504-845-1427",
        "faxNumber": "",
        "middleName": "",
        "state": "Los Angeles",
        "selectedState": "LA",
        "state_ISOCode": "US-LA"
      }
    ]
  },
  "profileComments": [
    {
      "repositoryId": "100002",
      "comment": "Item not received.",
      "creationDate": "2014-06-25 01:50:28.0"
    },
    {
      "repositoryId": "100001",
      "comment": "Issue with shipping address.",
      "creationDate": "2014-06-25 01:50:20.0"
    }
  ],
  "hasIncompleteOrder": false
}