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

updateProfile

put

/ccstore/v1/profiles/current

Update Profile. Updates customer profile attributes. Optionally takes the x-ccasset-language header to get translated content in another language. Dynamic Properties of profile can also be updated like any other attribute ("dynamicPropertyKey":"dynamicPropertyValue").

Request

Supported Media Types
Header Parameters
Body ()
Root Schema : updateProfile_request
Type: object
Show Source
Example:
{
    "firstName":"Jack",
    "lastName":"Black",
    "GDPRProfileP13nConsentGranted":false,
    "gender":"male",
    "receiveEmail":"yes",
    "dateOfBirth":"null",
    "locale":"en",
    "email":"jack@example.com",
    "shippingAddresses":[
        {
            "lastName":"Black",
            "country":"United States",
            "types":[
                {
                    "id":"ss-100002"
                }
            ],
            "address3":"",
            "address2":"",
            "city":"Wake Forest",
            "prefix":"",
            "address1":"405 Example Street",
            "defaultCountryCode":"US",
            "postalCode":"27587",
            "jobTitle":"",
            "companyName":"",
            "county":"",
            "isDefaultAddress":true,
            "suffix":"",
            "selectedCountry":"US",
            "firstName":"Jack",
            "phoneNumber":"555123456",
            "alias":"Address",
            "faxNumber":"",
            "middleName":"",
            "state":"North Carolina",
            "selectedState":"NC",
            "state_ISOCode":"US-NC"
        },
        {
            "lastName":"Hill",
            "country":"United States",
            "types":[
                {
                    "id":"ss-100002"
                }
            ],
            "address3":"",
            "address2":"",
            "city":"Wake Forest",
            "prefix":"",
            "address1":"415 Example Road",
            "defaultCountryCode":"US",
            "postalCode":"27587",
            "jobTitle":"",
            "companyName":"",
            "county":"",
            "isDefaultAddress":false,
            "suffix":"",
            "selectedCountry":"US",
            "firstName":"Jill",
            "phoneNumber":"55512345",
            "alias":"Address##0",
            "faxNumber":"",
            "middleName":"",
            "state":"North Carolina",
            "selectedState":"NC",
            "state_ISOCode":"US-NC"
        }
    ]
}
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 : 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
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateProfile_response
Type: object
Show Source
Nested Schema : catalog
Type: object
The catalog associated with this profile.
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
Price list group properties
Show Source
Nested Schema : roles
Type: array
List of roles assigned to the profile.
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
List of shipping addresses associated with profile.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : currency
Type: object
Currency of the price list group
Show Source
Nested Schema : listPriceList
Type: object
Show Source
Nested Schema : salePriceList
Type: object
Sale price list properties
Show Source
Nested Schema : shippingSurchargePriceList
Type: object
Shipping surcharge price list properties
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,
    "numberOfVisits":1,
    "lastName":"Anderson",
    "GDPRProfileP13nConsentDate":null,
    "GDPRProfileP13nConsentGranted":false,
    "gender":"female",
    "receiveEmail":"yes",
    "dateOfBirth":"null",
    "numberOfOrders":0,
    "lastVisitDate":null,
    "previousVisitDate":null,
    "locale":"en",
    "receiveEmailDate":null,
    "firstPurchaseDate":null,
    "firstName":"Kim",
    "repositoryId":"110033",
    "firstVisitDate":null,
    "shippingAddress":{
        "lastName":"Black",
        "country":"US",
        "types":[
            {
                "displayName":"Billing",
                "repositoryId":"ss-10002",
                "id":"ss-10002"
            }
        ],
        "address3":"",
        "address2":"",
        "city":"Wake Forest",
        "address1":"405 Kilmarnock",
        "postalCode":"27587",
        "county":"",
        "firstName":"Jack",
        "phoneNumber":"555123456",
        "repositoryId":"110053",
        "alias":"Address",
        "state":"NC"
    },
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/profiles/current"
        }
    ],
    "id":"se-570031",
    "email":"kim@example.com",
    "daytimeTelephoneNumber":"212-555-1977",
    "shippingAddresses":[
        {
            "lastName":"Anderson",
            "country":"US",
            "types":[
                {
                    "displayName":"Billing",
                    "repositoryId":"ss-10002",
                    "id":"ss-10002"
                }
            ],
            "address3":"",
            "address2":"Broadway",
            "address1":"326",
            "prefix":"",
            "postalCode":"30005",
            "regionName":"Georgia",
            "companyName":"",
            "county":null,
            "firstName":"Kim",
            "phoneNumber":"9898989898",
            "repositoryId":"se-980032",
            "alias":"Address",
            "state":"GA",
            "countryName":"United States"
        },
        {
            "lastName":"anderson",
            "country":"US",
            "types":[
                {
                    "displayName":"Billing",
                    "repositoryId":"ss-10002",
                    "id":"ss-10002"
                }
            ],
            "address3":"",
            "address2":"",
            "address1":"anderson",
            "prefix":"",
            "postalCode":"13202",
            "regionName":"Georgia",
            "companyName":"",
            "county":null,
            "firstName":"kim",
            "phoneNumber":"",
            "repositoryId":"se-980031",
            "alias":"Address##0",
            "state":"GA",
            "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| |22024|{0}({1}) must be a String| |180106|One or more address type ID is invalid| |
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