REST API for Oracle Commerce Cloud December 2017

idleCart

post

/ccadmin/v1/webhook/idleCart

The details of idle cart in the Oracle Commerce Cloud

Request

Supported Media Types

application/json

Body Parameter

The details of the idle cart

Root Schema : idleCart_request

The details of the idle cart

Properties

idleCart: Type: object idleCart

Additional Properties Allowed:

Nested Schema : idleCart

Properties

cartUrl: Type: string

The cart url
creationDate: Type: string

The creation date in ISO format
creationTime: Type: integer

The creation time in long seconds
discountInfo: Type: object discountInfo

Additional Properties Allowed:

The discount information.
exchangeRate: Type: number

exchangeRate
lastModifiedDate: Type: string

The last modified date
lastModifiedTime: Type: integer

The last modified time in long seconds
orderId: Type: string

The order id
orderProfileId: Type: string

The profile-id of the order
orderStatus: Type: string

Status of the order
payments: Type: array payments

Additional Properties Allowed:

The payment information.
priceInfo: Type: object priceInfo

Additional Properties Allowed:

The price information.
profile: Type: object profile

Additional Properties Allowed:

The details of customer profile created on Oracle Commerce Cloud. This includes the email, first name and last name of the customer.
secondaryCurrencyCode: Type: string

Secondary currencyCode
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

The shipping address details.
shippingGroups: Type: array shippingGroups

Additional Properties Allowed:
shippingMethod: Type: object shippingMethod

Additional Properties Allowed:

The shipping method details for the order.
shoppingCart: Type: object shoppingCart

Additional Properties Allowed:

The shopping-cart or order contents of the current order.
site: Type: object site

Additional Properties Allowed:
siteId: Type: string

The id of the site associated with this cart
taxPriceInfo: Type: object taxPriceInfo

Additional Properties Allowed:

The shipping address details.

Nested Schema : discountInfo

Type: object

The discount information.

Properties

orderCouponsMap: Type: object orderCouponsMap

Additional Properties Allowed:

The list of all the coupons with the order.
orderDiscount: Type: number

The order discount.
orderImplicitDiscountList: Type: array orderImplicitDiscountList

Additional Properties Allowed:

Order Implicit Discount List.
shippingDiscount: Type: number

The shipping discount.
unclaimedCouponsMap: Type: object unclaimedCouponsMap

Additional Properties Allowed:

The unclaimed coupons with the order.

Nested Schema : payments

Type: array

The payment information.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : priceInfo

Type: object

The price information.

Properties

amount: Type: number

The total order amount.
currencyCode: Type: string

The currency code.
shipping: Type: number

The total shipping cost.
shippingSurchargeValue: Type: number

Extra handling costs for shipping the products
subTotal: Type: number

Sub-total.
tax: Type: number

The total tax amount.
total: Type: number

The order total.
totalWithoutTax: Type: number

The total amount without tax.

Nested Schema : profile

Type: object

The details of customer profile created on Oracle Commerce Cloud. This includes the email, first name and last name of the customer.

Properties

daytimeTelephoneNumber: Type: string

The telephone number
email: Type: string

email of the user.
firstName: Type: string

First Name
id: Type: string

The profile-id of the order
lastName: Type: string

Last Name
locale: Type: string

Locale
loyaltyPrograms: Type: array loyaltyPrograms

Additional Properties Allowed:

Loyalty Programs Information
receiveEmail: Type: string

If User wants email notification?
sitePropertiesList: Type: array sitePropertiesList

Additional Properties Allowed:

The list of site related properties for the profile

Nested Schema : shippingAddress

Type: object

The shipping address details.

Properties

address1: Type: string

Address snippet.
address2: Type: string

Address snippet.
address3: Type: string

Address snippet.
city: Type: string

City.
companyName: Type: string

Company name.
country: Type: string

Country.
county: Type: string

County.
email: Type: string

Email address.
faxNumber: Type: string

Fax number.
firstName: Type: string

First name
jobTitle: Type: string

Job title.
lastName: Type: string

Last name.
middleName: Type: string

Middle name.
phoneNumber: Type: string

Phone number.
postalCode: Type: string

Postal code.
prefix: Type: string

Name prefix.
state: Type: string

State.
suffix: Type: string

Name suffix.

Nested Schema : shippingGroups

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingMethod

Type: object

