getCurrentProfile
get
/ccstore/v1/profiles/current
Get Current Profile. Get the current profile. Optionally takes the x-ccasset-language header to get translated content in another language.
Request
Supported Media Types
- application/json
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 : getCurrentProfile_response
Type:
Show Source
object
-
catalog(optional):
object catalog
The catalog associated with this profile.
-
contactBillingAddress(optional):
object contactBillingAddress
Default billing address of the b2b profile.
-
contactShippingAddress(optional):
object contactShippingAddress
Default shipping address of the b2b profile.
-
currentOrganization(optional):
object currentOrganization
current organization of the logged in b2b user.
-
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.
-
derivedApprovalRequired(optional):
boolean
Approval required
-
derivedOrderPriceLimit(optional):
number
Derived Order limit
-
dynamicProperties(optional):
array dynamicProperties
Read-only list of dynamic properties associated with profile along with meta-data.
-
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.
-
lastName(optional):
string
The last name of the profile.
-
lastPurchaseDate(optional):
string
The last time the user made a purchase.
-
lastVisitDate(optional):
string
The last time the shopper visited.
-
lifetimeAOV(optional):
number
Lifetime average order value of the profile
-
lifetimeCurrencyCode(optional):
string
Life time currency Code of the profile
-
locale(optional):
string
Current Locale of the profile
-
login(optional):
string
Login id of the profile.
-
numberOfOrders(optional):
integer
Total number of orders for the customer profile.
-
numberOfVisits(optional):
integer
Number of Visits on the profile
-
parentOrganization(optional):
object parentOrganization
The parent organisation information.
-
previousVisitDate(optional):
string
Previous Visit Date on the profile
-
priceListGroup(optional):
object priceListGroup
The associated price list group for this user
-
receiveEmail(optional):
string
This is email marketing flag. Can be yes or no.
-
receiveEmailDate(optional):
string
The date on which email marketing consent was granted by the user.
-
registrationDate(optional):
string(date-time)
Registration date of the profile
-
repositoryId(optional):
string
The repository ID of the profile.
-
roles(optional):
array roles
List of user roles.
-
secondaryAddresses(optional):
array secondaryAddresses
List of addresses associated with an Organization that profile belongs to.
-
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
List of shipping addresses associated with profile.
-
taxExempt(optional):
boolean
If tax is exempted
Nested Schema : catalog
Type:
object
The catalog associated with this profile.
Show Source
-
repositoryId(optional):
string
RepositoryId of the catalog associated with this profile.
Nested Schema : contactBillingAddress
Type:
object
Default billing address of the b2b profile.
Show Source
-
address1(optional):
string
the address1 of the address
-
address2(optional):
string
the address2 of the address
-
address3(optional):
string
the address3 of the address
-
city(optional):
string
the city of the address
-
companyName(optional):
string
the company name of the address
-
country(optional):
string
the country of the address
-
county(optional):
string
The county in the shipping address.
-
faxNumber(optional):
string
The fax number in the shipping address
-
firstName(optional):
string
The first name in the 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 of the address
-
postalCode(optional):
string
the postal Code of the address
-
prefix(optional):
string
the prefix of the address
-
repositoryId(optional):
string
Repository Id of the address
-
state(optional):
string
the state of the address
-
suffix(optional):
string
The suffix of the person in the shipping address.
-
types(optional):
array types
The types tagged to the address
Nested Schema : contactShippingAddress
Type:
object
Default shipping address of the b2b profile.
Show Source
-
address1(optional):
string
the address1 of the address
-
address2(optional):
string
the address2 of the address
-
address3(optional):
string
the address3 of the address
-
city(optional):
string
the city of the address
-
companyName(optional):
string
the company name of the address
-
country(optional):
string
the country of the address
-
county(optional):
string
The county in the shipping address.
-
faxNumber(optional):
string
The fax number in the shipping address
-
firstName(optional):
string
The first name in the 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 of the address
-
postalCode(optional):
string
the postal Code of the address
-
prefix(optional):
string
the prefix of the address
-
repositoryId(optional):
string
Repository Id of the address
-
state(optional):
string
the state of the address
-
suffix(optional):
string
The suffix of the person in the shipping address.
-
types(optional):
array types
The types tagged to the address
Nested Schema : currentOrganization
Type:
object
current organization of the logged in b2b user.
Show Source
-
delegateApprovalManagement(optional):
boolean
The delegateApprovalManagement of user's current organization.
-
derivedDescription(optional):
string
The derivedDescription attribute of user's current organization.
-
derivedDunsNumber(optional):
string
The derivedDunsNumber attribute of user's current organization.
-
derivedOrganizationLogo(optional):
string
The derivedOrganizationLogo attribute of user's current organization.
-
derivedTaxReferenceNumber(optional):
string
The derivedTaxReferenceNumber attribute of user's current organization.
-
derivedType(optional):
string
The derivedType attribute of user's current organization.
-
derivedUniqueId(optional):
string
The derivedUniqueId attribute of user's current organization.
-
derivedVatReferenceNumber(optional):
string
The derivedVatReferenceNumber attribute of user's current organization.
-
description(optional):
string
The description of user's current organization.
-
name(optional):
string
The name of user's current organization.
-
organizationLogo(optional):
string
The relative path of user's current organization's logo.
-
organizationLogoURL(optional):
string
The path of user's current organization's logo.
-
repositoryId(optional):
string
The repositoryId of user's current organization.
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 organisation information.
Show Source
-
description(optional):
string
The description of the organisation.
-
name(optional):
string
The name of the organisation.
-
organizationLogoURL(optional):
string
The organisation logo URL.
-
repositoryId(optional):
string
The organisation repository Id.
Nested Schema : priceListGroup
Type:
object
The associated price list group for this user
Show Source
-
repositoryId(optional):
string
The Repository ID of the price list group
Nested Schema : secondaryAddresses
Type:
array
List of addresses associated with an Organization that profile belongs to.
Show Source
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(optional):
string
The address line 1 of the shipping address.
-
address2(optional):
string
The address line 2 of the shipping address.
-
address3(optional):
string
The address line 3 of the shipping address.
-
alias(optional):
string
The alias 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 code of the shipping address.
-
county(optional):
string
The county of the shipping address.
-
faxNumber(optional):
string
The fax number in the shipping address
-
firstName(optional):
string
The first name of the shipping address.
-
lastName(optional):
string
The last name of the shipping address.
-
middleName(optional):
string
The middle name in 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 code of the shipping address.
-
suffix(optional):
string
The suffix of the person in 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
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
-
default(optional):
string
The default value of the dynamic property.
-
id(optional):
string
The ID of the dynamic property.
-
label(optional):
string
The label of the dynamic property.
-
length(optional):
number
The length attribute of the dynamic property.
-
required(optional):
boolean
The required attribute of the dynamic property.
-
type(optional):
string
The type of the dynamic property. Supported types are boolean, date, float, string, timestamp, enumerated, big string.
-
uiEditorType(optional):
string
The uiEditorType attribute of the dynamic property.
-
value(optional):
string
The value of the dynamic property.
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 : items
Type:
Show Source
object
-
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
Company name of the secondary address
-
country(optional):
string
The country of the address
-
county(optional):
string
The county in the shipping address.
-
faxNumber(optional):
string
The fax number in the shipping address
-
firstName(optional):
string
The first name in the 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
Phone Number of the address
-
postalCode(optional):
string
Postal Code of the address
-
prefix(optional):
string
The prefix of the address
-
repositoryId(optional):
string
Repository Id of the address
-
state(optional):
string
The State of the address
-
suffix(optional):
string
The suffix of the person in 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
-
id(optional):
string
ID of the organization to be assigned.
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 address line 1 of the shipping address.
-
address2(optional):
string
The address line 2 of the shipping address.
-
address3(optional):
string
The address line 3 of the shipping address.
-
alias(optional):
string
The alias 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 code of the shipping address.
-
countryName(optional):
string
The display name for the country of the shipping address
-
county(optional):
string
The county of the shipping address.
-
faxNumber(optional):
string
The fax number in the shipping address
-
firstName(optional):
string
The first name of the shipping address.
-
lastName(optional):
string
The last name of the shipping address.
-
middleName(optional):
string
The middle name in 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 address
-
regionName(optional):
string
The display name for the state of the shipping address
-
repositoryId(optional):
string
The ID of the shipping address.
-
state(optional):
string
The state code of the shipping address.
-
suffix(optional):
string
The suffix of the person in 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
Example Response (application/json)
{
"lastPurchaseDate":null,
"lastName":"Anderson",
"GDPRProfileP13nConsentDate":null,
"GDPRProfileP13nConsentGranted":false,
"gender":"female",
"secondaryAddresses":{
"Office Address":{
"country":"US",
"types":[
],
"address3":"block 3",
"address2":"Street 2",
"city":"Montgomery",
"address1":"600 Dexter Avenue",
"prefix":"",
"postalCode":"36130",
"companyName":"Oracle",
"jobTitle":null,
"suffix":null,
"phoneNumber":"973-974-1234",
"repositoryId":"180003",
"faxNumber":null,
"middleName":null,
"state":"AL"
}
},
"numberOfOrders":0,
"receiveEmailDate":null,
"firstPurchaseDate":null,
"registrationDate":null,
"id":"se-570031",
"email":"kim@example.com",
"daytimeTelephoneNumber":"212-555-1977",
"numberOfVisits":1,
"contactBillingAddress":{
"country":"US",
"types":[
],
"phoneNumber":"973-974-1234",
"address3":"block 3",
"address2":"Street 2",
"city":"Montgomery",
"address1":"600 Dexter Avenue",
"prefix":"",
"postalCode":"36130",
"companyName":"Oracle",
"repositoryId":"180003",
"state":"AL"
},
"receiveEmail":"yes",
"dateOfBirth":"null",
"lastVisitDate":null,
"previousVisitDate":null,
"contactShippingAddress":{
"country":"US",
"types":[
],
"address3":"block 3",
"address2":"Street 2",
"city":"Montgomery",
"address1":"600 Dexter Avenue",
"prefix":"",
"postalCode":"36130",
"companyName":"Oracle",
"jobTitle":null,
"suffix":null,
"phoneNumber":"973-974-1234",
"repositoryId":"180003",
"faxNumber":null,
"middleName":null,
"state":"AL"
},
"firstName":"Kim",
"repositoryId":"110033",
"firstVisitDate":null,
"currentOrganization":{
"derivedDunsNumber":"213403478",
"derivedTaxReferenceNumber":"901-73-7073",
"organizationLogo":"/general/city-background.jpg",
"description":"US Motor Works - US Division",
"delegateApprovalManagement":false,
"derivedOrganizationLogo":"/general/city-background.jpg",
"derivedUniqueId":null,
"derivedType":"division",
"organizationLogoURL":"http://localhost:8080/file/v4998724338791971926/general/city-background.jpg",
"derivedVatReferenceNumber":null,
"repositoryId":"or-100003",
"name":"US Motor Works - US Division",
"derivedDescription":"US Motor Works - US Division"
},
"shippingAddresses":[
{
"lastName":"Anderson",
"country":"US",
"types":[
],
"address3":"",
"address2":"",
"city":"Montgomery",
"address1":"21 Cedar Ave",
"prefix":"",
"postalCode":"13202",
"regionName":"Georgia",
"companyName":"",
"jobTitle":null,
"county":null,
"suffix":null,
"firstName":"Kim",
"phoneNumber":"212-555-1977",
"repositoryId":"se-980031",
"alias":"Home",
"faxNumber":null,
"middleName":null,
"state":"NY",
"countryName":"United States"
}
]
}
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:
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