Shopper Profile Create
post
/ccadmin/v1/webhook/profile
The details of customer profile created on Oracle Commerce Cloud. This includes the email, first name and last name of the customer.
Request
Supported Media Types
- application/json
This Event is triggered when a profile is created/updated
Root Schema : profile_request
Type:
object
This Event is triggered when a profile is created/updated
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":"160004",
"profile":{
"lastPurchaseDate":null,
"dynamicPropertyMapLong":{
},
"GDPRProfileP13nConsentDate":"2018-01-01T00:00:00.000Z",
"GDPRProfileP13nConsentGranted":true,
"secondaryAddresses":{
},
"shippingSurchargePriceList":null,
"firstPurchaseDate":null,
"profileType":null,
"loyaltyPrograms":[
],
"lastPurchaseAmount":0,
"registrationDate":"2017-09-14T07:30:12.428Z",
"sessionOrganization":null,
"id":"160004",
"lifetimeAOV":0,
"daytimeTelephoneNumber":null,
"derivedSalePriceList":null,
"homeAddress":{
"country":null,
"lastName":null,
"address3":null,
"city":null,
"address2":null,
"prefix":null,
"address1":null,
"companyName":null,
"postalCode":null,
"county":null,
"suffix":null,
"externalAddressId":"abcTest",
"firstName":null,
"phoneNumber":null,
"item-id":null,
"repositoryId":"180004",
"faxNumber":null,
"middleName":null,
"state":null
},
"customerContactId":"CRMID_12345",
"taxExempt":false,
"dynamicPropertyMapBigString":{
},
"active":true,
"previousVisitDate":null,
"lastVisitDate":null,
"taxExemptionCode":null,
"version":7,
"abandonedOrderCount":0,
"firstName":"SepNew",
"defaultCreditCard":null,
"creditCards":{
},
"derivedTaxExemptionCode":null,
"currentOrganization":null,
"secondaryOrganizations":[
],
"shippingAddresses":[
],
"derivedPriceListGroup":null,
"lastName":"SepNew",
"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":0,
"locale":"en",
"login":"example@example.com",
"receiveEmailDate":"2018-01-01T00:00:00.000Z",
"sitePropertiesList":[
{
"site":{
"id":"100001"
},
"properties":{
"GDPRProfileP13nConsentDate":"2018-01-01T00:00:00.000Z",
"GDPRProfileP13nConsentGranted":true,
"receiveEmail":"no",
"receiveEmailDate":"2018-01-01T00:00:00.000Z"
}
},
{
"site":{
"id":"100002"
},
"properties":{
"GDPRProfileP13nConsentDate":"2018-01-01T00:00:00.000Z",
"GDPRProfileP13nConsentGranted":true,
"receiveEmail":"no",
"receiveEmailDate":"2018-01-01T00:00:00.000Z"
}
},
{
"site":{
"id":"siteUS"
},
"properties":{
"GDPRProfileP13nConsentDate":"2018-01-01T00:00:00.000Z",
"GDPRProfileP13nConsentGranted":true,
"receiveEmail":"no",
"receiveEmailDate":"2018-01-01T00:00:00.000Z"
}
}
],
"lifetimeSpend":0,
"dynamicPropertyMapString":{
},
"email":"example@example.com",
"siteProperties":{
"100001":{
"receiveEmail":"no"
},
"100002":{
"receiveEmail":"no"
},
"siteUS":{
"receiveEmail":"no"
}
},
"comments":[
],
"priceListGroup":null,
"receiveEmail":"no",
"dateOfBirth":null,
"shippingAddress":null,
"lastActivity":"2017-09-14T07:30:12.428Z",
"middleName":null,
"billingAddress":null,
"derivedShippingSurchargePriceList":null,
"dynamicPropertyMapDouble":{
},
"abandonedOrders":[
]
},
"siteId":"100002",
"type":"atg.dps.ProfileUpdate"
}
Nested Schema : profile
Type:
Show Source
object
-
abandonedOrderCount(optional):
number
Number of abandoned orders
-
active(optional):
boolean
Is the profile active
-
billingAddress(optional):
object billingAddress
Default billing address of the profile
-
comments(optional):
array comments
the notes on the customer.
-
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
-
derivedPriceListGroup(optional):
object derivedPriceListGroup
-
derivedSalePriceList(optional):
object derivedSalePriceList
-
derivedShippingSurchargePriceList(optional):
object derivedShippingSurchargePriceList
-
email(optional):
string
The email address of the profile
-
firstName(optional):
string
The first name of 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
-
locale(optional):
string
Locale
-
login(optional):
string
Login
-
loyaltyPrograms(optional):
array loyaltyPrograms
Loyalty Programs Information
-
middleName(optional):
string
The middle name of the profile
-
parentOrganization(optional):
object parentOrganization
The parent Organization
-
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
-
relativeTo(optional):
array relativeTo
If not provided organization id will be cosidered as its parent organization ID.
-
roles(optional):
array roles
List of user roles.
-
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
-
sitePropertiesList(optional):
array sitePropertiesList
The list of site related properties for the profile
-
taxExempt(optional):
boolean
if tax is exempted
-
version(optional):
integer
Version
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 : comments
Type:
array
the notes on the customer.
Show Source
-
Array of:
object items
The info of the customer
Nested Schema : currentOrganization
Type:
object
The current Organization
Show Source
-
id(optional):
string
The current Organization Id
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 : relativeTo
Type:
array
If not provided organization id will be cosidered as its parent organization ID.
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 : sitePropertiesList
Type:
array
The list of site related properties for the profile
Show Source
Nested Schema : items
Type:
object
The info of the customer
Show Source
-
agent(optional):
string
The type of update.
-
comment(optional):
string
The description of comment.
-
creationDate(optional):
string
The creation date of the note.
-
id(optional):
string
The id of the comment.
-
item-id(optional):
string
The item-id of the comment
-
owner(optional):
string
The owner of the note.
-
version(optional):
integer
The version of the note.
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
-
id(optional):
string
Organization ID of the role to be assigned.
Nested Schema : items
Type:
Show Source
object
-
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
-
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
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.
-
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
No response is returned as this is an event webhook