1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Agent
  4. Customers

updateProfile

put

/ccagent/v1/profiles/{id}

Update Profile. Updates customer name, email address, phone number, shipping address and email marketing flag status of the profile depending on the profile ID. Dynamic Properties of profile can also be updated like any other attribute ("dynamicPropertyKey":"dynamicPropertyValue"). Takes additonal header parameter x-ccsite corresponding to which site specific properties should be updated. If x-ccsite value is not provided, it indicates default site.

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
A registered shopper has changed their account details
Root Schema : updateProfile_request
Type: object
A registered shopper has changed their account details
Show Source
Example:
{
    "profileId":"110632",
    "profile":{
        "lastPurchaseDate":"2020-05-08T07:13:55.000Z",
        "dynamicPropertyMapLong":{
        },
        "GDPRProfileP13nConsentDate":null,
        "GDPRProfileP13nConsentGranted":false,
        "secondaryAddresses":{
            "Address":{
                "country":"US",
                "lastName":"ded",
                "types":[
                ],
                "address3":"",
                "city":"www",
                "address2":"www",
                "prefix":"",
                "address1":"wew",
                "postalCode":"12001",
                "companyName":"",
                "county":"",
                "suffix":"",
                "firstName":"cdc",
                "phoneNumber":"9876543210",
                "item-id":null,
                "repositoryId":"121072",
                "faxNumber":"",
                "middleName":"",
                "state":"NY"
            }
        },
        "shippingSurchargePriceList":{
        },
        "firstPurchaseDate":"2020-05-08T07:13:55.000Z",
        "profileType":"b2b_user",
        "loyaltyPrograms":[
        ],
        "lastPurchaseAmount":77.98,
        "registrationDate":"2020-05-08T06:27:13.680Z",
        "sessionOrganization":{
            "id":"300002"
        },
        "lifetimeAOV":77.98,
        "id":"110632",
        "derivedSalePriceList":{
        },
        "homeAddress":{
            "country":"Not available",
            "lastName":null,
            "types":[
            ],
            "address3":null,
            "city":"Not available",
            "address2":null,
            "prefix":null,
            "address1":"Not available",
            "postalCode":"Not available",
            "companyName":null,
            "county":null,
            "suffix":null,
            "firstName":null,
            "phoneNumber":null,
            "item-id":null,
            "repositoryId":"120633",
            "faxNumber":null,
            "middleName":null,
            "state":"Not available"
        },
        "daytimeTelephoneNumber":null,
        "customerContactId":null,
        "taxExempt":false,
        "dynamicPropertyMapBigString":{
        },
        "active":true,
        "lastVisitDate":"2020-05-08T07:38:38.455Z",
        "taxExemptionCode":null,
        "previousVisitDate":"2020-05-08T07:29:27.928Z",
        "version":7,
        "abandonedOrderCount":0,
        "firstName":"test123",
        "defaultCreditCard":null,
        "lifetimeCurrencyCode":"USD",
        "derivedTaxExemptionCode":null,
        "currentOrganization":{
            "id":"300002"
        },
        "secondaryOrganizations":[
            {
                "id":"400001"
            }
        ],
        "shippingAddresses":[
            {
                "country":"US",
                "lastName":"ded",
                "types":[
                ],
                "address3":"",
                "city":"www",
                "address2":"www",
                "prefix":"",
                "address1":"wew",
                "postalCode":"12001",
                "companyName":"",
                "county":"",
                "suffix":"",
                "firstName":"cdc",
                "phoneNumber":"9876543210",
                "item-id":null,
                "repositoryId":"121072",
                "faxNumber":"",
                "middleName":"",
                "state":"NY"
            }
        ],
        "derivedPriceListGroup":{
            "isTaxIncluded":false,
            "endDate":null,
            "displayName":"test price list group",
            "listPriceList":{
            },
            "active":true,
            "isPointsBased":false,
            "locale":"en_GB",
            "basePriceListGroup":null,
            "shippingSurchargePriceList":{
            },
            "deleted":false,
            "taxCalculationType":"doNotCalculateTax",
            "ancestorPriceListGroups":[
            ],
            "salePriceList":{
            },
            "currency":{
                "currencyType":null,
                "symbol":"??",
                "deleted":false,
                "displayName":"British Pound Sterling",
                "fractionalDigits":2,
                "currencyCode":"GBP",
                "numericCode":"826"
            },
            "id":"TEST_PRICE_LIST_GROUP",
            "includeAllProducts":false,
            "startDate":null
        },
        "lastName":"rest123",
        "roles":[
            {
                "name":"Role 1",
                "repositoryId":"role1",
                "description":null,
                "accessRights":[
                    {
                        "displayName":"Custom Access Right",
                        "name":"Custom Access Right",
                        "repositoryId":"customAccessRight",
                        "description":"Custom Access Right",
                        "id":"customAccessRight",
                        "type":"generic"
                    }
                ],
                "id":"role1",
                "type":"role"
            },
            {
                "relativeTo":{
                    "externalOrganizationId":null,
                    "id":"or-100001"
                },
                "function":"buyer",
                "name":"Buyer",
                "repositoryId":"100002",
                "description":null,
                "accessRights":[
                ],
                "id":"100002",
                "type":"organizationalRole"
            }
        ],
        "numberOfOrders":1,
        "locale":"en",
        "login":"aa@example.com",
        "receiveEmailDate":"2020-05-08T06:27:13.573Z",
        "sitePropertiesList":[
            {
                "site":{
                    "id":"siteUS"
                },
                "properties":{
                    "numberOfVisits":4,
                    "GDPRProfileP13nConsentDate":null,
                    "GDPRProfileP13nConsentGranted":false,
                    "receiveEmail":"yes",
                    "receiveEmailDate":"2020-05-08T06:27:13.573Z"
                }
            }
        ],
        "lifetimeSpend":77.98,
        "dynamicPropertyMapString":{
        },
        "email":"aa@example.com",
        "numberOfVisits":4,
        "siteProperties":{
            "siteUS":{
                "numberOfVisits":4,
                "GDPRProfileP13nConsentDate":null,
                "GDPRProfileP13nConsentGranted":false,
                "receiveEmail":"yes",
                "receiveEmailDate":"2020-05-08T06:27:13.573Z"
            }
        },
        "receiveEmail":"yes",
        "priceListGroup":{
            "isTaxIncluded":false,
            "endDate":null,
            "displayName":"STEPPED Test list",
            "listPriceList":{
            },
            "active":true,
            "isPointsBased":false,
            "locale":"en_GB",
            "basePriceListGroup":null,
            "shippingSurchargePriceList":{
            },
            "deleted":false,
            "taxCalculationType":"doNotCalculateTax",
            "ancestorPriceListGroups":[
            ],
            "salePriceList":{
            },
            "currency":{
                "currencyType":null,
                "symbol":"??",
                "deleted":false,
                "displayName":"British Pound Sterling",
                "fractionalDigits":2,
                "currencyCode":"GBP",
                "numericCode":"826"
            },
            "id":"TEST_STEPPED_GBP",
            "includeAllProducts":false,
            "startDate":null
        },
        "dateOfBirth":null,
        "shippingAddress":{
            "country":"US",
            "lastName":"ded",
            "types":[
            ],
            "address3":"",
            "city":"www",
            "address2":"www",
            "prefix":"",
            "address1":"wew",
            "postalCode":"12001",
            "companyName":"",
            "county":"",
            "suffix":"",
            "firstName":"cdc",
            "phoneNumber":"9876543210",
            "item-id":null,
            "repositoryId":"121072",
            "faxNumber":"",
            "middleName":"",
            "state":"NY"
        },
        "firstVisitDate":"2018-12-18T11:31:43.401Z",
        "middleName":null,
        "lastActivity":"2020-05-08T06:27:13.681Z",
        "billingAddress":null,
        "dynamicPropertyMapDouble":{
        },
        "derivedShippingSurchargePriceList":{
        },
        "abandonedOrders":[
        ]
    },
    "siteId":"siteUS",
    "type":"atg.dps.ProfileUpdate"
}
Nested Schema : profile
Type: object
Show Source
Nested Schema : abandonedOrders
Type: object
Set of Abandoned orders
Show Source
Nested Schema : billingAddress
Type: object
Default billing address of the profile
Show Source
Nested Schema : currentOrganization
Type: object
The current Organization
Show Source
Nested Schema : defaultCreditCard
Type: object
Show Source
Nested Schema : derivedPriceListGroup
Type: object
Show Source
Nested Schema : derivedSalePriceList
Type: object
Show Source
Nested Schema : derivedShippingSurchargePriceList
Type: object
Show Source
Nested Schema : homeAddress
Type: object
Home address
Show Source
Nested Schema : loyaltyPrograms
Type: array
Loyalty Programs Information
Show Source
Nested Schema : parentOrganization
Type: object
The parent Organization
Show Source
Nested Schema : priceListGroup
Type: object
Show Source
Nested Schema : roles
Type: array
List of user roles.
Show Source
Nested Schema : secondaryAddresses
Type: array
List of secondary addresses associated with profile. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
Nested Schema : secondaryOrganizations
Type: array
List of secondary organizations that need to associate with the user.
Show Source
Nested Schema : sessionOrganization
Type: object
The session Organization
Show Source
Nested Schema : shippingAddress
Type: object
Shipping address
Show Source
Nested Schema : shippingAddresses
Type: array
List of shipping addresses associated with profile. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
Nested Schema : shippingSurchargePriceList
Type: object
Show Source
Nested Schema : siteProperties
Type: object
Site Properties
Show Source
Nested Schema : sitePropertiesList
Type: array
The list of site related properties for the profile
Show Source
Nested Schema : billingAddress
Type: object
Default billing address of the profile
Show Source
Nested Schema : cardProps
Type: object
Nested Schema : currency
Type: object
Show Source
Nested Schema : listPriceList
Type: object
Show Source
Nested Schema : salePriceList
Type: object
Show Source
Nested Schema : shippingSurchargePriceList
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : currency
Type: object
Show Source
Nested Schema : listPriceList
Type: object
Show Source
Nested Schema : salePriceList
Type: object
Show Source
Nested Schema : shippingSurchargePriceList
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : accessRights
Type: array
Access rights associated with this role.
Show Source
Nested Schema : relativeTo
Type: object
Organization in which the role applies. Only returned for organizationalRole.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : types
Type: array
Types of address. Like SHIPPING, BILLING
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • This property will be added to webhook payload only if includeChangesOnly property is set to true for the specific webhook. Supported values include CREATE, UPDATE and DELETE. This indicates that the corresponding entity is either created or updated or deleted.
  • ID of the organization to be assigned.
