1. REST API for Oracle Commerce Cloud 22D
  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
Path Parameters
Query Parameters
  • If no value is given, by default all organizational roles(including secondary organizations) will be returned. If value is 'organizationalRolesForCurrentOrganization', organizational roles for current organization are returned. If value is 'allRolesForCurrentOrganization', all roles for current organization are returned.
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getProfile_response
Type: object
Show Source
Nested Schema : profileComments
Type: array
The list of all logged comments for the customer profile.
Show Source
Nested Schema : profileDetail
Type: object
The details of the customer profile.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : catalog
Type: object
The catalog associated with this profile.
Show Source
Nested Schema : comments
Type: array
The notes on the customer.
Show Source
Nested Schema : contactBillingAddress
Type: object
The default billing address for B2B contact.
Show Source
Nested Schema : contactShippingAddress
Type: object
The default shipping address for B2B contact
Show Source
Nested Schema : currentOrganization
Type: object
The current Organization
Show Source
Nested Schema : dynamicProperties
Type: array
Read-only list of dynamic properties associated with profile along with meta-data.
Show Source
Nested Schema : loyaltyPrograms
Type: array
Loyalty Programs Information
Show Source
Nested Schema : parentOrganization
Type: object
The parent Organization associated with the B2B customer profile.
Show Source
Nested Schema : priceListGroup
Type: object
The associated price list group for this profile
Show Source
Nested Schema : roles
Type: array
List of user roles.
Show Source
Nested Schema : secondaryAddresses
Type: object
Secondary addresses for B2B contact.
Show Source
Nested Schema : secondaryOrganizations
Type: array
List of secondary organizations that need to associate with the user.
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address of the profile (Deprecated, please use ???shippingAddresses??? instead).
Show Source
Nested Schema : shippingAddresses
Type: array
The shipping addresses associated with the customer profile.
Show Source
Nested Schema : items
Type: object
The info of the customer
Show Source
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : associations
Type: array
Associations of the role.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Nested Schema : items
Type: object
Show Source
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Nested Schema : items
Type: object
Show Source
Nested Schema : dynamicProperty
Type: object
The value of the dynamic Property
Example Response (application/json)
{
    "profileDetail":{
        "lastName":"Butt",
        "GDPRProfileP13nConsentDate":"2018-03-21T13:10:08.463Z",
        "customerContactId":"CRMID_12345",
        "GDPRProfileP13nConsentGranted":true,
        "catalog":{
            "repositoryId":"cloudLakeCatalog"
        },
        "dynamicProperties":[
            {
                "id":"dynamicPropertyMaritalStatus",
                "label":"Marital Status",
                "type":"string",
                "value":"Single"
            }
        ],
        "roles":[
            {
                "associations":[
                    {
                        "relatedItemId":"or-100001",
                        "type":"organization"
                    }
                ],
                "function":"buyer",
                "relativeTo":"or-100001",
                "repositoryId":"100002",
                "name":"Buyer",
                "id":"100002",
                "type":"organizationalRole"
            },
            {
                "associations":[
                    {
                        "relatedItemId":"or-100001",
                        "type":"organization"
                    }
                ],
                "function":"custom",
                "relativeTo":"or-100001",
                "repositoryId":"orgRole2",
                "name":"orgRole2",
                "id":"orgRole2",
                "type":"organizationalRole"
            }
        ],
        "contactBillingAddress":{
            "lastName":"Anderson",
            "firstName":"Kim",
            "country":"US",
            "externalAddressId":"EXT_ADDR_1",
            "phoneNumber":"212-555-2150",
            "address2":null,
            "city":"Buffalo",
            "address1":"451 Brooks Ave",
            "postalCode":"14201",
            "county":null,
            "repositoryId":"se-990031",
            "state":"NY"
        },
        "receiveEmail":"yes",
        "dateOfBirth":"2001-11-14T00:00:00.000Z",
        "secondaryAddresses":{
            "Work":{
                "lastName":"Anderson",
                "firstName":"Kim",
                "country":"US",
                "externalAddressId":"EXT_ADDR_1",
                "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",
                "externalAddressId":"EXT_ADDR_1",
                "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",
                "externalAddressId":"EXT_ADDR_1",
                "phoneNumber":"1231231231",
                "address2":"f",
                "city":"f",
                "address1":"dd",
                "postalCode":"36123",
                "county":null,
                "repositoryId":"se-980031",
                "state":"AL"
            }
        },
        "locale":"en_US",
        "contactShippingAddress":{
            "lastName":"dd",
            "firstName":"sdf",
            "country":"US",
            "externalAddressId":"EXT_ADDR_1",
            "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",
            "punchoutUserId":"100012",
            "id":"oracle"
        },
        "receiveEmailDate":"2018-03-21T13:10:08.463Z",
        "firstName":"James",
        "profileType":"b2b_user",
        "loyaltyPrograms":[
            {
                "programName":"XTRAREWARDS",
                "membershipId":"abc123",
                "programId":"prog1",
                "status":"Enrolled"
            },
            {
                "programName":"XTRAREWARDS",
                "membershipId":"xyz123",
                "programId":"prog2",
                "status":"RequestForEnrollment"
            }
        ],
        "repositoryId":"120099",
        "shippingAddress":{
            "lastName":"Butt",
            "firstName":"James",
            "country":"United States",
            "externalAddressId":"EXT_ADDR_1",
            "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@example.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",
                "externalAddressId":"EXT_ADDR_1",
                "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",
                "externalAddressId":"EXT_ADDR_1",
                "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 occurred 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
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