1. REST API for Oracle Commerce Cloud December 2017
  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
  • application/json
Header Parameters
X-CCAsset-Language
Type: string
The asset language of the request

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getCurrentProfile_response
Nested Schema : contactBillingAddress
Type: object
Default billing address of the b2b profile.
Nested Schema : contactShippingAddress
Type: object
Default shipping address of the b2b profile.
Nested Schema : currentOrganization
Type: object
current organization of the logged in b2b user.
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 organisation information.
Nested Schema : secondaryAddresses
Type: array
List of addresses associated with an Organization that profile belongs to.
Nested Schema : shippingAddress
Type: object
Default shipping address of the profile (Deprecated, please use 'shippingAddresses' instead).
Nested Schema : shippingAddresses
Type: array
List of shipping addresses associated with profile.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Example application/json

{
    "lastName":"Anderson",
    "gender":"female",
    "contactBillingAddress":{
        "country":"US",
        "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",
    "secondaryAddresses":{
        "Office Address":{
            "country":"US",
            "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"
        }
    },
    "contactShippingAddress":{
        "country":"US",
        "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",
    "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"
    },
    "id":"se-570031",
    "email":"kim@example.com",
    "daytimeTelephoneNumber":"212-555-1977",
    "shippingAddresses":[
        {
            "lastName":"Anderson",
            "country":"US",
            "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|
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:

{
  "lastName": "Anderson",
  "gender": "female",
  "contactBillingAddress": {
    "country": "US",
    "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",
  "secondaryAddresses": {"Office Address": {
    "country": "US",
    "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"
  }},
  "contactShippingAddress": {
    "country": "US",
    "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",
  "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"
  },
  "id": "se-570031",
  "email": "kim@example.com",
  "daytimeTelephoneNumber": "212-555-1977",
  "shippingAddresses": [{
    "lastName": "Anderson",
    "country": "US",
    "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"
  }]
}