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(required): string
The ID of the requested shopper profile.
Query Parameters
-
exclude: 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: string
Expand controls which properties are returned. Set the expand query parameter to 'roles' to fetch detailed information about roles.
-
fields: 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: string
If true, then preview profile will be returned.
Header Parameters
-
X-CCAsset-Language: 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
-
hasIncompleteOrder:
boolean
Indicates whether the profile has an incomplete order on the current site.
-
isAnonymous:
boolean
Indicates whether the profile is persistent or transient.
-
profileComments:
array profileComments
The list of all logged comments for the customer profile.
-
profileDetail:
object profileDetail
The details of the customer profile.
Nested Schema : profileComments
Type:
array
The list of all logged comments for the customer profile.
Show Source
Nested Schema : profileDetail
Type:
object
The details of the customer profile.
Show Source
-
active:
boolean
The user status of the profile. Should be true or false
-
approvalRequired:
boolean
Indicates if approval is required
-
catalog:
object catalog
The catalog associated with this profile.
-
comments:
array comments
The notes on the customer.
-
contactBillingAddress(required):
object contactBillingAddress
The default billing address for B2B contact.
-
contactShippingAddress:
object contactShippingAddress
The default shipping address for B2B contact
-
currentOrganization:
object currentOrganization
The current Organization
-
customerContactId:
string
The external customer contact id.
-
dateOfBirth:
string
Date of birth
-
daytimeTelephoneNumber:
string
The day time telephone number of the customer profile.
-
derivedTaxExemptionCode:
string
Derived Tax Exemption Code
-
dynamicProperties:
array dynamicProperties
Read-only list of dynamic properties associated with profile along with meta-data.
-
email:
string
Email of the customer profile.
-
firstName:
string
The first name of the customer profile.
-
GDPRProfileP13nConsentDate:
string
The date on which GDPR personalization consent was granted by the user.
-
GDPRProfileP13nConsentGranted:
boolean
Indicates whether the user has given GDPR Profile P13n consent on the current site. Can be true or false.
-
id:
string
The customer profile id.
-
lastName:
string
Last name of the customer profile.
-
locale:
string
Current Locale
-
login:
string
Login id of the profile.
-
loyaltyPrograms:
array loyaltyPrograms
Loyalty Programs Information
-
orderPriceLimit:
number
Order Price Limit of the profile
-
parentOrganization:
object parentOrganization
The parent Organization associated with the B2B customer profile.
-
priceListGroup:
object priceListGroup
The associated price list group for this profile
-
profileType:
string
The type of the user. Possible values are b2b_user and b2c_user.
-
receiveEmail:
string
Indicates whether the customer has opted for receiving marketing emails on the current site. Can be yes or no.
-
receiveEmailDate:
string
The date on which the customer opted for receiving marketing emails.
-
repositoryId:
string
The repository id of the customer profile record.
-
roles:
array roles
List of user roles.
-
secondaryAddresses(required):
object secondaryAddresses
Secondary addresses for B2B contact.
-
secondaryOrganizations:
array secondaryOrganizations
List of secondary organizations that need to associate with the user.
-
shippingAddress:
object shippingAddress
Default shipping address of the profile (Deprecated, please use ???shippingAddresses??? instead).
-
shippingAddresses:
array shippingAddresses
The shipping addresses associated with the customer profile.
-
taxExempt:
boolean
Indicates tax exemption status.True or False
-
taxExemptionCode:
string
Tax Exemption Code
Nested Schema : items
Type:
Show Source
object
-
comment:
string
The comment string.
-
creationDate:
string
The of creation date of the comment.
-
repositoryId:
string
The repository id of the comment record.
Nested Schema : catalog
Type:
object
The catalog associated with this profile.
Show Source
-
repositoryId:
string
RepositoryId of the catalog associated with this profile.
Nested Schema : comments
Type:
array
The notes on the customer.
Show Source
-
Array of:
object items
The info of the customer
Nested Schema : contactBillingAddress
Type:
object
The default billing address for B2B contact.
Show Source
-
address1:
string
Address line 1 for this billing address.
-
address2:
string
Address line 2 for this billing address.
-
address3:
string
Address line 3 for this billing address.
-
city:
string
City for this billing address.
-
companyName:
string
Company name for this billing address.
-
country:
string
Country for this billing address.
-
county:
string
County for this billing address.
-
dynamicProperty:
object dynamicProperty
The value of the dynamic Property
-
email:
string
Email for this billing address.
-
externalAddressId:
string
External address id
-
faxNumber:
string
Fax number for this billing address.
-
firstName:
string
First name for this billing address.
-
jobTitle:
string
Job title for this billing address.
-
lastName:
string
Last name for this billing address.
-
middleName:
string
Middle name for this billing address.
-
phoneNumber:
string
Phone number for this billing address.
-
postalCode:
string
Postal code for this billing address.
-
prefix:
string
Prefix for this billing address.
-
repositoryId:
string
The repository id of the billing address
-
state:
string
State for this billing address.
-
suffix:
string
Suffix for this billing address.
Nested Schema : contactShippingAddress
Type:
object
The default shipping address for B2B contact
Show Source
-
address1:
string
The address line 1 in the shipping address.
-
address2:
string
The address line 2 in the shipping address.
-
address3:
string
The address line 3 in the shipping address.
-
city:
string
The city in the shipping address record.
-
companyName:
string
Company name for this address.
-
country:
string
The country in the shipping address record.
-
county:
string
The county in the shipping address.
-
dynamicProperty:
object dynamicProperty
The value of the dynamic Property
-
externalAddressId:
string
External address id
-
faxNumber:
string
Fax number for this address.
-
firstName:
string
The first name in the shipping address.
-
jobTitle:
string
Job title for this address.
-
lastName:
string
The last name in the shipping address.
-
middleName:
string
Middle name for this address.
-
phoneNumber:
string
The phone number in the shipping address.
-
postalCode:
string
The postal code in the shipping address.
-
prefix:
string
Prefix for this address.
-
repositoryId:
string
The repository id of the shipping address record.
-
state:
string
The state in the shipping address.
-
suffix:
string
Suffix for this address.
Nested Schema : currentOrganization
Type:
object
The current Organization
Show Source
-
id:
string
The current Organization Id
Nested Schema : dynamicProperties
Type:
array
Read-only list of dynamic properties associated with profile along with meta-data.
Show Source
Nested Schema : parentOrganization
Type:
object
The parent Organization associated with the B2B customer profile.
Show Source
-
id:
string
The id of the organization.
-
name:
string
The name of of the organization.
-
punchoutUserId:
string
Punchout user Id of organization, read only property.
-
repositoryId:
string
The repository id of the comment record.
Nested Schema : priceListGroup
Type:
object
The associated price list group for this profile
Show Source
-
repositoryId:
string
Repository ID of the price list group
Nested Schema : secondaryAddresses
Type:
object
Secondary addresses for B2B contact.
Show Source
-
address1:
string
Address line 1 for this address.
-
address2:
string
Address line 2 for this address.
-
address3:
string
Address line 3 for this address.
-
city:
string
City for this address.
-
companyName:
string
Company name for this address.
-
country:
string
Country for this address.
-
county:
string
County for this address.
-
dynamicProperty:
object dynamicProperty
The value of the dynamic Property
-
email:
string
Email for this address.
-
externalAddressId:
string
External address id
-
faxNumber:
string
Fax number for this address.
-
firstName:
string
First name for this address.
-
jobTitle:
string
Job title for this address.
-
lastName:
string
Last name for this address.
-
middleName:
string
Middle name for this address.
-
phoneNumber:
string
Phone number for this address.
-
postalCode:
string
Postal code for this address.
-
prefix:
string
Prefix for this address.
-
repositoryId:
string
The repository id of this address.
-
state:
string
State for this address.
-
suffix:
string
Suffix for this address.
Nested Schema : secondaryOrganizations
Type:
array
List of secondary organizations that need to associate with the user.
Show Source
Nested Schema : shippingAddress
Type:
object
Default shipping address of the profile (Deprecated, please use ???shippingAddresses??? instead).
Show Source
-
address1:
string
The address line 1 in the shipping address.
-
address2:
string
The address line 2 in the shipping address.
-
address3:
string
The address line 3 in the shipping address.
-
alias:
string
The alias of the shipping address.
-
city:
string
The city in the shipping address record.
-
companyName:
string
Company name for this address.
-
country:
string
The country in the shipping address record.
-
county:
string
The county in the shipping address.
-
dynamicProperty:
object dynamicProperty
The value of the dynamic Property
-
externalAddressId:
string
External address id
-
faxNumber:
string
Fax number for this address.
-
firstName:
string
The first name in the shipping address.
-
jobTitle:
string
Job title for this address.
-
lastName:
string
The last name in the shipping address.
-
middleName:
string
Middle name for this address.
-
phoneNumber:
string
The phone number in the shipping address.
-
postalCode:
string
The postal code in the shipping address.
-
prefix:
string
Prefix for this address.
-
repositoryId:
string
The repository id of the shipping address record.
-
state:
string
The state in the shipping address.
-
suffix:
string
Suffix for this address.
Nested Schema : shippingAddresses
Type:
array
The shipping addresses associated with the customer profile.
Show Source
Nested Schema : items
Type:
object
The info of the customer
Show Source
-
agent:
string
The user id of the Agent.
-
comment:
string
The description of comment.
-
creationDate:
string
The creation date of the note.
-
id:
string
The id of the comment.
-
item-id:
string
The item-id of the comment
-
owner:
string
The owner of the note.
-
version:
integer
The version of the note.
Nested Schema : dynamicProperty
Type:
object
The value of the dynamic Property
Nested Schema : dynamicProperty
Type:
object
The value of the dynamic Property
Nested Schema : items
Type:
Show Source
object
-
id:
string
The ID of the dynamic property.
-
type:
string
The type of the dynamic property. Supported types are boolean, date, float, string, timestamp, enumerated, big string.
-
value:
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object
-
membershipId:
string
membershipId of the profile.
-
programId:
string
programId of Loyalty Program
-
programName:
string
programName of Loyalty Program
-
repositoryId:
string
repository Id
-
status:
string
status of Enrollment
Nested Schema : items
Type:
Show Source
object
-
associations:
array associations
Associations of the role.
-
function:
string
Function of the role which can be admin or buyer.
-
id:
string
ID of the role
-
name:
string
Name of the role
-
relativeTo:
string
OrganizationId in which the role applies. Present only if type is organizationalRole
-
repositoryId:
string
Repository id of the role.
-
type:
string
Type of the role which can be organizationalRole or role
Nested Schema : items
Type:
Show Source
object
- relatedItemId: string
-
type:
string
Type of the association.Possible values are - organization,global.
Nested Schema : dynamicProperty
Type:
object
The value of the dynamic Property
Nested Schema : dynamicProperty
Type:
object
The value of the dynamic Property
Nested Schema : items
Type:
Show Source
object
-
address1:
string
The address line 1 in the shipping address.
-
address2:
string
The address line 2 in the shipping address.
-
address3:
string
The address line 3 in the shipping address.
-
alias:
string
The alias of the shipping address.
-
city:
string
The city in the shipping address record.
-
companyName:
string
The company name of the person in the shipping address.
-
country:
string
The country in the shipping address record.
-
county:
string
The county in the shipping address.
-
dynamicProperty:
object dynamicProperty
The value of the dynamic Property
-
externalAddressId:
string
External address id
-
faxNumber:
string
The fax number in the shipping address.
-
firstName:
string
The first name in the shipping address.
-
isDefaultAddress:
boolean
Indicates if its the default shipping address.
-
jobTitle:
string
The job title of the person in the shipping address.
-
lastName:
string
The last name in the shipping address.
-
middleName:
string
The middle name in the shipping address.
-
phoneNumber:
string
The phone number in the shipping address.
-
postalCode:
string
The postal code in the shipping address.
-
prefix:
string
Prefix for this address.
-
repositoryId:
string
The repository id of the shipping address record.
-
selectedCountry:
string
The selected country in the shipping address.
-
selectedState:
string
The selected state in the shipping address.
-
state:
string
The state in the shipping address.
-
state_ISOCode:
string
The state ISO code in the shipping address.
-
suffix:
string
The suffix of the person in the shipping address
Nested Schema : dynamicProperty
Type:
object
The value of the dynamic Property
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",
"accessRights":[
],
"type":"organizationalRole",
"category":{
"displayName":"Storefront Roles",
"repositoryId":"storefrontRoleCategory",
"id":"storefrontRoleCategory"
}
},
{
"repositoryId":"200001",
"name":"Sample CustomRole",
"id":"200001",
"accessRights":[
{
"displayName":"Sample AccessRight",
"name":"Sample AccessRight",
"repositoryId":"300001",
"id":"300001",
"type":"generic"
}
],
"type":"role",
"category":{
"displayName":"Custom Roles",
"repositoryId":"customRoleCategory",
"id":"customRoleCategory"
}
}
],
"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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code