updateProfile
put
/ccadmin/v1/profiles/{id}
Update Profile. This operation is used to update customer name, email address, phone number, shipping address and email marketing flag status of a customer profile. Optionally takes the x-ccasset-language header to get translated content in another language.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the shopper profile to be updated.
Query Parameters
-
exclude(optional): string
As an alternative to the fields parameter, which explicitly specifies the properties to include, you can use the exclude parameter to include all properties except the ones specified. For example, to return all of the properties of profile except shippingAddresses.
-
expand(optional): string
Expand controls which properties are returned. Possible values for the expand query parameter are 'none' to get only the user ID or 'globalRoles' to include standard roles along with the user's organizational roles.
-
fields(optional): string
You can use the fields parameter to restrict the set of properties returned to only those you explicitly specify. The properties are specified as a comma-separated list. For example, id and email properties of profile.
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
-
siteId(optional):
string
Site Id associated with this 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":[
{
"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:
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
-
name(optional):
string
The name of the parent organization
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
-
_actionCode(optional):
string
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.
-
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
-
_actionCode(optional):
string
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.
-
accessRights(optional):
array accessRights
Access rights associated with this role.
-
description(optional):
string
Description of the role.
-
function(optional):
string
Function of the role. Only returned for type organizationalRole.
-
id(optional):
string
ID of the role.
-
name(optional):
string
Name of the role.
-
relativeTo(optional):
object relativeTo
Organization in which the role applies. Only returned for organizationalRole.
-
repositoryId(optional):
string
Repository id of the role.
-
type(optional):
string
Type of the role. Can be role or organizationalRole
Nested Schema : relativeTo
Type:
object
Organization in which the role applies. Only returned for organizationalRole.
Show Source
-
externalOrganizationId(optional):
string
ID of the external organization. Default is null.
-
id(optional):
string
ID of the organization in which this role applies.
Nested Schema : items
Type:
Show Source
object
-
description(optional):
string
Description of the access right
-
displayName(optional):
string
Display name of the access right
-
id(optional):
string
ID of the access right.
-
name(optional):
string
Name of the access right
-
repositoryId(optional):
string
Repository ID of the access right
-
type(optional):
string
Type of the access right. Can be generic or privilege.
Nested Schema : items
Type:
Show Source
object
-
_actionCode(optional):
string
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.
-
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
-
_actionCode(optional):
string
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.
-
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
-
_actionCode(optional):
string
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(optional):
string
ID of the organization to be assigned.
Nested Schema : items
Type:
Show Source
object
-
_actionCode(optional):
string
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.
-
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
-
_actionCode(optional):
string
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.
-
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
-
_actionCode(optional):
string
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.
-
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
the status of the profile. Should be true or false
-
billingAddress(optional):
object billingAddress
Default billing address of the profile
-
catalog(optional):
string
This is a read only attribute added for 'Account Based Commerce', this is the ID of the catalog that is associated with the organization to which this user is associated
-
creditCards(optional):
array creditCards
List of user credit cards.
-
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
-
derivedPriceListGroup(optional):
object derivedPriceListGroup
The derived price list group from the user's parent organization
-
derivedSalePriceList(optional):
object derivedSalePriceList
The derived sale price list from the user's parent organization
-
derivedShippingSurchargePriceList(optional):
object derivedShippingSurchargePriceList
The derived shipping surcharge price list from the user's parent organization
-
derivedTaxExemptionCode(optional):
string
Derived Tax Exemption Code
-
dynamicInternalOnlyProperty(optional):
object dynamicInternalOnlyProperty
the value of the internal only dynamic property
-
dynamicProperty(optional):
object dynamicProperty
the value of the dynamic property
-
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
-
lastActivity(optional):
number
Last activity of the profile
-
lastName(optional):
string
the last name of the profile
-
lastPurchaseAmount(optional):
number
The amount of the last purchase.
-
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
the locale of the request/response
-
loyaltyPrograms(optional):
array loyaltyPrograms
Loyalty Programs Information
-
numberOfOrders(optional):
number
The number of orders the shopper has placed.
-
numberOfVisits(optional):
integer
Number of Visits on the profile
-
parentOrganization(optional):
object parentOrganization
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
-
previousVisitDate(optional):
string
Previous Visit Date on the profile
-
priceListGroup(optional):
object priceListGroup
The associated price list group for this user
-
profileType(optional):
string
This attribute is added for account based commerce. It's value is 'b2b_user'
-
receiveEmail(optional):
string
this is site specific email marketing flag. Can be yes or no
-
receiveEmailDate(optional):
string
the date on which email marketing consent was granted
-
registrationDate(optional):
string
The date the shopper registered.
-
repositoryId(optional):
string
the id of the profile
-
roles(optional):
array roles
List of user roles.
-
secondaryOrganizations(optional):
array secondaryOrganizations
List of secondary organizations associated to profile. It will be empty always. Secondary Organizations associated to the profile can be fetched using organization endpoints
-
shippingAddress(optional):
object profile_shippingAddress
Default shipping address of the profile (Deprecated, please use ???shippingAddresses??? instead).
-
shippingAddresses(optional):
array shippingAddresses
List of shipping addresses associated with profile.
-
shippingSurchargePriceList(optional):
object shippingSurchargePriceList
The shipping surcharge price list for this user
-
taxExempt(optional):
boolean
Indicates tax exemption status.True or False
-
taxExemptionCode(optional):
string
Tax Exemption Code
-
translations(optional):
array translations
List of available locales for the user
-
userType(optional):
integer
Type of the user (property not used currently)
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
-
address3(optional):
string
The address3 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 address id
-
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
-
types(optional):
array types
The types tagged to the address
Nested Schema : derivedPriceListGroup
Type:
object
The derived price list group from the user's parent organization
Show Source
-
repositoryId(optional):
string
Repository ID
Nested Schema : derivedSalePriceList
Type:
object
The derived sale price list from the user's parent organization
Show Source
-
repositoryId(optional):
string
Repository ID
Nested Schema : derivedShippingSurchargePriceList
Type:
object
The derived shipping surcharge price list from the user's parent organization
Show Source
-
repositoryId(optional):
string
Repository ID
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 : 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
-
active(optional):
boolean
the status of the parent organization. Should be true or false
-
billingAddress(optional):
object billingAddress
Default billing address of the profile
-
description(optional):
string
Description of the Organization
-
externalOrganizationId(optional):
string
External organization id
-
id(optional):
string
the id of the parent organization
-
name(optional):
string
the name of the parent organization
-
repositoryId(optional):
string
the id of the parent organization
-
secondaryAddresses(optional):
array secondaryAddresses
List of shipping addresses associated with profile.
-
shippingAddress(optional):
object shippingAddress
Default shipping address of the profile
Nested Schema : priceListGroup
Type:
object
The associated price list group for this user
Show Source
-
repositoryId(optional):
string
Repository ID
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
-
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
-
country(optional):
string
The country of the shipping address
-
county(optional):
string
The county of the shipping address
-
externalAddressId(optional):
string
External address id
-
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
-
repositoryId(optional):
string
The id of the shipping address
-
state(optional):
string
The state 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
-
Array of:
object profile_shippingAddress_response
Shipping address associated with the profile
Nested Schema : shippingSurchargePriceList
Type:
object
The shipping surcharge price list for this user
Show Source
-
repositoryId(optional):
string
Repository ID
Nested Schema : types
Type:
array
The types tagged to the address
Show Source
-
Array of:
array items
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
Nested Schema : items
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.
-
expirationMonth(optional):
string
Expiration month of the credit card, required property.
-
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.
-
nickname(optional):
string
Nick name of the credit card.
-
repositoryId(optional):
string
The id of the credit card
-
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 : 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
-
address3(optional):
string
The address3 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 address id
-
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
-
types(optional):
object types
Nested Schema : cardProps
Type:
object
Nested Schema : types
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
-
membershipId(optional):
string
membershipId of the profile for the program.
-
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 : 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 address id
-
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 : 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
-
address1(optional):
string
the address1 of the shipping address
-
address2(optional):
string
the address2 of the shipping address
-
city(optional):
string
the city 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 address id
-
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
-
repositoryId(optional):
string
the id of the shipping address
-
state(optional):
string
the state of the shipping address
-
types(optional):
array types
The types tagged to the address
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
-
city(optional):
string
the city 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 address id
-
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
-
repositoryId(optional):
string
the id of the shipping address
-
state(optional):
string
the state 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
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
-
function(optional):
string
Function of the role which can be admin or buyer. Present only if type is organizationalRole.
-
id(optional):
string
ID of the role.
-
name(optional):
string
Name of the role.
-
relativeTo(optional):
object relativeTo
Organization in which the role applies. Present only if type is organizationalRole.
-
repositoryId(optional):
string
Repository id of the role.
-
type(optional):
string
Type of the role which can be organizationalRole or role.
Nested Schema : relativeTo
Type:
object
Organization in which the role applies. Present only if type is organizationalRole.
Show Source
-
id(optional):
string
Organization ID
Nested Schema : items
Type:
Show Source
object
-
active(optional):
boolean
the status of the organization. Should be true or false
-
billingAddress(optional):
object billingAddress
Default billing address of the profile
-
description(optional):
string
Description of the organization
-
externalOrganizationId(optional):
string
External organization id
-
name(optional):
string
the name of the organization
-
repositoryId(optional):
string
Repository ID
-
secondaryAddresses(optional):
array secondaryAddresses
List of shipping addresses associated with profile.
-
shippingAddress(optional):
object shippingAddress
Default shipping address of the profile
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 address id
-
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
-
types(optional):
array types
The types tagged to the address
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
-
address1(optional):
string
the address1 of the shipping address
-
address2(optional):
string
the address2 of the shipping address
-
city(optional):
string
the city 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 address id
-
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
-
repositoryId(optional):
string
the id of the shipping address
-
state(optional):
string
the state 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
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
-
city(optional):
string
the city 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 address id
-
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
-
repositoryId(optional):
string
the id of the shipping address
-
state(optional):
string
the state 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
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
-
id(optional):
string
repository Id of the address type
Nested Schema : profile_shippingAddress_response
Type:
object
Shipping address associated with the profile
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
-
country(optional):
string
The country of the shipping address
-
county(optional):
string
The county of the shipping address
-
externalAddressId(optional):
string
External address id
-
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
-
repositoryId(optional):
string
The id of the shipping address
-
state(optional):
string
The state 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
Example Response (application/json)
{
"derivedPriceListGroup":null,
"lastName":"Anderson",
"GDPRProfileP13nConsentDate":null,
"GDPRProfileP13nConsentGranted":false,
"gender":"female",
"catalog":null,
"roles":[
{
"function":"buyer",
"relativeTo":{
"id":"900004"
},
"repositoryId":"100006",
"name":"Buyer",
"id":"100006",
"type":"organizationalRole"
}
],
"locale":"en",
"parentOrganization":{
"name":"Oracle",
"repositoryId":"900004",
"description":"Oracle Org",
"active":true,
"shippingAddress":{
},
"secondaryAddresses":[
{
"firstName":"Harry",
"lastName":"Potter",
"country":"United States",
"externalAddressId":"EXT_ADDR_1",
"types":[
{
"displayName":"Billing",
"repositoryId":"ss-10002",
"id":"ss-10002"
}
],
"phoneNumber":"9088988999",
"city":"Arcadia",
"address2":"Suite 400",
"address1":"Grundy Lane",
"postalCode":"91006",
"repositoryId":"110033",
"state":"CA"
}
],
"id":"900004",
"billingAddress":{
},
"externalOrganizationId":"EXT_ORG_1"
},
"shippingSurchargePriceList":null,
"receiveEmailDate":null,
"profileType":"b2b_user",
"translations":{
},
"loyaltyPrograms":[
{
"programName":"XTRAREWARDS",
"repositoryId":100001,
"membershipId":"abc123",
"programId":"prog1",
"status":"Enrolled"
},
{
"programName":"XTRAMILES",
"repositoryId":100002,
"membershipId":"xyz123",
"programId":"prog2",
"status":"RequestForEnrollment"
}
],
"id":"se-570031",
"email":"kim@example.com",
"daytimeTelephoneNumber":"212-555-1977",
"derivedSalePriceList":null,
"taxExempt":false,
"customerContactId":"CRMID_12345",
"receiveEmail":"no",
"active":"true",
"priceListGroup":null,
"dateOfBirth":null,
"firstName":"Kim",
"repositoryId":"se-570031",
"shippingAddress":{
},
"billingAddress":{
},
"userType":null,
"derivedShippingSurchargePriceList":null,
"secondaryOrganizations":[
],
"shippingAddresses":[
]
}
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|
|------------------|------------------|
|100088|You cannot remove the Approver role from this contact. The account has no other active Approvers. Approvals are still enabled and/or there are orders pending approval.|
|22000|If the profile id passes is null or empty|
|100089|You cannot deactivate this contact. The account has no other active Approvers. Approvals are still enabled and/or there are orders pending approval|
|22001|If there was any internal error while getting the profile|
|22002|If there was no profile found with the given id|
|89003|If user is removing admin role for himself|
|22007|If invalid input is provided|
|89001|If invalid roles are provided|
|22024|{0}({1}) must be a String|
|22025|Format for loyaltyPrograms is incorrect. Please refer to API doc for more information|
|22026|{0} is either missing or incorrect.|
|22027|Invalid state is provided.|
|180106|One or more address type ID is invalid|
|23041|You cannot activate or inactivate this profile as it is linked to multiple accounts.|
|13001|If role function is given as 'custom' but no repositoryId is given.|
|
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