REST API for Oracle Commerce Cloud December 2017

profile

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

Body Parameter

This Event is triggered when a profile is created/updated

Root Schema : profile_request

This Event is triggered when a profile is created/updated

Properties

profile: Type: object profile

Additional Properties Allowed:
profileId: Type: string

The id of profile
type: Type: string

The type of profile

Nested Schema : profile

Type: object

Properties

abandonedOrderCount: Type: number

Number of abandoned orders
active: Type: boolean

Is the profile active
billingAddress: Type: object billingAddress

Additional Properties Allowed:

Default billing address of the profile
comments: Type: array comments

Additional Properties Allowed:

the notes on the customer.
currentOrganization: Type: object currentOrganization

Additional Properties Allowed:

The current Organization
dateOfBirth: Type: string (date-time)

Date of Birth
daytimeTelephoneNumber: Type: string

The day time phone number of the profile
derivedPriceListGroup: Type: object derivedPriceListGroup

Additional Properties Allowed:
derivedSalePriceList: Type: object derivedSalePriceList

Additional Properties Allowed:
derivedShippingSurchargePriceList: Type: object derivedShippingSurchargePriceList

Additional Properties Allowed:
email: Type: string

The email address of the profile
firstName: Type: string

The first name of the profile
homeAddress: Type: object homeAddress

Additional Properties Allowed:

Home address
id: Type: string

Id
lastActivity: Type: string (date-time)

Last activity
lastName: Type: string

The last name of the profile
locale: Type: string

Locale
login: Type: string

Login
loyaltyPrograms: Type: array loyaltyPrograms

Additional Properties Allowed:

Loyalty Programs Information
middleName: Type: string

The middle name of the profile
priceListGroup: Type: object priceListGroup

Additional Properties Allowed:
profileType: Type: string

The type of profile
receiveEmail: Type: string

The string representation of whether the user wants to recieve email or not
registrationDate: Type: string (date-time)

Registration date
relativeTo: Type: array relativeTo

Additional Properties Allowed:

If not provided organization id will be cosidered as its parent organization ID.
roles: Type: array roles

Additional Properties Allowed:

List of user roles.
secondaryOrganizations: Type: array secondaryOrganizations

Additional Properties Allowed:

List of secondary organizations that need to associate with the user.
sessionOrganization: Type: object sessionOrganization

Additional Properties Allowed:

The session Organization
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

Shipping address
shippingAddresses: Type: array shippingAddresses

Additional Properties Allowed:

List of shipping addresses associated with profile.
shippingSurchargePriceList: Type: object shippingSurchargePriceList

Additional Properties Allowed:
siteId: Type: string

Site Id associated with this profile
sitePropertiesList: Type: array sitePropertiesList

Additional Properties Allowed:

The list of site related properties for the profile
taxExempt: Type: boolean

if tax is exempted
version: Type: integer

Version

Nested Schema : billingAddress

Type: object

Default billing address of the profile

Properties

address1: Type: string

the address1 of the billing address
address2: Type: string

the address2 of the billing address
city: Type: string

the city of the billing address
country: Type: string

the country of the billing address
county: Type: string

the county of the billing address
firstName: Type: string

the first name of the billing address
lastName: Type: string

the last name of the billing address
phoneNumber: Type: string

the phone Number of the billing address
postalCode: Type: string

the postal Code of the billing address
repositoryId: Type: string

the id of the billing address
state: Type: string

the state of the billing address

Nested Schema : comments

Type: array

the notes on the customer.

Items

Type: object items

Additional Properties Allowed:

The info of the customer

Nested Schema : currentOrganization

Type: object

The current Organization

Properties

id: Type: string

The current Organization Id

Nested Schema : derivedPriceListGroup

Type: object

Properties

active: Type: boolean
currency: Type: object currency

Additional Properties Allowed:
deleted: Type: boolean
displayName: Type: string
endDate: Type: string
id: Type: string
listPriceList: Type: object listPriceList

Additional Properties Allowed:
locale: Type: string
salePriceList: Type: object salePriceList

Additional Properties Allowed:
shippingSurchargePriceList: Type: object shippingSurchargePriceList

Additional Properties Allowed:
startDate: Type: string

Nested Schema : derivedSalePriceList

Type: object

Properties

