Oracle Commerce Cloud October 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":"Sample Quote",
    "shippingGroups":[
        {
            "shippingMethod":{
                "value":"standardShippingMethod"
            },
            "shippingAddress":{
                "lastName":"Anderson",
                "country":"United States",
                "address3":"",
                "address2":"",
                "city":"Syracuse",
                "prefix":"",
                "address1":"21 Cedar Ave",
                "postalCode":"13202",
                "jobTitle":"",
                "companyName":"",
                "county":"",
                "isDefaultAddress":true,
                "suffix":"",
                "selectedCountry":"US",
                "firstName":"Kim",
                "phoneNumber":"212-555-1977",
                "repositoryId":"se-980031",
                "alias":"Home",
                "faxNumber":"",
                "middleName":"",
                "state":"New York",
                "selectedState":"NY",
                "email":"kim@example.com",
                "state_ISOCode":"US-NY"
            },
            "items":[
                {
                    "serviceAccountId":"serviceAcc-123",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "quantity":1,
                    "customerAccountId":"customerAcc-123",
                    "productId":"Product_18Cxi",
                    "assetId":"asset10001",
                    "externalData":[
                    ],
                    "actionCode":"Add",
                    "billingAccountId":"billingAcc-123",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123",
                    "catRefId":"Sku_18Dxi"
                }
            ]
        }
    ],
    "appliedPromotions":[
    ],
    "profileId":"se-570031",
    "payments":[
        {
            "cardCVV":"service",
            "amount":"43.19",
            "cardType":"",
            "type":"card",
            "cardNumber":"service"
        }
    ],
    "amountRemaining":"43.19",
    "shoppingCart":{
        "coupons":[
        ],
        "items":[
            {
                "quantity":1,
                "productId":"Product_18Cxi",
                "catRefId":"Sku_18Dxi"
            }
        ],
        "orderTotal":43.19
    },
    "id":"o90419",
    "billingAddress":{
        "lastName":"Anderson",
        "country":"United States",
        "address3":"",
        "address2":"",
        "city":"Syracuse",
        "prefix":"",
        "address1":"21 Cedar Ave",
        "postalCode":"13202",
        "jobTitle":"",
        "companyName":"",
        "county":"",
        "isDefaultAddress":true,
        "suffix":"",
        "selectedCountry":"US",
        "firstName":"Kim",
        "phoneNumber":"212-555-1977",
        "repositoryId":"se-980031",
        "alias":"Home",
        "faxNumber":"",
        "middleName":"",
        "state":"New York",
        "selectedState":"NY",
        "email":"kim@example.com",
        "state_ISOCode":"US-NY"
    },
    "requestChannel":"agent"
}

Properties

amountRemaining: Type: number

amount to authorize.
appliedPromotions: Type: array appliedPromotions

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

Billing address for the order.
id: Type: string

Required: true

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

the requester note supplied with the quote request
payments: Type: array payments

List of payments
profileId: Type: string

Required: true

Profile id.
requestChannel: Type: string

request Channel name. Possible values are 'agent' or 'asa'.
shippingAddress: Type: object shippingAddress

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

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

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

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

Type: object

Billing address for the order.

Properties

address1: Type: string

Required: true

Address line 1 for this billing address.
address2: Type: string

Address line 2 for this billing address.
address3: Type: string

Address line 3 for this billing address.
city: Type: string

Required: true

City for this billing address.
companyName: Type: string

Company name for this billing address.
country: Type: string

Required: true

Country for this billing address.
county: Type: string

County for this billing address.
email: Type: string

Email for this billing address.
faxNumber: Type: string

Fax number for this billing address.
firstName: Type: string

Required: true

First name for this billing address.
isDefaultAddress: Type: boolean

Is the Address is used as default address or not.
jobTitle: Type: string

Job title for this billing address.
lastName: Type: string

Required: true

Last name for this billing address.
middleName: Type: string

Middle name for this billing address.
phoneNumber: Type: string

Phone number for this billing address.
postalCode: Type: string

Required: true

Postal code for this billing address.
prefix: Type: string

Prefix for this billing address.
selectedCountry: Type: string

The selected country of the shipping address.
selectedState: Type: string

The selected state of the shipping address.
state: Type: string

Required: true

State for this billing address.
state_ISOCode: Type: string

The state ISON code of the shipping address.
suffix: Type: string

Suffix for this billing address.

Nested Schema : payments

Type: array

List of payments

Items

Type: object items

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.
isDefaultAddress: Type: boolean

Is the Address is used as default address or not.
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

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

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

Required: true

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

The total price of the order.

Nested Schema : items

Type: object

Properties

cardCVV: Type: string

Required: true

credit card CVV.
cardNumber: Type: string

Required: true

credit card number.
cardType: Type: string

Required: true

credit card type.
endMonth: Type: string

Required: true

credit card expiry month.
endYear: Type: integer

Required: true

credit card expiry year.
giftCardNumber: Type: string

Gift card number used for payment. Payment type: physicalGiftCard(this field should be used when giftcards are used)
giftCardPin: Type: string

Gift card pin. Payment type: physicalGiftCard(this field should be used when giftcards are used)
nameOnCard: Type: string

Required: true

name printed on credit card.
paymentGroupId: Type: string

Payment Group Id of the gift card payment group. Payment type: physicalGiftCard
PONumber: Type: string

Purchase order number for invoice payment. Payment type: invoice
type: Type: string

Required: true

payment type. payULatamWebcheckout,paypalCheckout,card,invoice,physicalGiftCard

Nested Schema : items

Type: object

Properties

items: Type: array items

Required: true

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

Required: true

The shipping address details.
shippingMethod: Type: object shippingMethod

Required: true

The shipping method details for the order.

Nested Schema : items

Type: array

The array of products in the shipping group.

Items

Type: object items

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

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.
configuratorId: Type: string

Configuration id of the configurable product
customerAccountId: Type: string

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

The deactivation date in ISO format.
externalData: Type: array externalData

External data to be associated with a commerce item, provided by a configurator system.
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.
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 : externalData

Type: array

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

Items

Type: object items

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

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

Type: array

The array of coupons applied to the order.

Items

Type: object items

Nested Schema : items

Type: array

The array of products in the shopping cart.

Items

Type: object items

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

Child items of the commerce item
configuratorId: Type: string

Configuration id of the configurable product
customerAccountId: Type: string

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

The deactivation date in ISO format.
externalData: Type: array externalData

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).
giftWithPurchaseSelections: Type: array giftWithPurchaseSelections

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

Child items of the commerce item

Items

Type: object items

Nested Schema : externalData

Type: array

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

Items

Type: object items

Nested Schema : giftWithPurchaseSelections

Type: array

The array of gift with purchase selections to be made.

Items

Type: object items

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

Sku Id of the child item
childItems: Type: array childItems

Child items of the commerce item
customerAccountId: Type: string

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

The deactivation date in ISO format.
externalData: Type: array externalData

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

Required: true

Product Id of the child item
quantity: Type: number

Required: true

Quantity of the child 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

Child items of the commerce item

Items

Type: object items

Nested Schema : externalData

Type: array

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

Items

Type: object items

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

Sku Id of the child item
customerAccountId: Type: string

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

The deactivation date in ISO format.
externalData: Type: array externalData

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

Required: true

Product Id of the child item
quantity: Type: number

Required: true

Quantity of the child 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 : externalData

Type: array

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

Items

Type: object items

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

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

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

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