REST API for Oracle Commerce Cloud December 2017

requestQuote

post

/ccadmin/v1/webhook/requestQuote

This is triggered when the user requests a quote

Request

Supported Media Types

application/json

Body Parameter

Root Schema : requestQuote_request

Example


{
    "note":"This is a sample quote"
}

Properties

appliedPromotions: Type: array appliedPromotions

Additional Properties Allowed:

The array of applied promotions. If not supplied, it utilizes the promotions in the current incomplete order.
combineLineItems: Type: string

Value to determine if line items are to be combined. Can be yes or no.
note: Type: string

the requester note supplied with the quote request
orderId: Type: string

the order id for the order which is to be quoted. If undefined, the current incomplete order for profile is selected
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

The shipping address details. If not supplied, it utilizes the shipping address in the current incomplete order.
shippingGroups: Type: array shippingGroups

Additional Properties Allowed:

The shipping groups for the order. If not supplied, it utilizes the shipping groups in the current incomplete order.
shippingMethod: Type: object shippingMethod

Additional Properties Allowed:

The shipping method details for the order. If not supplied, it utilizes the shipping method in the current incomplete order.
shoppingCart: Type: object shoppingCart

Additional Properties Allowed:

The shopping cart contents of the current order. If not supplied, it utilizes the items in the current incomplete order.

Nested Schema : appliedPromotions

Type: array

The array of applied promotions. If not supplied, it utilizes the promotions in the current incomplete order.

Items

Type: string

Nested Schema : shippingAddress

Type: object

The shipping address details. If not supplied, it utilizes the shipping address in the current incomplete order.

Properties

address1: Type: string

Required: true

Address snippet.
address2: Type: string

Address snippet.
address3: Type: string

Address snippet.
alias: Type: string

Address alias.
city: Type: string

Required: true

City.
companyName: Type: string

Company name.
country: Type: string

Required: true

Country.
county: Type: string

County.
email: Type: string

Required: true

Email address.
faxNumber: Type: string

Fax number.
firstName: Type: string

Required: true

First name.
jobTitle: Type: string

Job title.
lastName: Type: string

Required: true

Last name.
middleName: Type: string

Middle name.
phoneNumber: Type: string

Phone number.
postalCode: Type: string

Required: true

Postal code.
prefix: Type: string

Name prefix.
selectedCountry: Type: string

Required: true

Country code.
selectedState: Type: string

Required: true

State code.
state: Type: string

Required: true

State.
state_ISOCode: Type: string

Required: true

State ISO code.
suffix: Type: string

Name suffix.

Nested Schema : shippingGroups

Type: array

The shipping groups for the order. If not supplied, it utilizes the shipping groups in the current incomplete order.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingMethod

Type: object

The shipping method details for the order. If not supplied, it utilizes the shipping method in the current incomplete order.

Properties

value: Type: string

Required: true

The shipping method applied to the order.

Nested Schema : shoppingCart

Type: object

The shopping cart contents of the current order. If not supplied, it utilizes the items in the current incomplete order.

Properties

coupons: Type: array coupons

Additional Properties Allowed:

The array of coupons applied to the order.
items: Type: array items

Required: true

Additional Properties Allowed:

The array of products in the shopping cart.
orderTotal: Type: number

The total price of the order.

Nested Schema : items

Type: object

Properties

items: Type: array items

Required: true

Additional Properties Allowed:

The array of products in the shipping group.
shippingAddress: Type: object shippingAddress

Required: true

Additional Properties Allowed:

The shipping address details.
shippingMethod: Type: object shippingMethod

Required: true

Additional Properties Allowed:

The shipping method details for the order.

Nested Schema : items

Type: array

The array of products in the shipping group.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingAddress

Type: object

The shipping address details.

Properties

address1: Type: string

Required: true

Address snippet.
address2: Type: string

Address snippet.
address3: Type: string

Address snippet.
alias: Type: string

Address alias.
city: Type: string

Required: true

City.
companyName: Type: string

Company name.
country: Type: string

Required: true

Country.
county: Type: string

County.
email: Type: string

Required: true

Email address.
faxNumber: Type: string

Fax number.
firstName: Type: string

Required: true

First name.
jobTitle: Type: string

Job title.
lastName: Type: string

Required: true

Last name.
middleName: Type: string

Middle name.
phoneNumber: Type: string

Phone number.
postalCode: Type: string

Required: true

Postal code.
prefix: Type: string

Name prefix.
selectedCountry: Type: string

Required: true

Country code.
selectedState: Type: string

Required: true

State code.
state: Type: string

Required: true

State.
state_ISOCode: Type: string

Required: true

State ISO code.
suffix: Type: string

Name suffix.

Nested Schema : shippingMethod

Type: object

The shipping method details for the order.

Properties

value: Type: string

Required: true

The shipping method applied to the order.

Nested Schema : items

Type: object

Properties

catRefId: Type: string

Required: true

The category to which the product belongs.
commerceItemId: Type: string

The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no.
productId: Type: string

Required: true

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

Required: true

The quantity of the product in this shipping group.

Nested Schema : coupons

Type: array

The array of coupons applied to the order.

Items

Type: object items

Additional Properties Allowed:

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

code: Type: string

Required: true

The coupon code.
description: Type: string

The coupon description.
id: Type: string

Required: true

The coupon id.
level: Type: string

Required: true