The shipping method details for the order.

Properties

cost: Type: number

The total cost of shipping.
value: Type: string

The shipping method applied to the order.

Nested Schema : shoppingCart

Type: object

The shopping-cart or order contents of the current order.

Properties

items: Type: array items

Additional Properties Allowed:

The array of products in the shopping cart.
numberOfItems: Type: integer

Total no of items.

Nested Schema : site

Type: object

Properties

siteName: Type: string

The name of the site where order is placed
siteURL: Type: string

The production URL of the site where the order is placed

Nested Schema : taxPriceInfo

Type: object

The shipping address details.

Properties

amount: Type: number

The total order amount.
cityTax: Type: number

City Tax
countryTax: Type: number

Country Tax.
countyTax: Type: number

County Tax.
districtTax: Type: number

District Tax.
isTaxIncluded: Type: boolean

If Tax is included?
miscTax: Type: number

Misc Tax.
secondaryCurrencyTaxAmount: Type: number

taxAmount in secondaryCurrency
stateTax: Type: number

State Tax.
valueAddedTax: Type: number

Value Added Tax.

Nested Schema : orderCouponsMap

Type: object

The list of all the coupons with the order.

Nested Schema : orderImplicitDiscountList

Type: array

Order Implicit Discount List.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : unclaimedCouponsMap

Type: object

The unclaimed coupons with the order.

Nested Schema : items

Type: object

Properties

Nested Schema : items

Type: object

Properties

Nested Schema : loyaltyPrograms

Type: array

Loyalty Programs Information

Items

Type: object items

Additional Properties Allowed:

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

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 : 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

Nested Schema : items

Type: object

Properties

discountInfo: Type: array discountInfo

Additional Properties Allowed:

The discount information.
items: Type: array items

Additional Properties Allowed:
priceInfo: Type: object priceInfo

Additional Properties Allowed:

The price information.
recurringChargePriceInfo: Type: string
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

The shipping address details.
shippingMethod: Type: object shippingMethod

Additional Properties Allowed:

The shipping method details for the order.
taxPriceInfo: Type: object taxPriceInfo

Additional Properties Allowed:

The shipping address details.

Nested Schema : discountInfo

Type: array

The discount information.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : priceInfo

Type: object

The price information.

Properties

amount: Type: number

The total order amount.
currencyCode: Type: string

The currency code.
shipping: Type: number

The total shipping cost.
shippingSurchargeValue: Type: number

Extra handling costs for shipping the products
subTotal: Type: number

Sub-total.
tax: Type: number

The total tax amount.
total: Type: number

The order total.
totalWithoutTax: Type: number

The total amount without tax.

Nested Schema : shippingAddress

Type: object

The shipping address details.

Properties

address1: Type: string

Address snippet.
address2: Type: string

Address snippet.
address3: Type: string

Address snippet.
city: Type: string

City.
companyName: Type: string

Company name.
country: Type: string

Country.
county: Type: string

County.
email: Type: string

Email address.
faxNumber: Type: string

Fax number.
firstName: Type: string

First name
jobTitle: Type: string

Job title.
lastName: Type: string

Last name.
middleName: Type: string

Middle name.
phoneNumber: Type: string

Phone number.
postalCode: Type: string

Postal code.
prefix: Type: string

Name prefix.
state: Type: string

State.
suffix: Type: string

Name suffix.

Nested Schema : shippingMethod

Type: object

The shipping method details for the order.

Properties

cost: Type: number

The total cost of shipping.
secondaryCurrencyTaxAmount: Type: number

taxAmount in secondaryCurrency
shippingMethodDescription: Type: string
shippingTax: Type: number
taxCode: Type: string
value: Type: string

The shipping method applied to the order.

Nested Schema : taxPriceInfo

Type: object

The shipping address details.

Properties

amount: Type: number

The total order amount.
cityTax: Type: number

City Tax
countryTax: Type: number

Country Tax.
countyTax: Type: number

County Tax.
districtTax: Type: number

District Tax.
isTaxIncluded: Type: boolean

If Tax is included?
miscTax: Type: number

Misc Tax.
stateTax: Type: number

State Tax.
valueAddedTax: Type: number

Value Added Tax.

Nested Schema : items

Type: object

Properties

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the item by the third party system.
amount: Type: number

The monetary amount.
availabilityDate: Type: string (date-time)