basePriceList: Type: string
creationDate: Type: string
description: Type: string
displayName: Type: string
endDate: Type: string
id: Type: string
item-id: Type: string
itemAcl: Type: string
lastModifiedDate: Type: string
locale: Type: string
startDate: Type: string
version: Type: integer

Nested Schema : derivedShippingSurchargePriceList

Type: object

Properties

basePriceList: Type: string
creationDate: Type: string
description: Type: string
displayName: Type: string
endDate: Type: string
id: Type: string
item-id: Type: string
itemAcl: Type: string
lastModifiedDate: Type: string
locale: Type: string
startDate: Type: string
version: Type: integer

Nested Schema : homeAddress

Type: object

Home address

Properties

address1: Type: string

The address1 of the home address
address2: Type: string

The address2 of the home address
address3: Type: string

The address3 of the home address
city: Type: string

The city of the home address
companyName: Type: string

Company Name
country: Type: string

The country of the home address
county: Type: string

The county of the home address
faxNumber: Type: string

Fax Number
firstName: Type: string

The first name of the home address
item-id: Type: string

Home address Id
lastName: Type: string

Last name
middleName: Type: string

Middle name
phoneNumber: Type: string

The phone Number of the home address
postalCode: Type: string

The postal Code of the home address
prefix: Type: string

Prefix
repositoryId: Type: string

repositoryId
state: Type: string

The state of the home address
suffix: Type: string

Suffix

Nested Schema : loyaltyPrograms

Type: array

Loyalty Programs Information

Items

Type: object items

Additional Properties Allowed:

Nested Schema : priceListGroup

Type: object

Properties

active: Type: boolean
currency: Type: object currency

Additional Properties Allowed:
deleted: Type: boolean
displayName: Type: string
endDate: Type: string
id: Type: string
listPriceList: Type: object listPriceList

Additional Properties Allowed:
locale: Type: string
salePriceList: Type: object salePriceList

Additional Properties Allowed:
shippingSurchargePriceList: Type: object shippingSurchargePriceList

Additional Properties Allowed:
startDate: Type: string

Nested Schema : relativeTo

Type: array

If not provided organization id will be cosidered as its parent organization ID.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : roles

Type: array

List of user roles.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : secondaryOrganizations

Type: array

List of secondary organizations that need to associate with the user.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : sessionOrganization

Type: object

The session Organization

Properties

id: Type: string

The session Organization Id

Nested Schema : shippingAddress

Type: object

Shipping address

Properties

address1: Type: string

The address1 of the shipping address
address2: Type: string

The address2 of the shipping address
address3: Type: string

The address3 of the shipping address
city: Type: string

The city of the shipping address
companyName: Type: string

Company Name
country: Type: string

The country of the shipping address
county: Type: string

The county of the shipping address
faxNumber: Type: string

Fax Number
firstName: Type: string

First name
item-id: Type: string

Shipping address Id
lastName: Type: string

Last name
middleName: Type: string

Middle name
phoneNumber: Type: string

The phone Number of the shipping address
postalCode: Type: string

The postal Code of the shipping address
prefix: Type: string

Prefix
repositoryId: Type: string

repositoryId
state: Type: string

The state of the shipping address
suffix: Type: string

Suffix

Nested Schema : shippingAddresses

Type: array

List of shipping addresses associated with profile.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingSurchargePriceList

Type: object

Properties

basePriceList: Type: string
creationDate: Type: string
description: Type: string
displayName: Type: string
endDate: Type: string
id: Type: string
item-id: Type: string
itemAcl: Type: string
lastModifiedDate: Type: string
locale: Type: string
startDate: Type: string
version: Type: integer

Nested Schema : sitePropertiesList

Type: array

The list of site related properties for the profile

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

The info of the customer

Properties

agent: Type: string

The type of update.
comment: Type: string

The description of comment.
creationDate: Type: string

The creation date of the note.
id: Type: string

The id of the comment.
item-id: Type: string

The item-id of the comment
owner: Type: string

The owner of the note.
version: Type: integer

The version of the note.

Nested Schema : currency

Type: object

Properties

currencyCode: Type: string
displayName: Type: string
fractionalDigits: Type: integer
numericCode: Type: string
symbol: Type: string

Nested Schema : listPriceList

Type: object

Properties