The level of the coupon (whether the coupon is item level, etc).
status: Type: string

Required: true

The current status of the coupon.

Nested Schema : items

Type: object

Properties

actionCode: Type: string

The action code that has been set on the item by the configurator system.
activationDate: Type: string

The activation date in ISO format.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catRefId: Type: string

Required: true

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

Additional Properties Allowed:

The array of child items in the item, if the item is a configurable item. A child item can itself contain child item array if it is a configurable product in itself.
commerceItemId: Type: string

The unique line item ID distinguisher. This field becomes required for split shipping when combineLineItems is set to no.
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
detailedRecurringChargeInfo: Type: object detailedRecurringChargeInfo

Additional Properties Allowed:

Detailed Item Price Information.
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPrice: Type: number

A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
externalPriceQuantity: Type: integer

The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable).
externalRecurringCharge: Type: number

The external recurring price.
externalRecurringChargeDuration: Type: string

The duration for the recurring charge e.g. 12 months.
externalRecurringChargeFrequency: Type: string

The frequency for the recurring charge e.g. Monthly.
giftWithPurchaseSelections: Type: array giftWithPurchaseSelections

Additional Properties Allowed:

The array of gift with purchase selections to be made.
productId: Type: string

Required: true

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

Required: true

The quantity of the product in the cart.
recurringCharge: Type: number

The recurring charge for the item.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current item.

Nested Schema : childItems

Type: array

The array of child items in the item, if the item is a configurable item. A child item can itself contain child item array if it is a configurable product in itself.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : detailedRecurringChargeInfo

Type: object

Detailed Item Price Information.

Properties

amount: Type: number

The monetary amount for the recurring charge.
currencyCode: Type: string

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

The detailed unit price: amount / quantity. (read-only)
discounted: Type: boolean

Whether the price is discounted.
orderDiscountShare: Type: number

The order Discount Share.
quantity: Type: integer

The number of items covered by this recurring charge price info
tax: Type: number

Monetary tax amount.

Nested Schema : externalData

Type: array

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

Items

Type: object items

Additional Properties Allowed:

Nested Schema : giftWithPurchaseSelections

Type: array

The array of gift with purchase selections to be made.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

activationDate: Type: string

The activation date in ISO format.
assetId: Type: string

The asset ID corresponding to the current item.
billingAccountId: Type: string

The billing account ID associated to the current item.
catRefId: Type: string

Required: true

Sku reference id.
customerAccountId: Type: string

The customer account ID associated to the current item.
deactivationDate: Type: string

The deactivation date in ISO format.
detailedRecurringChargeInfo: Type: object detailedRecurringChargeInfo

Additional Properties Allowed:

Detailed Item Price Information.
externalData: Type: array externalData

Additional Properties Allowed:

External data to be associated with a commerce item, provided by a configurator system.
externalPrice: Type: number

Required: true

A price for a quantity of 1 of this line item which will be used in place of the standard catalog price (this price will be verified to ensure it is allowable).
externalPriceQuantity: Type: integer

Required: true

The maximum quantity of this line item which may be purchased at the external price (this quantity will be verified to ensure it is allowable). The value of this property should be -1 in case if the current item is a sub item of a configurable product
externalRecurringCharge: Type: number

The external recurring price.
externalRecurringChargeDuration: Type: string

The duration for the recurring charge e.g. 12 months.
externalRecurringChargeFrequency: Type: string

The frequency for the recurring charge e.g. Monthly.
productId: Type: string

Required: true

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

Required: true

The quantity of the product in the cart.
recurringCharge: Type: number

The recurring charge for the item.
serviceAccountId: Type: string

The service account ID associated to the current item.
serviceId: Type: string

The service ID associated to the current item.

Nested Schema : detailedRecurringChargeInfo

Type: object

Detailed Item Price Information.

Properties

amount: Type: number

The monetary amount for the recurring charge.
currencyCode: Type: string

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

The detailed unit price: amount / quantity. (read-only)
discounted: Type: boolean

Whether the price is discounted.
orderDiscountShare: Type: number

The order Discount Share.
quantity: Type: integer

The number of items covered by this recurring charge price info
tax: Type: number

Monetary tax amount.

Nested Schema : externalData

Type: array

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

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

actionCode: Type: string

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

Required: true

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

Required: true

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

Properties

dynamic_property_key: Type: string

Required: true

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

Properties

actionCode: Type: string

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

Required: true

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

Required: true

Additional Properties Allowed:

The array of values associated with an externalData item.

Nested Schema : values

Type: object

The array of values associated with an externalData item.

Properties

dynamic_property_key: Type: string

Required: true

This property's name and value will be retrieved from a configurator system, so will be dynamically set.

Nested Schema : items

Type: object

Properties

catRefId: Type: string

The product variant Id. Include this Id when you are wishing to mark this as a gift with purchase selection you wish to change out
giftWithPurchaseIdentifier: Type: integer

Required: true

The identifier that links this gift with purchase to the giftWithPurchaseInfo.
giftWithPurchaseQuantity: Type: integer

Required: true

The total quantity of the commerceItem that is giftWithPurchaseQuantity.
productId: Type: string

ID of the product in the cart. Include when you are wishing to mark this as a gift with purchase selection you wish to change out
promotionId: Type: string

Required: true

The promotion id.

Response

Supported Media Types

application/json

200 Response

No response is returned as this is an event webhook

Body

Root Schema : emptyResponse

Properties