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
A registered shopper has changed their account details
Root Schema : updateProfile_request
Type:
object
A registered shopper has changed their account details
Show Source
-
profile(optional):
object profile
-
profileId(optional):
string
The id of profile
-
type(optional):
string
The type of event
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":[
{
"relativeTo":{
"id":"300002"
},
"function":"admin",
"name":"Administrator",
"repositoryId":"300006",
"description":"role : admin",
"accessRights":[
{
"displayName":null,
"name":"Create Account Address",
"repositoryId":"createAccountAddress",
"description":null
}
],
"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:
Show Source
object
-
abandonedOrderCount(optional):
number
Number of abandoned orders
-
abandonedOrders(optional):
object abandonedOrders
Set of Abandoned orders
-
active(optional):
boolean
Is the profile active
-
billingAddress(optional):
object billingAddress
Default billing address of the profile
-
currentOrganization(optional):
object currentOrganization
The current Organization
-
customerContactId(optional):
string
The external customer contact id.
-
dateOfBirth(optional):
string(date-time)
Date of Birth
-
daytimeTelephoneNumber(optional):
string
The day time phone number of the profile
-
defaultCreditCard(optional):
object defaultCreditCard
-
derivedPriceListGroup(optional):
object derivedPriceListGroup
-
derivedSalePriceList(optional):
object derivedSalePriceList
-
derivedShippingSurchargePriceList(optional):
object derivedShippingSurchargePriceList
-
derivedTaxExemptionCode(optional):
string
Derived Tax Exemption Code
-
dynamicPropertyMapBigString(optional):
string
Dynamic Property Map Big String.
-
dynamicPropertyMapLong(optional):
string
Dynamic Property Map Long.
-
dynamicPropertyMapString(optional):
string
Dynamic Property Map String.
-
email(optional):
string
The email address of the profile
-
firstName(optional):
string
The first name of the profile
-
firstPurchaseDate(optional):
string
First purchase date on the profile
-
firstVisitDate(optional):
string
First Visit Date on the profile
-
GDPRProfileP13nConsentDate(optional):
string
The date on which GDPR personalization consent is granted for the profile.
-
GDPRProfileP13nConsentGranted(optional):
boolean
This is GDPR profile personalization consent flag. can be true or false.
-
homeAddress(optional):
object homeAddress
Home address
-
id(optional):
string
Id
-
lastActivity(optional):
string(date-time)
Last activity
-
lastName(optional):
string
The last name of the profile
-
lastPurchaseAmount(optional):
number
Last purchased amount on the profile
-
lastPurchaseDate(optional):
string
Last purchase date on the profile
-
lastVisitDate(optional):
string
Last visit date on the profile
-
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
Locale
-
login(optional):
string
Login
-
loyaltyPrograms(optional):
array loyaltyPrograms
Loyalty Programs Information
-
middleName(optional):
string
The middle name of the profile
-
numberOfOrders(optional):
integer
Number of Orders
-
numberOfVisits(optional):
integer
Number of Visits on thr profile
-
parentOrganization(optional):
object parentOrganization
The parent Organization
-
previousVisitDate(optional):
string
Previous Visit Date on the profile
-
priceListGroup(optional):
object priceListGroup
-
profileType(optional):
string
The type of profile
-
receiveEmail(optional):
string
The string representation of whether the user wants to recieve email or not
-
receiveEmailDate(optional):
string
The date on which email marketing consent is granted for the profile.
-
registrationDate(optional):
string(date-time)
Registration date
-
roles(optional):
array roles
List of user roles.
-
secondaryAddresses(optional):
array secondaryAddresses
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
-
secondaryAddressesIsTruncated(optional):
boolean
This property will be added to the webhook payload only if the corresponding secondaryAddresses property is truncated. The value for this field will be true always if present
-
secondaryOrganizations(optional):
array secondaryOrganizations
List of secondary organizations that need to associate with the user.
-
sessionOrganization(optional):
object sessionOrganization
The session Organization
-
shippingAddress(optional):
object shippingAddress
Shipping address
-
shippingAddresses(optional):
array shippingAddresses
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
-
shippingAddressesIsTruncated(optional):
boolean
This property will be added to the webhook payload only if the corresponding shippingAddresses property is truncated. The value for this field will be true always if present
-
shippingSurchargePriceList(optional):
object shippingSurchargePriceList
-
siteId(optional):
string
Site Id associated with this profile
-
siteProperties(optional):
object siteProperties
Site Properties
-
sitePropertiesList(optional):
array sitePropertiesList
The list of site related properties for the profile
-
taxExempt(optional):
boolean
if tax is exempted
-
taxExemptionCode(optional):
string
Tax Exemption Code
-
version(optional):
integer
Version
Nested Schema : abandonedOrders
Type:
object
Set of Abandoned orders
Show Source
-
item-id(optional):
string
Item id of the abandoned order
-
orderId(optional):
string
ID of the abandoned order
-
profileId(optional):
string
Profile id of the abandoned order
Nested Schema : billingAddress
Type:
object
Default billing address of the profile
Show Source
-
address1(optional):
string
the address1 of the billing address
-
address2(optional):
string
the address2 of the billing address
-
city(optional):
string
the city of the billing address
-
country(optional):
string
the country of the billing address
-
county(optional):
string
the county of the billing address
-
externalAddressId(optional):
string
External ID of the address
-
firstName(optional):
string
the first name of the billing address
-
lastName(optional):
string
the last name of the billing address
-
phoneNumber(optional):
string
the phone Number of the billing address
-
postalCode(optional):
string
the postal Code of the billing address
-
repositoryId(optional):
string
the id of the billing address
-
state(optional):
string
the state of the billing address
Nested Schema : currentOrganization
Type:
object
The current Organization
Show Source
-
id(optional):
string
The current Organization Id
Nested Schema : defaultCreditCard
Type:
Show Source
object
-
billingAddress(optional):
object billingAddress
Default billing address of the profile
-
cardProps(optional):
object cardProps
-
cardSavedDate(optional):
string
Saved date of the credit card.
-
creditCardNumber(optional):
string
Number of the credit card, required property.
-
creditCardType(optional):
string
Type of the credit card.
-
expirationDayOfMonth(optional):
string
Expiration day of the credit card.
-
expirationYear(optional):
string
Expiration year of the credit card, required property.
-
gatewayConfigId(optional):
string
Gateway configId for the credit card, required property.
-
id(optional):
string
Id of the credit card.
-
iin(optional):
string
iin value of the credit card, required property.
-
nameOnCard(optional):
string
Name on the credit card, required property.
-
source(optional):
string
Source information of the credit card.
-
token(optional):
string
Token of the credit card, required property.
-
tokenCreatedDate(optional):
string
Creation date of the token.
-
tokenExpiryDate(optional):
string
Expiry date of the token.
Nested Schema : derivedPriceListGroup
Type:
Show Source
object
-
active(optional):
boolean
-
currency(optional):
object currency
-
deleted(optional):
boolean
-
displayName(optional):
string
-
endDate(optional):
string
-
id(optional):
string
-
listPriceList(optional):
object listPriceList
-
locale(optional):
string
-
salePriceList(optional):
object salePriceList
-
shippingSurchargePriceList(optional):
object shippingSurchargePriceList
-
startDate(optional):
string
Nested Schema : derivedSalePriceList
Type:
Show Source
object
-
basePriceList(optional):
string
-
creationDate(optional):
string
-
description(optional):
string
-
displayName(optional):
string
-
endDate(optional):
string
-
id(optional):
string
-
item-id(optional):
string
-
itemAcl(optional):
string
-
lastModifiedDate(optional):
string
-
locale(optional):
string
-
startDate(optional):
string
-
version(optional):
integer
Nested Schema : derivedShippingSurchargePriceList
Type:
Show Source
object
-
basePriceList(optional):
string
-
creationDate(optional):
string
-
description(optional):
string
-
displayName(optional):
string
-
endDate(optional):
string
-
id(optional):
string
-
item-id(optional):
string
-
itemAcl(optional):
string
-
lastModifiedDate(optional):
string
-
locale(optional):
string
-
startDate(optional):
string
-
version(optional):
integer
Nested Schema : homeAddress
Type:
object
Home address
Show Source
-
address1(optional):
string
The address1 of the home address
-
address2(optional):
string
The address2 of the home address
-
address3(optional):
string
The address3 of the home address
-
city(optional):
string
The city of the home address
-
companyName(optional):
string
Company Name
-
country(optional):
string
The country of the home address
-
county(optional):
string
The county of the home address
-
externalAddressId(optional):
string
External ID of the address
-
faxNumber(optional):
string
Fax Number
-
firstName(optional):
string
The first name of the home address
-
item-id(optional):
string
Home address Id
-
lastName(optional):
string
Last name
-
middleName(optional):
string
Middle name
-
phoneNumber(optional):
string
The phone Number of the home address
-
postalCode(optional):
string
The postal Code of the home address
-
prefix(optional):
string
Prefix
-
repositoryId(optional):
string
repositoryId
-
state(optional):
string
The state of the home address
-
suffix(optional):
string
Suffix
Nested Schema : parentOrganization
Type:
object
The parent Organization
Show Source
-
externalOrganizationId(optional):
string
The parent Organization external Id
-
id(optional):
string
The parent Organization Id
Nested Schema : priceListGroup
Type:
Show Source
object
-
active(optional):
boolean
-
currency(optional):
object currency
-
deleted(optional):
boolean
-
displayName(optional):
string
-
endDate(optional):
string
-
id(optional):
string
-
listPriceList(optional):
object listPriceList
-
locale(optional):
string
-
salePriceList(optional):
object salePriceList
-
shippingSurchargePriceList(optional):
object shippingSurchargePriceList
-
startDate(optional):
string
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
-
id(optional):
string
The session Organization Id
Nested Schema : shippingAddress
Type:
object
Shipping address
Show Source
-
address1(optional):
string
The address1 of the shipping address
-
address2(optional):
string
The address2 of the shipping address
-
address3(optional):
string
The address3 of the shipping address
-
city(optional):
string
The city of the shipping address
-
companyName(optional):
string
Company Name
-
country(optional):
string
The country of the shipping address
-
county(optional):
string
The county of the shipping address
-
externalAddressId(optional):
string
External ID of the address
-
faxNumber(optional):
string
Fax Number
-
firstName(optional):
string
First name
-
item-id(optional):
string
Shipping address Id
-
lastName(optional):
string
Last name
-
middleName(optional):
string
Middle name
-
phoneNumber(optional):
string
The phone Number of the shipping address
-
postalCode(optional):
string
The postal Code of the shipping address
-
prefix(optional):
string
Prefix
-
repositoryId(optional):
string
repositoryId
-
state(optional):
string
The state of the shipping address
-
suffix(optional):
string
Suffix
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:
Show Source
object
-
basePriceList(optional):
string
-
creationDate(optional):
string
-
description(optional):
string
-
displayName(optional):
string
-
endDate(optional):
string
-
id(optional):
string
-
item-id(optional):
string
-
itemAcl(optional):
string
-
lastModifiedDate(optional):
string
-
locale(optional):
string
-
startDate(optional):
string
-
version(optional):
integer
Nested Schema : siteProperties
Type:
object
Site Properties
Show Source
-
GDPRProfileP13nConsentDate(optional):
string
The date on which GDPR personalization consent is granted for the profile.
-
GDPRProfileP13nConsentGranted(optional):
boolean
This is GDPR profile personalization consent flag. can be true or false.
-
numberOfVisits(optional):
integer
Number of Visits on the site
-
receiveEmail(optional):
string
Indicates whether the user should receive marketing emails on the current site. Can be yes or no.
-
receiveEmailDate(optional):
string
The date on which email marketing consent is granted for the profile.
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
-
address1(optional):
string
the address1 of the billing address
-
address2(optional):
string
the address2 of the billing address
-
city(optional):
string
the city of the billing address
-
country(optional):
string
the country of the billing address
-
county(optional):
string
the county of the billing address
-
firstName(optional):
string
the first name of the billing address
-
lastName(optional):
string
the last name of the billing address
-
phoneNumber(optional):
string
the phone Number of the billing address
-
postalCode(optional):
string
the postal Code of the billing address
-
state(optional):
string
the state of the billing address
Nested Schema : cardProps
Type:
object
Nested Schema : listPriceList
Type:
Show Source
object
-
basePriceList(optional):
string
-
creationDate(optional):
string
-
description(optional):
string
-
displayName(optional):
string
-
endDate(optional):
string
-
id(optional):
string
-
item-id(optional):
string
-
itemAcl(optional):
string
-
lastModifiedDate(optional):
string
-
locale(optional):
string
-
startDate(optional):
string
-
version(optional):
integer
Nested Schema : salePriceList
Type:
Show Source
object
-
basePriceList(optional):
string
-
creationDate(optional):
string
-
description(optional):
string
-
displayName(optional):
string
-
endDate(optional):
string
-
id(optional):
string
-
item-id(optional):
string
-
itemAcl(optional):
string
-
lastModifiedDate(optional):
string
-
locale(optional):
string
-
startDate(optional):
string
-
version(optional):
integer
Nested Schema : shippingSurchargePriceList
Type:
Show Source
object
-
basePriceList(optional):
string
-
creationDate(optional):
string
-
description(optional):
string
-
displayName(optional):
string
-
endDate(optional):
string
-
id(optional):
string
-
item-id(optional):
string
-
itemAcl(optional):
string
-
lastModifiedDate(optional):
string
-
locale(optional):
string
-
startDate(optional):
string
-
version(optional):
integer
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 : listPriceList
Type:
Show Source
object
-
basePriceList(optional):
string
-
creationDate(optional):
string
-
description(optional):
string
-
displayName(optional):
string
-
endDate(optional):
string
-
id(optional):
string
-
item-id(optional):
string
-
itemAcl(optional):
string
-
lastModifiedDate(optional):
string
-
locale(optional):
string
-
startDate(optional):
string
-
version(optional):
integer
Nested Schema : salePriceList
Type:
Show Source
object
-
basePriceList(optional):
string
-
creationDate(optional):
string
-
description(optional):
string
-
displayName(optional):
string
-
endDate(optional):
string
-
id(optional):
string
-
item-id(optional):
string
-
itemAcl(optional):
string
-
lastModifiedDate(optional):
string
-
locale(optional):
string
-
startDate(optional):
string
-
version(optional):
integer
Nested Schema : shippingSurchargePriceList
Type:
Show Source
object
-
basePriceList(optional):
string
-
creationDate(optional):
string
-
description(optional):
string
-
displayName(optional):
string
-
endDate(optional):
string
-
id(optional):
string
-
item-id(optional):
string
-
itemAcl(optional):
string
-
lastModifiedDate(optional):
string
-
locale(optional):
string
-
startDate(optional):
string
-
version(optional):
integer
Nested Schema : items
Type:
Show Source
object
-
accessRights(optional):
array accessRights
Access rights to assign to role
-
description(optional):
string
Description of role
-
function(optional):
string
Function of the role.
-
name(optional):
string
Name of role
-
relativeTo(optional):
object relativeTo
Organization in which the role applies.
-
repositoryId(optional):
string
Repository id of the role.
-
type(optional):
string
Type of role
Nested Schema : relativeTo
Type:
object
Organization in which the role applies.
Show Source
-
id(optional):
string
Organization ID of the role to be assigned
Nested Schema : items
Type:
Show Source
object
-
description(optional):
string
Description of the access right
-
name(optional):
string
Name of the access right
-
repositoryId(optional):
string
Repository ID of access right
Nested Schema : items
Type:
Show Source
object
-
address1(optional):
string
The address1 of the secondary address
-
address2(optional):
string
The address2 of the secondary address
-
address3(optional):
string
The address3 of the secondary address
-
city(optional):
string
The city of the secondary address
-
companyName(optional):
string
The company name of the secondary address
-
country(optional):
string
The country of the secondary address
-
county(optional):
string
The county of the secondary address
-
externalAddressId(optional):
string
External ID of the address
-
faxNumber(optional):
string
The faxNumber of the secondary address
-
firstName(optional):
string
The first name of the secondary address
-
item-id(optional):
string
Item-id for the secondary address
-
lastName(optional):
string
The last name of the secondary address
-
middleName(optional):
string
The middle name of the secondary address
-
phoneNumber(optional):
string
The phone Number of the secondary address
-
postalCode(optional):
string
The postal Code of the secondary address
-
prefix(optional):
string
The prefix of the secondary address
-
repositoryId(optional):
string
The id of the secondary address
-
state(optional):
string
The state of the secondary address
-
suffix(optional):
string
The suffix of the secondary address
-
types(optional):
array types
Types of address. Like SHIPPING, BILLING
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name of type of address
-
id(optional):
string
The id of type of address
-
repositoryId(optional):
string
The repository id of type of address
Nested Schema : items
Type:
Show Source
object
-
id(optional):
string
ID of the organization to be assigned.
Nested Schema : items
Type:
Show Source
object
-
address1(optional):
string
the address1 of the shipping address
-
address2(optional):
string
the address2 of the shipping address
-
address3(optional):
string
the address3 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 of the shipping address
-
county(optional):
string
the county of the shipping address
-
externalAddressId(optional):
string
External ID of the address
-
faxNumber(optional):
string
the faxNumber of the shipping address
-
firstName(optional):
string
the first name of the shipping address
-
item-id(optional):
string
item-id
-
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 id of the shipping address
-
state(optional):
string
the state of the shipping address
-
suffix(optional):
string
the suffix of the shipping address
-
types(optional):
array types
Types of address. Like SHIPPING, BILLING
Nested Schema : items
Type:
Show Source
object
-
displayName(optional):
string
The name of type of address
-
id(optional):
string
The id of type of address
-
repositoryId(optional):
string
The repository id of type of address
Nested Schema : items
Type:
Show Source
object
-
properties(optional):
object properties
The site related properties for the profile
-
site(optional):
object site
The site data
Nested Schema : properties
Type:
object
The site related properties for the profile
Show Source
-
GDPRProfileP13nConsentDate(optional):
string
The date on which GDPR personalization consent is granted for the profile.
-
GDPRProfileP13nConsentGranted(optional):
boolean
This is GDPR profile personalization consent flag. can be true or false.
-
numberOfVisits(optional):
integer
Number of Visits on the site
-
receiveEmail(optional):
string
Indicates whether the user should receive marketing emails on the current site. Can be yes or no.
-
receiveEmailDate(optional):
string
The date on which email marketing consent is granted for the profile.
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