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

getCurrentProfile

get

/ccstore/v1/profiles/current

Get Current Profile. Get the current profile. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
Query Parameters
  • This field determines the additional properties to be returned. Possible value for this query parameter is ???accessRights??? to include accessRights of the current profile.
  • This field determines if only organizational roles or all roles are to be returned for the current profile. Default value is 'organizationalRolesForCurrentOrganization'. Possible values are 'organizationalRolesForCurrentOrganization', 'allRolesForCurrentOrganization'.
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getCurrentProfile_response
Type: object
Show Source
Nested Schema : catalog
Type: object
The catalog associated with this profile.
Show Source
Nested Schema : contactBillingAddress
Type: object
Default billing address of the b2b profile.
Show Source
Nested Schema : contactShippingAddress
Type: object
Default shipping address of the b2b profile.
Show Source
Nested Schema : currentOrganization
Type: object
current organization of the logged in b2b user.
Show Source
Nested Schema : dynamicProperties
Type: array
Read-only list of dynamic properties associated with profile along with meta-data.
Show Source
Nested Schema : parentOrganization
Type: object
The parent organisation information.
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 : secondaryAddresses
Type: array
List of addresses associated with an Organization that profile belongs to.
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
List of shipping addresses associated with profile.
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "lastPurchaseDate":null,
    "lastName":"Anderson",
    "GDPRProfileP13nConsentDate":null,
    "GDPRProfileP13nConsentGranted":false,
    "gender":"female",
    "secondaryAddresses":{
        "Office Address":{
            "country":"US",
            "types":[
            ],
            "address3":"block 3",
            "address2":"Street 2",
            "city":"Montgomery",
            "address1":"600 Dexter Avenue",
            "prefix":"",
            "postalCode":"36130",
            "companyName":"Oracle",
            "jobTitle":null,
            "suffix":null,
            "phoneNumber":"973-974-1234",
            "repositoryId":"180003",
            "faxNumber":null,
            "middleName":null,
            "state":"AL"
        }
    },
    "numberOfOrders":0,
    "receiveEmailDate":null,
    "firstPurchaseDate":null,
    "registrationDate":null,
    "id":"se-570031",
    "email":"kim@example.com",
    "daytimeTelephoneNumber":"212-555-1977",
    "numberOfVisits":1,
    "contactBillingAddress":{
        "country":"US",
        "types":[
        ],
        "phoneNumber":"973-974-1234",
        "address3":"block 3",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "prefix":"",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"180003",
        "state":"AL"
    },
    "receiveEmail":"yes",
    "dateOfBirth":"null",
    "lastVisitDate":null,
    "previousVisitDate":null,
    "contactShippingAddress":{
        "country":"US",
        "types":[
        ],
        "address3":"block 3",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "prefix":"",
        "postalCode":"36130",
        "companyName":"Oracle",
        "jobTitle":null,
        "suffix":null,
        "phoneNumber":"973-974-1234",
        "repositoryId":"180003",
        "faxNumber":null,
        "middleName":null,
        "state":"AL"
    },
    "firstName":"Kim",
    "repositoryId":"110033",
    "firstVisitDate":null,
    "currentOrganization":{
        "derivedDunsNumber":"213403478",
        "derivedTaxReferenceNumber":"901-73-7073",
        "organizationLogo":"/general/city-background.jpg",
        "description":"US Motor Works - US Division",
        "delegateApprovalManagement":false,
        "derivedOrganizationLogo":"/general/city-background.jpg",
        "derivedUniqueId":null,
        "derivedType":"division",
        "organizationLogoURL":"http://localhost:8080/file/v4998724338791971926/general/city-background.jpg",
        "derivedVatReferenceNumber":null,
        "repositoryId":"or-100003",
        "name":"US Motor Works - US Division",
        "derivedDescription":"US Motor Works - US Division"
    },
    "shippingAddresses":[
        {
            "lastName":"Anderson",
            "country":"US",
            "types":[
            ],
            "address3":"",
            "address2":"",
            "city":"Montgomery",
            "address1":"21 Cedar Ave",
            "prefix":"",
            "postalCode":"13202",
            "regionName":"Georgia",
            "companyName":"",
            "jobTitle":null,
            "county":null,
            "suffix":null,
            "firstName":"Kim",
            "phoneNumber":"212-555-1977",
            "repositoryId":"se-980031",
            "alias":"Home",
            "faxNumber":null,
            "middleName":null,
            "state":"NY",
            "countryName":"United States"
        }
    ]
}

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| |23044|If an invalid value for includeRoles query parameter is given| |85001|If an invalid SCIM query parameter is given|
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