1. REST API for Oracle Commerce Cloud 21C
  2. Tasks
  3. Admin
  4. Profiles

getProfile

get

/ccadmin/v1/profiles/{id}

Get Profile. This operation is used to get the profile information of a customer from Oracle Commerce Cloud. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
Path Parameters
Query Parameters
  • As an alternative to the fields parameter, which explicitly specifies the properties to include, you can use the exclude parameter to include all properties except the ones specified. For example, to return all of the properties of profile except shippingAddresses.
  • Expand controls which properties are returned. Set the expand query parameter to 'globalRoles' to include global roles along with a user's organizational roles.
  • You can use the fields parameter to restrict the set of properties returned to only those you explicitly specify. The properties are specified as a comma-separated list. For example, id and email properties of profile.
  • If true, then preview profile will be 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 : 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)
{
    "derivedPriceListGroup":null,
    "lastPurchaseDate":null,
    "lastName":"K",
    "GDPRProfileP13nConsentDate":null,
    "GDPRProfileP13nConsentGranted":false,
    "gender":"female",
    "catalog":null,
    "roles":[
        {
            "function":"buyer",
            "relativeTo":{
                "id":"100001"
            },
            "repositoryId":"100006",
            "name":"Buyer",
            "type":"organizationalRole"
        }
    ],
    "parentOrganization":{
        "name":"Oracle",
        "repositoryId":"100001",
        "description":"Oracle Org",
        "active":true,
        "shippingAddress":{
        },
        "secondaryAddresses":[
            {
                "firstName":"Harry",
                "lastName":"Potter",
                "country":"United States",
                "externalAddressId":"EXT_ADDR_1",
                "types":[
                    {
                        "displayName":"Billing",
                        "repositoryId":"ss-10002",
                        "id":"ss-10002"
                    }
                ],
                "phoneNumber":"9088988999",
                "city":"Arcadia",
                "address2":"Suite 400",
                "address1":"Grundy Lane",
                "postalCode":"91006",
                "repositoryId":"110033",
                "state":"CA"
            }
        ],
        "id":"100001",
        "billingAddress":{
        },
        "externalOrganizationId":"EXT_ORG_1"
    },
    "locale":"en",
    "shippingSurchargePriceList":null,
    "receiveEmailDate":null,
    "firstPurchaseDate":null,
    "profileType":"b2b_user",
    "translations":{
    },
    "loyaltyPrograms":[
        {
            "programName":"XTRAREWARDS",
            "repositoryId":100001,
            "membershipId":"abc123",
            "programId":"prog1",
            "status":"Enrolled"
        },
        {
            "programName":"XTRAMILES",
            "repositoryId":100002,
            "membershipId":"xyz123",
            "programId":"prog2",
            "status":"Enrolled"
        }
    ],
    "registrationDate":null,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/shopperProfiles/110006?offset=0&limit=2&sort=firstName%3Adesc"
        }
    ],
    "id":"110006",
    "email":"abc@example.com",
    "derivedSalePriceList":null,
    "daytimeTelephoneNumber":"212-555-1977",
    "taxExempt":false,
    "customerContactId":"CRMID_12345",
    "receiveEmail":"no",
    "priceListGroup":null,
    "active":"true",
    "dateOfBirth":null,
    "lastVisitDate":null,
    "previousVisitDate":null,
    "firstName":"bcd",
    "creditCards":[
        {
            "expirationYear":"2017",
            "tokenExpiryDate":null,
            "gatewayConfigId":null,
            "expirationMonth":"1",
            "creditCardType":"Visa",
            "source":null,
            "iin":null,
            "token":null,
            "cardProps":{
            },
            "nameOnCard":null,
            "creditCardNumber":"4539082039396288",
            "repositoryId":"se-usercc110031",
            "nickname":"Visa",
            "tokenCreatedDate":"2018-10-01T09:02:10.181Z",
            "cardSavedDate":null,
            "billingAddress":{
                "country":"US",
                "lastName":"Anderson",
                "types":[
                    {
                        "displayName":"Billing",
                        "repositoryId":"ss-10002",
                        "id":"ss-10002"
                    }
                ],
                "address3":null,
                "city":"Buffalo",
                "address2":null,
                "address1":"451 Brooks Ave",
                "postalCode":"14201",
                "county":null,
                "firstName":"Kim",
                "externalAddressId":"EXT_ADDR_1",
                "phoneNumber":"212-555-2150",
                "repositoryId":"se-990031",
                "state":"NY"
            },
            "id":"se-usercc110031",
            "expirationDayOfMonth":null
        }
    ],
    "repositoryId":"110006",
    "firstVisitDate":null,
    "shippingAddress":{
    },
    "billingAddress":{
    },
    "userType":null,
    "derivedShippingSurchargePriceList":null,
    "secondaryOrganizations":[
    ],
    "shippingAddresses":[
    ]
}

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