basePriceList: Type: string
creationDate: Type: string
description: Type: string
displayName: Type: string
endDate: Type: string
id: Type: string
item-id: Type: string
itemAcl: Type: string
lastModifiedDate: Type: string
locale: Type: string
startDate: Type: string
version: Type: integer

Nested Schema : salePriceList

Type: object

Properties

basePriceList: Type: string
creationDate: Type: string
description: Type: string
displayName: Type: string
endDate: Type: string
id: Type: string
item-id: Type: string
itemAcl: Type: string
lastModifiedDate: Type: string
locale: Type: string
startDate: Type: string
version: Type: integer

Nested Schema : shippingSurchargePriceList

Type: object

Properties

basePriceList: Type: string
creationDate: Type: string
description: Type: string
displayName: Type: string
endDate: Type: string
id: Type: string
item-id: Type: string
itemAcl: Type: string
lastModifiedDate: Type: string
locale: Type: string
startDate: Type: string
version: Type: integer

Nested Schema : items

Type: object

Properties

membershipId: Type: string

membershipId of the profile.
programId: Type: string

programId of Loyalty Program
programName: Type: string

programName of Loyalty Program
repositoryId: Type: string

repository Id
status: Type: string

status of Enrollment.

Nested Schema : currency

Type: object

Properties

currencyCode: Type: string
displayName: Type: string
fractionalDigits: Type: integer
numericCode: Type: string
symbol: Type: string

Nested Schema : listPriceList

Type: object

Properties

basePriceList: Type: string
creationDate: Type: string
description: Type: string
displayName: Type: string
endDate: Type: string
id: Type: string
item-id: Type: string
itemAcl: Type: string
lastModifiedDate: Type: string
locale: Type: string
startDate: Type: string
version: Type: integer

Nested Schema : salePriceList

Type: object

Properties

basePriceList: Type: string
creationDate: Type: string
description: Type: string
displayName: Type: string
endDate: Type: string
id: Type: string
item-id: Type: string
itemAcl: Type: string
lastModifiedDate: Type: string
locale: Type: string
startDate: Type: string
version: Type: integer

Nested Schema : shippingSurchargePriceList

Type: object

Properties

basePriceList: Type: string
creationDate: Type: string
description: Type: string
displayName: Type: string
endDate: Type: string
id: Type: string
item-id: Type: string
itemAcl: Type: string
lastModifiedDate: Type: string
locale: Type: string
startDate: Type: string
version: Type: integer

Nested Schema : items

Type: object

Properties

id: Type: string

Organization ID of the role to be assigned.

Nested Schema : items

Type: object

Properties

function: Type: string

Function of the role which can be admin or buyer.
repositoryId: Type: string

Repository id of the role.

Nested Schema : items

Type: object

Properties

id: Type: string

ID of the organization to be assigned.

Nested Schema : items

Type: object

Properties

address1: Type: string

the address1 of the shipping address
address2: Type: string

the address2 of the shipping address
address3: Type: string

the address3 of the shipping address
city: Type: string

the city of the shipping address
companyName: Type: string

the company name of the shipping address
country: Type: string

the country of the shipping address
county: Type: string

the county of the shipping address
faxNumber: Type: string

the faxNumber of the shipping address
firstName: Type: string

the first name of the shipping address
item-id: Type: string

item-id
lastName: Type: string

the last name of the shipping address
middleName: Type: string

the middle name of the shipping address
phoneNumber: Type: string

the phone Number of the shipping address
postalCode: Type: string

the postal Code of the shipping address
prefix: Type: string

the prefix of the shipping address
repositoryId: Type: string

the id of the shipping address
state: Type: string

the state of the shipping address
suffix: Type: string

the suffix of the shipping address

Nested Schema : items

Type: object

Properties

properties: Type: object properties

Additional Properties Allowed:

The site related properties for the profile
site: Type: object site

Additional Properties Allowed:

The site data

Nested Schema : properties

Type: object

The site related properties for the profile

Properties

receiveEmail: Type: string

Indicates whether the user should receive marketing emails on the current site. Can be yes or no.

Nested Schema : site

Type: object

The site data

Properties

id: Type: string

The id of the site

Response

Supported Media Types

application/json

200 Response

No response is returned as this is an event webhook

Body

Root Schema : emptyResponse

Properties