getProfile
get
/ccagent/v1/profiles/{id}
Get Profile. Get details of a customer profile. Optionally takes X-CCOrganization & x-ccsite header.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The customer profile id.
Header Parameters
-
X-CCOrganization(optional): string
The organization Id to which the profile belongs to
-
x-ccsite(optional): string
the site id corresponding to which site specific properties should be shown
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getProfile_response
Type:
Show Source
object-
hasIncompleteOrder(optional):
boolean
Indicates whether the profile has an incomplete order on the current site.
-
isAnonymous(optional):
boolean
Indicates whether the profile is persistent or transient.
-
profileComments(optional):
array profileComments
The list of all logged comments for the customer profile.
-
profileDetail(optional):
object profileDetail
The details of the customer profile.
Nested Schema : profileComments
Type:
arrayThe list of all logged comments for the customer profile.
Show Source
Nested Schema : profileDetail
Type:
objectThe details of the customer profile.
Show Source
-
active(optional):
boolean
The user status of the profile. Should be true or false
-
approvalRequired(optional):
boolean
Indicates if approval is required
-
catalog(optional):
object catalog
The catalog associated with this profile.
-
comments(optional):
array comments
The notes on the customer.
-
contactBillingAddress:
object contactBillingAddress
The default billing address for B2B contact.
-
contactShippingAddress(optional):
object contactShippingAddress
The default shipping address for B2B contact
-
currentOrganization(optional):
object currentOrganization
The current Organization
-
customerContactId(optional):
string
The external customer contact id.
-
dateOfBirth(optional):
string
Date of birth
-
daytimeTelephoneNumber(optional):
string
The day time telephone number of the customer profile.
-
derivedTaxExemptionCode(optional):
string
Derived Tax Exemption Code
-
dynamicProperties(optional):
array dynamicProperties
Read-only list of dynamic properties associated with profile along with meta-data.
-
email(optional):
string
Email of the customer profile.
-
firstName(optional):
string
The first name of the customer profile.
-
GDPRProfileP13nConsentDate(optional):
string
The date on which GDPR personalization consent was granted by the user.
-
GDPRProfileP13nConsentGranted(optional):
boolean
Indicates whether the user has given GDPR Profile P13n consent on the current site. Can be true or false.
-
id(optional):
string
The customer profile id.
-
lastName(optional):
string
Last name of the customer profile.
-
locale(optional):
string
Current Locale
-
login(optional):
string
Login id of the profile.
-
loyaltyPrograms(optional):
array loyaltyPrograms
Loyalty Programs Information
-
orderPriceLimit(optional):
number
Order Price Limit of the profile
-
parentOrganization(optional):
object parentOrganization
The parent Organization associated with the B2B customer profile.
-
priceListGroup(optional):
object priceListGroup
The associated price list group for this profile
-
profileType(optional):
string
The type of the user. Possible values are b2b_user and b2c_user.
-
receiveEmail(optional):
string
Indicates whether the customer has opted for receiving marketing emails on the current site. Can be yes or no.
-
receiveEmailDate(optional):
string
The date on which the customer opted for receiving marketing emails.
-
repositoryId(optional):
string
The repository id of the customer profile record.
-
roles(optional):
array roles
List of user roles.
-
secondaryAddresses:
object secondaryAddresses
Secondary addresses for B2B contact.
-
secondaryOrganizations(optional):
array secondaryOrganizations
List of secondary organizations that need to associate with the user.
-
shippingAddress(optional):
object shippingAddress
Default shipping address of the profile (Deprecated, please use ???shippingAddresses??? instead).
-
shippingAddresses(optional):
array shippingAddresses
The shipping addresses associated with the customer profile.
-
taxExempt(optional):
boolean
Indicates tax exemption status.True or False
-
taxExemptionCode(optional):
string
Tax Exemption Code
Nested Schema : items
Type:
Show Source
object-
comment(optional):
string
The comment string.
-
creationDate(optional):
string
The of creation date of the comment.
-
repositoryId(optional):
string
The repository id of the comment record.
Nested Schema : catalog
Type:
objectThe catalog associated with this profile.
Show Source
-
repositoryId(optional):
string
RepositoryId of the catalog associated with this profile.
Nested Schema : comments
Type:
arrayThe notes on the customer.
Show Source
-
Array of:
object items
The info of the customer
Nested Schema : contactBillingAddress
Type:
objectThe default billing address for B2B contact.
Show Source
-
address1(optional):
string
Address line 1 for this billing address.
-
address2(optional):
string
Address line 2 for this billing address.
-
address3(optional):
string
Address line 3 for this billing address.
-
city(optional):
string
City for this billing address.
-
companyName(optional):
string
Company name for this billing address.
-
country(optional):
string
Country for this billing address.
-
county(optional):
string
County for this billing address.
-
dynamicProperty(optional):
object dynamicProperty
The value of the dynamic Property
-
email(optional):
string
Email for this billing address.
-
externalAddressId(optional):
string
External address id
-
faxNumber(optional):
string
Fax number for this billing address.
-
firstName(optional):
string
First name for this billing address.
-
jobTitle(optional):
string
Job title for this billing address.
-
lastName(optional):
string
Last name for this billing address.
-
middleName(optional):
string
Middle name for this billing address.
-
phoneNumber(optional):
string
Phone number for this billing address.
-
postalCode(optional):
string
Postal code for this billing address.
-
prefix(optional):
string
Prefix for this billing address.
-
repositoryId(optional):
string
The repository id of the billing address
-
state(optional):
string
State for this billing address.
-
suffix(optional):
string
Suffix for this billing address.
Nested Schema : contactShippingAddress
Type:
objectThe default shipping address for B2B contact
Show Source
-
address1(optional):
string
The address line 1 in the shipping address.
-
address2(optional):
string
The address line 2 in the shipping address.
-
address3(optional):
string
The address line 3 in the shipping address.
-
city(optional):
string
The city in the shipping address record.
-
companyName(optional):
string
Company name for this address.
-
country(optional):
string
The country in the shipping address record.
-
county(optional):
string
The county in the shipping address.
-
dynamicProperty(optional):
object dynamicProperty
The value of the dynamic Property
-
externalAddressId(optional):
string
External address id
-
faxNumber(optional):
string
Fax number for this address.
-
firstName(optional):
string
The first name in the shipping address.
-
jobTitle(optional):
string
Job title for this address.
-
lastName(optional):
string
The last name in the shipping address.
-
middleName(optional):
string
Middle name for this address.
-
phoneNumber(optional):
string
The phone number in the shipping address.
-
postalCode(optional):
string
The postal code in the shipping address.
-
prefix(optional):
string
Prefix for this address.
-
repositoryId(optional):
string
The repository id of the shipping address record.
-
state(optional):
string
The state in the shipping address.
-
suffix(optional):
string
Suffix for this address.
Nested Schema : currentOrganization
Type:
objectThe current Organization
Show Source
-
id(optional):
string
The current Organization Id
Nested Schema : dynamicProperties
Type:
arrayRead-only list of dynamic properties associated with profile along with meta-data.
Show Source
Nested Schema : parentOrganization
Type:
objectThe parent Organization associated with the B2B customer profile.
Show Source
-
id(optional):
string
The id of the organization.
-
name(optional):
string
The name of of the organization.
-
punchoutUserId(optional):
string
Punchout user Id of organization, read only property.
-
repositoryId(optional):
string
The repository id of the comment record.
Nested Schema : priceListGroup
Type:
objectThe associated price list group for this profile
Show Source
-
repositoryId(optional):
string
Repository ID of the price list group
Nested Schema : secondaryAddresses
Type:
objectSecondary addresses for B2B contact.
Show Source
-
address1(optional):
string
Address line 1 for this address.
-
address2(optional):
string
Address line 2 for this address.
-
address3(optional):
string
Address line 3 for this address.
-
city(optional):
string
City for this address.
-
companyName(optional):
string
Company name for this address.
-
country(optional):
string
Country for this address.
-
county(optional):
string
County for this address.
-
dynamicProperty(optional):
object dynamicProperty
The value of the dynamic Property
-
email(optional):
string
Email for this address.
-
externalAddressId(optional):
string
External address id
-
faxNumber(optional):
string
Fax number for this address.
-
firstName(optional):
string
First name for this address.
-
jobTitle(optional):
string
Job title for this address.
-
lastName(optional):
string
Last name for this address.
-
middleName(optional):
string
Middle name for this address.
-
phoneNumber(optional):
string
Phone number for this address.
-
postalCode(optional):
string
Postal code for this address.
-
prefix(optional):
string
Prefix for this address.
-
repositoryId(optional):
string
The repository id of this address.
-
state(optional):
string
State for this address.
-
suffix(optional):
string
Suffix for this address.
Nested Schema : secondaryOrganizations
Type:
arrayList of secondary organizations that need to associate with the user.
Show Source
Nested Schema : shippingAddress
Type:
objectDefault shipping address of the profile (Deprecated, please use ???shippingAddresses??? instead).
Show Source
-
address1(optional):
string
The address line 1 in the shipping address.
-
address2(optional):
string
The address line 2 in the shipping address.
-
address3(optional):
string
The address line 3 in the shipping address.
-
alias(optional):
string
The alias of the shipping address.
-
city(optional):
string
The city in the shipping address record.
-
companyName(optional):
string
Company name for this address.
-
country(optional):
string
The country in the shipping address record.
-
county(optional):
string
The county in the shipping address.
-
dynamicProperty(optional):
object dynamicProperty
The value of the dynamic Property
-
externalAddressId(optional):
string
External address id
-
faxNumber(optional):
string
Fax number for this address.
-
firstName(optional):
string
The first name in the shipping address.
-
jobTitle(optional):
string
Job title for this address.
-
lastName(optional):
string
The last name in the shipping address.
-
middleName(optional):
string
Middle name for this address.
-
phoneNumber(optional):
string
The phone number in the shipping address.
-
postalCode(optional):
string
The postal code in the shipping address.
-
prefix(optional):
string
Prefix for this address.
-
repositoryId(optional):
string
The repository id of the shipping address record.
-
state(optional):
string
The state in the shipping address.
-
suffix(optional):
string
Suffix for this address.
Nested Schema : shippingAddresses
Type:
arrayThe shipping addresses associated with the customer profile.
Show Source
Nested Schema : items
Type:
objectThe info of the customer
Show Source
-
agent(optional):
string
The user id of the Agent.
-
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 : dynamicProperty
Type:
objectThe value of the dynamic Property
Nested Schema : dynamicProperty
Type:
objectThe value of the dynamic Property
Nested Schema : items
Type:
Show Source
object-
id(optional):
string
The ID of the dynamic property.
-
type(optional):
string
The type of the dynamic property. Supported types are boolean, date, float, string, timestamp, enumerated, big string.
-
value(optional):
string
The value of the dynamic property.
Nested Schema : items
Type:
Show Source
object-
membershipId(optional):
string
membershipId of the profile.
-
programId(optional):
string
programId of Loyalty Program
-
programName(optional):
string
programName of Loyalty Program
-
repositoryId(optional):
string
repository Id
-
status(optional):
string
status of Enrollment
Nested Schema : items
Type:
Show Source
object-
function(optional):
string
Function of the role which can be admin or buyer.
-
repositoryId(optional):
string
Repository id of the role.
Nested Schema : dynamicProperty
Type:
objectThe value of the dynamic Property
Nested Schema : items
Type:
Show Source
object-
id(optional):
string
ID of the organization to be assigned.
Nested Schema : dynamicProperty
Type:
objectThe value of the dynamic Property
Nested Schema : items
Type:
Show Source
object-
address1(optional):
string
The address line 1 in the shipping address.
-
address2(optional):
string
The address line 2 in the shipping address.
-
address3(optional):
string
The address line 3 in the shipping address.
-
alias(optional):
string
The alias of the shipping address.
-
city(optional):
string
The city in the shipping address record.
-
companyName(optional):
string
The company name of the person in the shipping address.
-
country(optional):
string
The country in the shipping address record.
-
county(optional):
string
The county in the shipping address.
-
dynamicProperty(optional):
object dynamicProperty
The value of the dynamic Property
-
externalAddressId(optional):
string
External address id
-
faxNumber(optional):
string
The fax number in the shipping address.
-
firstName(optional):
string
The first name in the shipping address.
-
isDefaultAddress(optional):
boolean
Indicates if its the default shipping address.
-
jobTitle(optional):
string
The job title of the person in the shipping address.
-
lastName(optional):
string
The last name in the shipping address.
-
middleName(optional):
string
The middle name in the shipping address.
-
phoneNumber(optional):
string
The phone number in the shipping address.
-
postalCode(optional):
string
The postal code in the shipping address.
-
prefix(optional):
string
Prefix for this address.
-
repositoryId(optional):
string
The repository id of the shipping address record.
-
selectedCountry(optional):
string
The selected country in the shipping address.
-
selectedState(optional):
string
The selected state in the shipping address.
-
state(optional):
string
The state in the shipping address.
-
state_ISOCode(optional):
string
The state ISO code in the shipping address.
-
suffix(optional):
string
The suffix of the person in the shipping address
Nested Schema : dynamicProperty
Type:
objectThe value of the dynamic Property
Example Response (application/json)
{
"profileDetail":{
"lastName":"Butt",
"GDPRProfileP13nConsentDate":"2018-03-21T13:10:08.463Z",
"customerContactId":"CRMID_12345",
"GDPRProfileP13nConsentGranted":true,
"catalog":{
"repositoryId":"cloudLakeCatalog"
},
"dynamicProperties":[
{
"id":"dynamicPropertyMaritalStatus",
"label":"Marital Status",
"type":"string",
"value":"Single"
}
],
"contactBillingAddress":{
"lastName":"Anderson",
"firstName":"Kim",
"country":"US",
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":"212-555-2150",
"address2":null,
"city":"Buffalo",
"address1":"451 Brooks Ave",
"postalCode":"14201",
"county":null,
"repositoryId":"se-990031",
"state":"NY"
},
"receiveEmail":"yes",
"dateOfBirth":"2001-11-14T00:00:00.000Z",
"secondaryAddresses":{
"Work":{
"lastName":"Anderson",
"firstName":"Kim",
"country":"US",
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":"212-555-2150",
"address2":null,
"city":"Buffalo",
"address1":"451 Brooks Ave",
"postalCode":"14201",
"county":null,
"repositoryId":"se-970031",
"state":"NY"
},
"Mom' s house":{
"lastName":"Anderson",
"firstName":"Dolores",
"country":"US",
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":"212-555-4321",
"address2":null,
"city":"Dewitt",
"address1":"41 Wexford Rd ",
"postalCode":"13214",
"county":null,
"repositoryId":"se-140010",
"state":"NY"
},
"Home":{
"lastName":"dd",
"firstName":"sdf",
"country":"US",
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":"1231231231",
"address2":"f",
"city":"f",
"address1":"dd",
"postalCode":"36123",
"county":null,
"repositoryId":"se-980031",
"state":"AL"
}
},
"locale":"en_US",
"contactShippingAddress":{
"lastName":"dd",
"firstName":"sdf",
"country":"US",
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":"1231231231",
"address2":"f",
"city":"f",
"address1":"dd",
"postalCode":"36123",
"county":null,
"repositoryId":"se-980031",
"state":"AL"
},
"parentOrganization":{
"name":"Oracle India Pvt Ltd",
"repositoryId":"oracle",
"punchoutUserId":"100012",
"id":"oracle"
},
"receiveEmailDate":"2018-03-21T13:10:08.463Z",
"firstName":"James",
"profileType":"b2b_user",
"loyaltyPrograms":[
{
"programName":"XTRAREWARDS",
"membershipId":"abc123",
"programId":"prog1",
"status":"Enrolled"
},
{
"programName":"XTRAREWARDS",
"membershipId":"xyz123",
"programId":"prog2",
"status":"RequestForEnrollment"
}
],
"repositoryId":"120099",
"shippingAddress":{
"lastName":"Butt",
"firstName":"James",
"country":"United States",
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":"504-845-1427",
"address2":"",
"city":"New Orleans",
"address1":"6649 N Blue Gum St",
"postalCode":"70116",
"county":"Orleans",
"repositoryId":"140010",
"state":"Los Angeles"
},
"id":"120099",
"email":"jbutt@example.com",
"daytimeTelephoneNumber":"",
"shippingAddresses":[
{
"lastName":"Anderson",
"country":"United States",
"address3":"",
"address2":"",
"city":"Syracuse",
"prefix":"",
"address1":"21 Cedar Ave",
"postalCode":"13202",
"jobTitle":"",
"companyName":"",
"county":"",
"isDefaultAddress":false,
"suffix":"",
"selectedCountry":"US",
"firstName":"Kim",
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":"212-555-1977",
"faxNumber":"",
"middleName":"",
"state":"New York",
"selectedState":"NY",
"state_ISOCode":"US-NY"
},
{
"lastName":"Butt",
"country":"United States",
"address3":"",
"address2":"",
"city":"New Orleans",
"prefix":"",
"address1":"6649 N Blue Gum St",
"postalCode":"70116",
"jobTitle":"",
"companyName":"",
"county":"Orleans",
"isDefaultAddress":true,
"suffix":"",
"selectedCountry":"US",
"firstName":"James",
"externalAddressId":"EXT_ADDR_1",
"phoneNumber":"504-845-1427",
"faxNumber":"",
"middleName":"",
"state":"Los Angeles",
"selectedState":"LA",
"state_ISOCode":"US-LA"
}
]
},
"profileComments":[
{
"repositoryId":"100002",
"comment":"Item not received.",
"creationDate":"2014-06-25 01:50:28.0"
},
{
"repositoryId":"100001",
"comment":"Issue with shipping address.",
"creationDate":"2014-06-25 01:50:20.0"
}
],
"hasIncompleteOrder":false
}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|
|------------------|------------------|
|100094|Organization passed in the header is currently inactive|
|100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization|
|22000|Profile Id passed is null or empty.|
|22001|Internal error occurred while processing the request.|
|100101|The shopper profile does not belong to organization passed in the header|
|200006|Profile comment retrieval failed.|
|22002|No profile found with profile id|
|100102|Organization passed in the header is invalid or does not exist|
|200016|Internal error occurred while processing the profile orders request.|
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