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
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 : billingAddress
Type: object
Default billing address of the profile
Show Source
Nested Schema : creditCards
Type: array
List of user credit cards.
Show Source
Nested Schema : derivedPriceListGroup
Type: object
The derived price list group from the user's parent organization
Show Source
Nested Schema : derivedSalePriceList
Type: object
The derived sale price list from the user's parent organization
Show Source
Nested Schema : derivedShippingSurchargePriceList
Type: object
The derived shipping surcharge price list from the user's parent organization
Show Source
Nested Schema : dynamicInternalOnlyProperty
Type: object
the value of the internal only dynamic property
Nested Schema : dynamicProperty
Type: object
the value of the dynamic Property
Nested Schema : loyaltyPrograms
Type: array
Loyalty Programs Information
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 : priceListGroup
Type: object
The associated price list group for this user
Show Source
Nested Schema : roles
Type: array
List of user roles.
Show Source
Nested Schema : secondaryOrganizations
Type: array
List of secondary organizations associated to profile. It will be empty always. Secondary Organizations associated to the profile can be fetched using organization endpoints
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address of the profile
Show Source
Nested Schema : shippingAddresses
Type: array
List of shipping addresses associated with profile.
Show Source
Nested Schema : shippingSurchargePriceList
Type: object
The shipping surcharge price list for this user
Show Source
Nested Schema : translations
Type: array
List of available locales for the user
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
Default billing address of the profile
Show Source
Nested Schema : cardProps
Type: object
Nested Schema : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
Default billing address of the organization
Show Source
Nested Schema : secondaryAddresses
Type: array
List of shipping addresses associated with profile.
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address of the organization
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
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
Nested Schema : billingAddress
Type: object
Default billing address of the profile
Show Source
Nested Schema : secondaryAddresses
Type: array
List of shipping addresses associated with profile.
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address of the profile
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
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"
            }
        ],
        "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":"yes",
        "dateOfBirth":"2001-11-14T00:00:00.000Z",
        "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"
            }
        },
        "locale":"en_US",
        "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",
            "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",
            "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 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