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
- application/json
Header Parameters
-
X-CCAsset-Language(optional): string
The asset language of the request
Root Schema : updateProfile_request
Type:
Show Source
object
-
dateOfBirth(optional):
string
The date of birth of the profile user.
-
daytimeTelephoneNumber(optional):
string
The phone Number of the profile.
-
email(optional):
string
The email address of the profile.
-
firstName(optional):
string
The first name of the profile.
-
GDPRProfileP13nConsentGranted(optional):
boolean
If user has given consent for his/her profile information to be used for personalization purposes.
-
gender(optional):
string
The gender of the profile user.
-
lastName(optional):
string
The last name of the profile.
-
newConfirmPassword(optional):
string
Confirmation of the new password. This should match the new password value.
-
newPassword(optional):
string
The new password.
-
oldPassword(optional):
string
The current password.
-
receiveEmail(optional):
string
This is email marketing flag. can be yes or no.
-
shippingAddress(optional):
object shippingAddress
Default shipping address of the profile (Deprecated, please use 'shippingAddresses' instead).
-
shippingAddresses(optional):
array shippingAddresses
List of shipping addresses associated with profile.
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
-
address1:
string
The address line 1 of the shipping address.
-
address2(optional):
string
The address line 2 of the shipping address.
-
address3(optional):
string
The address line 3 of the shipping address.
-
alias(optional):
string
The alias of the shipping address.
-
companyName(optional):
string
The company name of the shipping address.
-
country:
string
The country code of the shipping address.
-
county(optional):
string
The county of the shipping address.
-
firstName:
string
The first name of the shipping address.
-
lastName:
string
The last name of the shipping address.
-
phoneNumber(optional):
string
The phone Number of the shipping address.
-
postalCode:
string
The postal Code of the shipping address.
-
prefix(optional):
string
The prefix of the shipping address.
-
repositoryId(optional):
string
The repository ID of the shipping address.
-
selectedCountry(optional):
string
The country code of the shipping address. If selectedCountry is sent in the request then it takes precedence over country.
-
selectedState(optional):
string
The state ISO alpha-2 code of the shipping address. If selectedState is sent in the request then it takes precedence over state.
-
state:
string
The state code of the shipping address.
-
state_ISOCode(optional):
string
The state ISO alpha-4 code of the shipping address.
-
types(optional):
array types
The types tagged to the address
Nested Schema : shippingAddresses
Type:
array
List of shipping addresses associated with profile.
Show Source
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
repository Id of the address type
Nested Schema : items
Type:
Show Source
object
-
address1:
string
The address line 1 of the shipping address.
-
address2(optional):
string
The address line 2 of the shipping address.
-
address3(optional):
string
The address line 3 of the shipping address.
-
alias(optional):
string
The alias of the shipping address.
-
city:
string
The city of the shipping address.
-
companyName(optional):
string
The company name of the shipping address.
-
country:
string
The country of the shipping address.
-
county(optional):
string
The county code of the shipping address.
-
firstName:
string
The first name of the shipping address.
-
isDefaultAddress(optional):
boolean
Whether to store this address in the default shipping address slot.
-
lastName:
string
The last name of the shipping address.
-
phoneNumber(optional):
string
The phone Number of the shipping address.
-
postalCode:
string
The postal Code of the shipping address.
-
prefix(optional):
string
The prefix of the shipping address.
-
repositoryId(optional):
string
The repository ID of the shipping address.
-
selectedCountry(optional):
string
The country code of the shipping address. If selectedCountry is sent in the request then it takes precedence over country.
-
selectedState(optional):
string
The state ISO alpha-2 code of the shipping address. If selectedState is sent in the request then it takes precedence over state.
-
state:
string
The state code of the shipping address.
-
state_ISOCode(optional):
string
The state ISO alpha-4 code of the shipping address.
-
types(optional):
array types
The types tagged to the address
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
repository Id of the address type
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateProfile_response
Type:
Show Source
object
-
active(optional):
boolean
Indicates whether the organization is active
-
catalog(optional):
object catalog
The catalog associated with this profile.
-
contactBillingAddress(optional):
object contactBillingAddress
The default billing address for B2B contact.
-
contactShippingAddress(optional):
object contactShippingAddress
The default shipping address for B2B contact
-
currentOrganization(optional):
object currentOrganization
The current Organization
-
customerContactId(optional):
string
The external customer contact id.
-
dateOfBirth(optional):
string
The date of birth of the profile user.
-
daytimeTelephoneNumber(optional):
string
The phone Number of the profile.
-
derivedApprovalRequired(optional):
boolean
Approval required
-
derivedOrderPriceLimit(optional):
number
Order limit
-
dynamicProperties(optional):
array dynamicProperties
Read-only list of dynamic properties associated with profile along with meta-data.
-
email(optional):
string
The email address of the profile.
-
firstName(optional):
string
The first name of the profile.
-
firstPurchaseDate(optional):
string
The first time the shopper made a purchase.
-
firstVisitDate(optional):
string
First Visit Date on the profile
-
GDPRProfileP13nConsentDate(optional):
string
The date on which GDPR personalization consent was granted by the user.
-
GDPRProfileP13nConsentGranted(optional):
boolean
If user has given consent for his/her profile information to be used for personalization purposes.
-
gender(optional):
string
The gender of the profile user.
-
id(optional):
string
The ID of the profile to retrieve.
-
lastName(optional):
string
The last name of the profile.
-
lastPurchaseAmount(optional):
number
Last purchased amount on the profile
-
lastPurchaseDate(optional):
string
The last time the shopper made a purchase.
-
lastVisitDate(optional):
string
The last time the shopper visited.
-
lifetimeAOV(optional):
number
Lifetime Average Order Value
-
lifetimeCurrencyCode(optional):
string
Life time currency Code
-
lifetimeSpend(optional):
number
Lifetime spend of the profile
-
locale(optional):
string
Current Locale
-
login(optional):
string
Login id to be used.
-
loyaltyPrograms(optional):
array loyaltyPrograms
Loyalty Programs Information
-
numberOfOrders(optional):
integer
Total number of orders for the customer profile.
-
numberOfVisits(optional):
integer
Number of Visits on the profile
-
parentOrganization(optional):
object parentOrganization
The parent Organization associated with the B2B customer profile.
-
previousVisitDate(optional):
string
Previous Visit Date on the profile
-
priceListGroup(optional):
object priceListGroup
Price list group properties
-
receiveEmail(optional):
string
This is email marketing flag. Can be yes or no.
-
receiveEmailDate(optional):
string
The date on which email marketing consent was granted by the user.
-
registrationDate(optional):
string(date-time)
Registration date
-
repositoryId(optional):
string
The repository id of the customer profile record.
-
roles(optional):
array roles
List of roles assigned to the profile.
-
secondaryAddresses(optional):
object secondaryAddresses
Secondary addresses for B2B contact.
-
secondaryOrganizations(optional):
array secondaryOrganizations
List of secondary organizations that need to associate with the user.
-
shippingAddress(optional):
object shippingAddress
Default shipping address of the profile (Deprecated, please use 'shippingAddresses' instead).
-
shippingAddresses(optional):
array shippingAddresses
List of shipping addresses associated with profile.
-
taxExempt(optional):
boolean
If tax is exempted
Nested Schema : catalog
Type:
object
The catalog associated with this profile.
Show Source
-
repositoryId(optional):
string
RepositoryId of the catalog associated with this profile.
Nested Schema : contactBillingAddress
Type:
object
The default billing address for B2B contact.
Show Source
-
address1(optional):
string
Address line 1 for this billing address.
-
address2(optional):
string
Address line 2 for this billing address.
-
address3(optional):
string
Address line 3 for this billing address.
-
city(optional):
string
City for this billing address.
-
companyName(optional):
string
Company name for this billing address.
-
country(optional):
string
Country for this billing address.
-
county(optional):
string
County for this billing address.
-
faxNumber(optional):
string
Fax number for this billing address.
-
firstName(optional):
string
First name for this billing address.
-
jobTitle(optional):
string
Job title for this billing address.
-
lastName(optional):
string
Last name for this billing address.
-
middleName(optional):
string
Middle name for this billing address.
-
phoneNumber(optional):
string
Phone number for this billing address.
-
postalCode(optional):
string
Postal code for this billing address.
-
prefix(optional):
string
Prefix for this billing address.
-
repositoryId(optional):
string
The repository id of the billing address record.
-
state(optional):
string
State for this billing address.
-
suffix(optional):
string
Suffix for this billing address.
Nested Schema : contactShippingAddress
Type:
object
The default shipping address for B2B contact
Show Source
-
address1(optional):
string
The address line 1 in the shipping address.
-
address2(optional):
string
The address line 2 in the shipping address.
-
address3(optional):
string
The address line 3 in the shipping address.
-
city(optional):
string
The city in the shipping address record.
-
companyName(optional):
string
Company name for this address.
-
country(optional):
string
The country in the shipping address record.
-
county(optional):
string
The county in the shipping address.
-
faxNumber(optional):
string
Fax number for shipping address.
-
firstName(optional):
string
The first name in the shipping address.
-
jobTitle(optional):
string
Job title for shipping address.
-
lastName(optional):
string
The last name in the shipping address.
-
middleName(optional):
string
Middle name for shipping address.
-
phoneNumber(optional):
string
The phone number in the shipping address.
-
postalCode(optional):
string
The postal code in the shipping address.
-
repositoryId(optional):
string
The repository id of the shipping address record.
-
state(optional):
string
The state in the shipping address.
-
suffix(optional):
string
Suffix for shipping address.
Nested Schema : currentOrganization
Type:
object
The current Organization
Show Source
-
id(optional):
string
The current Organization Id
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 Organization associated with the B2B customer profile.
Show Source
-
id(optional):
string
The id of the organization.
-
name(optional):
string
The name of of the organization.
-
punchoutUserId(optional):
string
Punchout user Id of organization, read only property.
-
repositoryId(optional):
string
The repository id of the comment record.
Nested Schema : priceListGroup
Type:
object
Price list group properties
Show Source
-
active(optional):
boolean
Whether the price list group is active or not
-
currency(optional):
object currency
Currency of the price list group
-
deleted(optional):
boolean
Whether the price list group is deleted or not
-
displayName(optional):
string
Display name of the price list group
-
endDate(optional):
string
End date of the price list group
-
id(optional):
string
ID of the price list group
-
listPriceList(optional):
object listPriceList
-
locale(optional):
string
Locale of the price list group
-
salePriceList(optional):
object salePriceList
Sale price list properties
-
shippingSurchargePriceList(optional):
object shippingSurchargePriceList
Shipping surcharge price list properties
-
startDate(optional):
string
Start date of the price list group
Nested Schema : secondaryAddresses
Type:
object
Secondary addresses for B2B contact.
Show Source
-
address1(optional):
string
Address line 1 for this address.
-
address2(optional):
string
Address line 2 for this address.
-
address3(optional):
string
Address line 3 for this address.
-
city(optional):
string
City for this address.
-
companyName(optional):
string
Company name for this address.
-
country(optional):
string
Country for this address.
-
county(optional):
string
County for this address.
-
faxNumber(optional):
string
Fax number for this address.
-
firstName(optional):
string
First name for this address.
-
jobTitle(optional):
string
Job title for this address.
-
lastName(optional):
string
Last name for this address.
-
middleName(optional):
string
Middle name for this address.
-
phoneNumber(optional):
string
Phone number for this address.
-
postalCode(optional):
string
Postal code for this address.
-
prefix(optional):
string
Prefix for this address.
-
repositoryId(optional):
string
The id of this address.
-
state(optional):
string
State for this address.
-
suffix(optional):
string
Suffix for this address.
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
-
address1(optional):
string
The address line 1 of the shipping address.
-
address2(optional):
string
The address line 2 of the shipping address.
-
address3(optional):
string
The address line 3 of the shipping address.
-
alias(optional):
string
The alias of the shipping address.
-
city(optional):
string
the city of the shipping address.
-
companyName(optional):
string
The company name of the shipping address.
-
country(optional):
string
the country code of the shipping address.
-
county(optional):
string
The county of the shipping address.
-
faxNumber(optional):
string
The fax Number of the shipping address.
-
firstName(optional):
string
The first name of the shipping address.
-
jobTitle(optional):
string
The job Title of the shipping address.
-
lastName(optional):
string
The last name of the shipping address.
-
middleName(optional):
string
The Middle Name of the shipping address.
-
phoneNumber(optional):
string
The phone Number of the shipping address.
-
postalCode(optional):
string
The postal Code of the shipping address.
-
prefix(optional):
string
The prefix of the shipping address.
-
repositoryId(optional):
string
The repository ID of the shipping address.
-
state(optional):
string
The state code of the shipping address.
-
suffix(optional):
string
The suffix of the shipping address.
-
types(optional):
array types
The types tagged to the address
Nested Schema : shippingAddresses
Type:
array
List of shipping addresses associated with profile.
Show Source
Nested Schema : items
Type:
Show Source
object
-
default(optional):
string
The default value of the dynamic property.
-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
length(optional):
number
The length attribute of the dynamic property.
-
required(optional):
boolean
The required attribute of the dynamic property.
-
type(optional):
string
The type of the dynamic property. Supported types are boolean, date, float, string, timestamp, enumerated, big string.
-
uiEditorType(optional):
string
The uiEditorType attribute of the dynamic property.
-
value(optional):
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object
-
membershipId(optional):
string
membershipId of the profile.
-
programId(optional):
string
programId of Loyalty Program
-
programName(optional):
string
programName of Loyalty Program
-
repositoryId(optional):
string
repository Id
-
status(optional):
string
status of Enrollment
Nested Schema : currency
Type:
object
Currency of the price list group
Show Source
-
currencyCode(optional):
string
Currency Code
-
displayName(optional):
string
Display name of the currency
-
fractionalDigits(optional):
integer
Fractional digits
-
numericCode(optional):
string
Numeric code of the currency
-
symbol(optional):
string
Symbol of the currency
Nested Schema : listPriceList
Type:
Show Source
object
-
basePriceList(optional):
string
Base list price
-
creationDate(optional):
string
Creation date of the list price
-
description(optional):
string
Description of the list price
-
displayName(optional):
string
Display name of the list price
-
endDate(optional):
string
End date of the list price
-
id(optional):
string
ID of the list price
-
item-id(optional):
string
Item id of the list price
-
itemAcl(optional):
string
Setting for access control for the list price
-
lastModifiedDate(optional):
string
Last modified date of the list price
-
locale(optional):
string
Locale of the list price
-
startDate(optional):
string
Start date of the list price
-
version(optional):
integer
Version of the list price
Nested Schema : salePriceList
Type:
object
Sale price list properties
Show Source
-
basePriceList(optional):
string
Base price list
-
creationDate(optional):
string
Creation date of the sale price
-
description(optional):
string
Description of the sale price
-
displayName(optional):
string
Display name of the sale price
-
endDate(optional):
string
End date of the sale price
-
id(optional):
string
ID of the sale price
-
item-id(optional):
string
Item id of the sale price
-
itemAcl(optional):
string
Setting for access control for the sale price
-
lastModifiedDate(optional):
string
Last modified date of the sale price
-
locale(optional):
string
Locale of the sale price
-
startDate(optional):
string
Start date of the sale price
-
version(optional):
integer
Version of the sale price
Nested Schema : shippingSurchargePriceList
Type:
object
Shipping surcharge price list properties
Show Source
-
basePriceList(optional):
string
Base list price
-
creationDate(optional):
string
Creation date of the shipping surcharge price
-
description(optional):
string
Description of the shipping surcharge price
-
displayName(optional):
string
Display name of the shipping surcharge price
-
endDate(optional):
string
End date of the shipping surcharge price
-
id(optional):
string
ID of the shipping surcharge price
-
item-id(optional):
string
Item id of the shipping surcharge price
-
itemAcl(optional):
string
Setting for access control for the shipping surcharge price
-
lastModifiedDate(optional):
string
Last modified date of the shipping surcharge price
-
locale(optional):
string
Locale of the shipping surcharge price
-
startDate(optional):
string
Start Date of the shipping surcharge price
-
version(optional):
integer
Version of the shipping surcharge price
Nested Schema : items
Type:
Show Source
object
-
function(optional):
string
Name of the role.
-
repositoryId(optional):
string
Repository Id of the role.
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
ID of the organization to be assigned.
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositoryId(optional):
string
repository Id of the address type
Nested Schema : items
Type:
Show Source
object
-
address1(optional):
string
The address line 1 of the shipping address.
-
address2(optional):
string
The address line 2 of the shipping address.
-
address3(optional):
string
The address line 3 of the shipping address.
-
alias(optional):
string
The alias of the shipping address.
-
city(optional):
string
The city of the shipping address.
-
companyName(optional):
string
The company name of the shipping address.
-
country(optional):
string
The country code of the shipping address.
-
countryName(optional):
string
The display name for the country of the shipping address
-
county(optional):
string
The county of the shipping address.
-
firstName(optional):
string
The first name of the shipping address.
-
lastName(optional):
string
The last name of the shipping address.
-
phoneNumber(optional):
string
The phone Number of the shipping address.
-
postalCode(optional):
string
The postal Code of the shipping address.
-
prefix(optional):
string
The prefix of the shipping address.
-
regionName(optional):
string
The display name for the state of the shipping address
-
repositoryId(optional):
string
The repository ID of the shipping address.
-
state(optional):
string
The state code of the shipping address.
-
types(optional):
array types
The types tagged to the address
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositoryId(optional):
string
repository Id of the address type
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|
|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code