Nested Schema : items
Type: object
Show Source
Nested Schema : types
Type: array
Types of address. Like SHIPPING, BILLING
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : properties
Type: object
The site related properties for the profile
Show Source
Nested Schema : site
Type: object
The site data
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 : 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 : profile_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 : 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 : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
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 : billingAddress
Type: object
Default billing address of the profile
Show Source
Nested Schema : cardProps
Type: object
Nested Schema : types
Type: object
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 : 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 : 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 : 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 : 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 : profile_shippingAddress_response
Type: object
Shipping address associated with the 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
Example Response (application/json)
{
    "lastName":"Anderson",
    "GDPRProfileP13nConsentDate":"2018-03-21T13:10:08.463Z",
    "GDPRProfileP13nConsentGranted":true,
    "customerContactId":"CRMID_1",
    "dynamicProperties":[
        {
            "id":"dynamicPropertyMaritalStatus",
            "label":"Marital Status",
            "type":"string",
            "value":"Married"
        }
    ],
    "contactBillingAddress":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "country":"US",
        "externalAddressId":"EXT_ADDR_1",
        "phoneNumber":"212-555-2150",
        "address2":null,
        "city":"Buffalo",
        "address1":"451 Brooks Ave",
        "postalCode":"14201",
        "county":null,
        "repositoryId":"se-990031",
        "state":"NY"
    },
    "receiveEmail":"yes",
    "dateOfBirth":"2007-11-14T00:00:00.000Z",
    "secondaryAddresses":{
        "Work":{
            "lastName":"Anderson",
            "firstName":"Kim",
            "country":"US",
            "externalAddressId":"EXT_ADDR_1",
            "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",
            "externalAddressId":"EXT_ADDR_1",
            "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",
            "externalAddressId":"EXT_ADDR_1",
            "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",
        "externalAddressId":"EXT_ADDR_1",
        "phoneNumber":"1231231231",
        "address2":"f",
        "city":"f",
        "address1":"dd",
        "postalCode":"36123",
        "county":null,
        "repositoryId":"se-980031",
        "state":"AL"
    },
    "receiveEmailDate":"2018-03-21T13:10:08.463Z",
    "firstName":"Kim",
    "profileType":"b2b_user",
    "repositoryId":"120117",
    "shippingAddress":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "country":"US",
        "externalAddressId":"EXT_ADDR_1",
        "phoneNumber":"212-555-1977",
        "address2":"",
        "city":"Montgomery",
        "address1":"21 Cedar Ave",
        "postalCode":"13202",
        "county":null,
        "repositoryId":"142021",
        "state":"NY"
    },
    "id":"120117",
    "email":"kim@example.com",
    "daytimeTelephoneNumber":"212-555-1977",
    "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",
            "externalAddressId":"EXT_ADDR_1",
            "phoneNumber":"212-555-1977",
            "faxNumber":"",
            "middleName":"",
            "state":"New York",
            "selectedState":"NY",
            "state_ISOCode":"US-NY"
        },
        {
            "lastName":"Anderson",
            "country":"United States",
            "address3":"",
            "address2":"",
            "city":"Montgomery",
            "prefix":"",
            "address1":"21 Cedar Ave",
            "postalCode":"13202",
            "jobTitle":"",
            "companyName":"",
            "county":"",
            "isDefaultAddress":true,
            "suffix":"",
            "selectedCountry":"US",
            "firstName":"Kim",
            "externalAddressId":"EXT_ADDR_1",
            "phoneNumber":"212-555-1977",
            "faxNumber":"",
            "middleName":"",
            "state":"New York",
            "selectedState":"NY",
            "state_ISOCode":"US-NY"
        }
    ]
}

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| |------------------|------------------| |200012|please provide valid input| |23010|City not specified in shipping address| |23011|Address line 1 not specified in shipping address| |22000|The profile id passes is null or empty.| |23012|No last name specified in shipping address| |22001|Internal error while getting the profile.| |23013|No first name specified in shipping address| |22002|No profile found with the given id.| |23015|Phone number not specified in shipping address| |23005|Invalid phone number in shipping address| |23007|No country specified in shipping address| |23008|Postal code not specified in shipping address| |13036|One of the dynamic properties is not writable by the Agent user| |23041|You cannot activate or inactivate this profile as it is linked to multiple accounts.| |
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