The availability date for preOrdered/backOrdered quantity.
backOrderQuantity: Type: integer

The back ordered quantity included.
catRefId: Type: string

The reference ID of the catalog this commerce item references. Typically the SKU id.
commercerId: Type: string

Commerce ID for this commerce item.
commercerItemId: Type: string

Commerce Item ID for this commerce item.
detailedItemPriceInfo: Type: array detailedItemPriceInfo

Additional Properties Allowed:
discountAmount: Type: number

The monetary amount of the discount: rawSubtotal - amount + manualAdjustmentTotal. (read-only)
discountInfo: Type: array discountInfo

Additional Properties Allowed:

Whether this item is discounted.
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a third party system.
listPrice: Type: number

The monetary amount of the list price.
onSale: Type: boolean

Whether is on sale.
preOrderQuantity: Type: integer

The pre ordered quantity included.
price: Type: number
productId: Type: string

The ID of the product.
quantity: Type: integer

The number of items covered by this price info
rawTotalPrice: Type: number

The raw total price.
salePrice: Type: number

The sale price
shippingSurchargeValue: Type: number

Extra handling cost for shipping the product.
stateDetailsAsUser: Type: string
status: Type: string
unitPrice: Type: number

Nested Schema : detailedItemPriceInfo

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : discountInfo

Type: array

Whether this item is discounted.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalData

Type: array

External data to be associated with a commerce item, provided by a third party system.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

amount: Type: number

amount.
currencyCode: Type: string

The three character currency code for the monetary amounts.
detailedUnitPrice: Type: number

detailed unit price
discounted: Type: boolean

Whether the price was discounted.
orderDiscountShare: Type: number

The Order Discount Share
quantity: Type: integer

The quantity included.
secondaryCurrencyTaxAmount: Type: number

taxAmount in secondaryCurrency
tax: Type: number

tax amount.

Nested Schema : items

Type: object

Properties

Nested Schema : items

Properties

actionCode: Type: string

The action code that has been set on the externalData item by the third party system.
name: Type: string

The name to be associated with the externalData item.
values: Type: object values

Additional Properties Allowed:

The map values associated with an externalData item.

Nested Schema : values

Type: object

The map values associated with an externalData item.

Properties

key: Type: string

Map key defined by external system.
value: Type: string

Map value defined by external system.

Nested Schema : items

Type: array

The array of products in the shopping cart.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

catRefId: Type: string

The category to which the product belongs.
commerceItems: Type: array commerceItems

Additional Properties Allowed:

Represents the child commerce items.
configuratorId: Type: string

Configuration ID for this commerce item.
description: Type: string

Description about the product.
detailedItemPriceInfo: Type: array detailedItemPriceInfo

Additional Properties Allowed:

The unit price of the product.
discountInfo: Type: array discountInfo

Additional Properties Allowed:

The discount information.
displayName: Type: string

The name of the product.
dynamicProperties: Type: array dynamicProperties

Additional Properties Allowed:

List of dynamic properties at line item level.
externalPriceDetails: Type: object externalPriceDetails

Additional Properties Allowed:

Details about external pricing
isItemValid: Type: boolean

if item is valid
onSale: Type: boolean

if item is on sale
price: Type: number

The actual price of the product.
primaryThumbImageURL: Type: string

Image url of the product
productId: Type: string

ID of the product in the cart.
quantity: Type: integer

The quantity of the product.
rawTotalPrice: Type: number

The raw price of the product.
shippingSurchargeValue: Type: number

tax applied on shipping
unitPrice: Type: number

The unit price of the product.
variant: Type: array variant

Additional Properties Allowed:

List of variants for the product.

Nested Schema : commerceItems

Type: array

Represents the child commerce items.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : detailedItemPriceInfo

Type: array

The unit price of the product.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : discountInfo

Type: array

The discount information.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : dynamicProperties

Type: array

List of dynamic properties at line item level.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : externalPriceDetails

Type: object

Details about external pricing

Properties

externalPrice: Type: number

External price of this commerce item
externalPriceQuantity: Type: integer

external quantity of this commerce item

Nested Schema : variant

Type: array

List of variants for the product.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Properties

catalogRefId: Type: string

The reference ID of the catalog this child commerce item references. Typically the SKU id.
productId: Type: string

The product ID of the child item.
quantity: Type: integer

The quantity of this child item included.