getProfile
get
/ccadmin/v1/profiles/{id}
Get Profile. This operation is used to get the profile information of a customer from Oracle Commerce Cloud. 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 requested shopper profile.
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. Set the expand query parameter to 'globalRoles' to include standard roles along with a 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.
-
preview(optional): string
If true, then preview profile will be returned.
Header Parameters
-
X-CCAsset-Language(optional): string
The asset language of the request
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getProfile_response
Type:
Show Source
object-
active(optional):
boolean
the user 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
get the shopper profile with id
-
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
-
login(optional):
string
login of the user
-
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:
objectDefault 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 shipping 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:
objectThe derived price list group from the user's parent organization
Show Source
-
repositoryId(optional):
string
Repository ID
Nested Schema : derivedSalePriceList
Type:
objectThe derived sale price list from the user's parent organization
Show Source
-
repositoryId(optional):
string
Repository ID
Nested Schema : derivedShippingSurchargePriceList
Type:
objectThe derived shipping surcharge price list from the user's parent organization
Show Source
-
repositoryId(optional):
string
Repository ID
Nested Schema : dynamicInternalOnlyProperty
Type:
objectthe value of the internal only dynamic property
Nested Schema : dynamicProperty
Type:
objectthe value of the dynamic Property
Nested Schema : parentOrganization
Type:
objectThis 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 organization
-
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 organization
Nested Schema : priceListGroup
Type:
objectThe associated price list group for this user
Show Source
-
repositoryId(optional):
string
Repository ID
Nested Schema : secondaryOrganizations
Type:
arrayList 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:
objectDefault 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:
arrayList of shipping addresses associated with profile.
Show Source
-
Array of:
object profile_shippingAddress_response
Shipping address associated with the profile
Nested Schema : shippingSurchargePriceList
Type:
objectThe shipping surcharge price list for this user
Show Source
-
repositoryId(optional):
string
Repository ID
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.
-
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:
objectDefault 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 : cardProps
Type:
objectNested Schema : items
Type:
Show Source
object-
displayName(optional):
string
The name of the address type
-
id(optional):
string
repository Id of the address type
-
repositroyId(optional):
string
repository Id of the address type
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 : billingAddress
Type:
objectDefault billing address of the organization
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:
arrayList of shipping addresses associated with profile.
Show Source
Nested Schema : shippingAddress
Type:
objectDefault shipping address of the organization
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
-
repositroyId(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.
-
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:
objectOrganization 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:
objectDefault 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:
arrayList of shipping addresses associated with profile.
Show Source
Nested Schema : shippingAddress
Type:
objectDefault 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:
objectShipping 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,
"lastPurchaseDate":null,
"lastName":"K",
"GDPRProfileP13nConsentDate":null,
"GDPRProfileP13nConsentGranted":false,
"gender":"female",
"catalog":null,
"roles":[
{
"function":"buyer",
"relativeTo":{
"id":"100001"
},
"repositoryId":"100006",
"name":"Buyer",
"type":"organizationalRole"
}
],
"parentOrganization":{
"name":"Oracle",
"repositoryId":"100001",
"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":"100001",
"billingAddress":{
},
"externalOrganizationId":"EXT_ORG_1"
},
"locale":"en",
"shippingSurchargePriceList":null,
"receiveEmailDate":null,
"firstPurchaseDate":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":"Enrolled"
}
],
"registrationDate":null,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadmin/v1/shopperProfiles/110006?offset=0&limit=2&sort=firstName%3Adesc"
}
],
"id":"110006",
"email":"abc@example.com",
"derivedSalePriceList":null,
"daytimeTelephoneNumber":"212-555-1977",
"taxExempt":false,
"customerContactId":"CRMID_12345",
"receiveEmail":"no",
"priceListGroup":null,
"active":"true",
"dateOfBirth":null,
"lastVisitDate":null,
"previousVisitDate":null,
"firstName":"bcd",
"creditCards":[
{
"expirationYear":"2017",
"tokenExpiryDate":null,
"gatewayConfigId":null,
"expirationMonth":"1",
"creditCardType":"Visa",
"source":null,
"iin":null,
"token":null,
"cardProps":{
},
"nameOnCard":null,
"creditCardNumber":"4539082039396288",
"repositoryId":"se-usercc110031",
"nickname":"Visa",
"tokenCreatedDate":"2018-10-01T09:02:10.181Z",
"cardSavedDate":null,
"billingAddress":{
"country":"US",
"lastName":"Anderson",
"types":[
{
"displayName":"Billing",
"repositoryId":"ss-10002",
"id":"ss-10002"
}
],
"address3":null,
"city":"Buffalo",
"address2":null,
"address1":"451 Brooks Ave",
"postalCode":"14201",
"county":null,
"firstName":"Kim",
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":"212-555-2150",
"repositoryId":"se-990031",
"state":"NY"
},
"id":"se-usercc110031",
"expirationDayOfMonth":null
}
],
"repositoryId":"110006",
"firstVisitDate":null,
"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|
|------------------|------------------|
|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|
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:
arrayAn 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