Oracle Commerce Cloud October 2017

requestQuote

post

/ccstore/v1/orders/requestQuote

Request Quote. Request for a quote on an incomplete order or request for a requote on a quoted order. Optionally takes the x-ccasset-language headers to get translated content in another language.

Request

Supported Media Types

application/json

Header Parameters

X-CCOrganization: Type: string

Current organization context of the logged in user

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

Following model is returned when operation succeeds.

Body

Root Schema : requestQuote_response

Properties

approvalSystemMessages: Type: array approvalSystemMessages

The array of messages which are stored during order processing
creationDate: Type: string

The creation date in ISO format.
creationTime: Type: number

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

The discount information.
dynamicProperties: Type: array dynamicProperties

Read-only list of dynamic properties for the order along with meta-data.
giftWithPurchaseCommerceItemMarkers: Type: array giftWithPurchaseCommerceItemMarkers

The array of giftWithPurchaseCommerceItemMarkers.
giftWithPurchaseOrderMarkers: Type: array giftWithPurchaseOrderMarkers

gift with purchase order marker information
id: Type: string

The order ID.
lastModifiedDate: Type: string

The order recent modified date in ISO format.
orderComments: Type: array orderComments

The list of all logged comments for the order.
paymentGroups: Type: array paymentGroups

List of payment Groups for the order.
priceInfo: Type: object priceInfo

The price information.
priceListGroup: Type: object priceListGroup

The price list group object.
pricingMessages: Type: object pricingMessages

The Pricing messages information.
profile: Type: object profile

Profile Information for the order.
quoteInfo: Type: object quoteInfo

the quote information of the order
returnRequests: Type: array returnRequests

The list of the requests raised for the order.
shippingAddress: Type: object shippingAddress

The shipping address details.
shippingGroups: Type: array shippingGroups

The shipping groups for the order.
shippingMethod: Type: object shippingMethod

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

The shopping cart contents of the current order.
state: Type: string

the state of the order
stateDetailsAsUser: Type: string

Order State description for this order.
stateString: Type: string

Order state as key string.
taxPriceInfo: Type: object taxPriceInfo

tax price information for the order

Nested Schema : approvalSystemMessages

Type: array

The array of messages which are stored during order processing

Items

Type: string

Nested Schema : discountInfo

Type: object

The discount information.

Properties

orderDiscount: Type: integer

The order discount.
orderDiscountDescList: Type: array orderDiscountDescList

The list of all the order discounts.
shippingDiscount: Type: integer

The shipping discount.

Nested Schema : dynamicProperties

Type: array

Read-only list of dynamic properties for the order along with meta-data.

Items

Type: object items

Nested Schema : giftWithPurchaseCommerceItemMarkers

Type: array

The array of giftWithPurchaseCommerceItemMarkers.

Items

Type: object items

Nested Schema : giftWithPurchaseOrderMarkers

Type: array

gift with purchase order marker information

Items

Type: object items

Nested Schema : orderComments

Type: array

The list of all logged comments for the order.

Items

Type: object items

Nested Schema : paymentGroups

Type: array

List of payment Groups for the order.

Items

Type: object items

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.

Nested Schema : priceListGroup

Type: object

The price list group object.

Properties

repositoryId: Type: string

Repository ID of the price list group.

Nested Schema : pricingMessages

Type: object

The Pricing messages information.

Properties

GiftWithPurchaseMessages: Type: array GiftWithPurchaseMessages

The GWP messages information.

Nested Schema : profile

Type: object

Profile Information for the order.

Properties

email: Type: string

Email Address corresponding to the profile.
firstName: Type: string

First name of profile.
lastName: Type: string

Last name of profile.
middleName: Type: string

Middle name of profile.
organization: Type: object organization

The Organization associated with the B2B customer profile.

Nested Schema : quoteInfo

Type: object

the quote information of the order

Properties

errorInfo: Type: array errorInfo

the array of errors, if any
expirationDate: Type: string

the expiration date of the quoted order, if any
externalId: Type: string

the external id for the quote
notes: Type: array notes

the notes (history) for the order
providerNote: Type: string

the provider note for the quoted order
quoteDate: Type: number

the date the order was quoted in milliseconds
rejectionDate: Type: string

rejection date of the quoted order
rejectionNote: Type: string

the rejection note for an order whose quote has been rejected by user
requestDate: Type: string

the date when the quote was requested in ISO format

Nested Schema : returnRequests

Type: array

The list of the requests raised for the order.

Items

Type: object items

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

Address alias.
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.
selectedCountry: Type: string

Country code.
selectedState: Type: string

State code.
state: Type: string

State.
state_ISOCode: Type: string

State ISO code.
suffix: Type: string

Name suffix.

Nested Schema : shippingGroups

Type: array

The shipping groups for the order.

Items

Type: object items

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 contents of the current order.

Properties

items: Type: array items

The array of products in the shopping cart.

Nested Schema : taxPriceInfo

Type: object

tax price information for the order

Properties

amount: Type: number

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 in the price
miscTax: Type: number

miscellaneous tax
stateTax: Type: number

state tax
valueAddedTax: Type: number

value added tax

Nested Schema : orderDiscountDescList

Type: array

The list of all the order discounts.

Items

Type: object items

Nested Schema : items

Type: object

Properties

coupon: Type: string

The coupon code.
promotionDesc: Type: string

The promotion description.
promotionId: Type: string

The promotion ID.
promotionLevel: Type: string

The promotion level.

Nested Schema : items

Type: object

Properties

id: Type: string

The ID of the dynamic property.
value: Type: string

The value of the dynamic property.

Nested Schema : items

Type: object

Properties

automaticQuantity: Type: number

The quantity of the free gift that this commerce item is making free and was auto added by pricing.
data: Type: integer

The gift hash code for this GWP promotion.
key: Type: string

atg.gwp
remainingQuantity: Type: number

The quantity of the commerce item that is not affected by GWP.
repositoryId: Type: string

The repository id
selectedQuantity: Type: number

The quantity of the free gift that this commerce item is making free and was selected by the shopper.
targetedQuantity: Type: number

The quantity of the free gift that this commerce item is making free and was targeted by pricing.
value: Type: string

The GWP promotion id.

Nested Schema : items

Type: object

Properties

automaticQuantity: Type: number

The quantity of free sku for this gift selection that has already been auto added to the order.
autoRemove: Type: boolean

Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
data: Type: integer

Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
failedQuantity: Type: number

The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.
giftDetail: Type: string

String identifying the free gift, usually the repository id of the gift type.
giftType: Type: string

The type of the gift. (sku, product)
key: Type: string

atg.gwp
quantity: Type: number

The total quantity of sku for this gift selection.
removedQuantity: Type: number

The amount of free quantity that has since been manually removed by a Shopper.
selectedQuantity: Type: integer

The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
targetedQuantity: Type: number

The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.
value: Type: string

The gift with purchase promotion id

Nested Schema : items

Type: object

Properties

comment: Type: string

The comment string.
creationDate: Type: string

Date on which the comment was created.
repositoryId: Type: string

The repository id of the comment record.

Nested Schema : items

Type: object

Properties

amount: Type: number

The amount associated with this Payment Group.
amountAuthorized: Type: number

The amount authorized with this Payment Group.
billingAddress: Type: object billingAddress

Billing address for the order.
cardNumber: Type: string

The masked credit card number.
cardType: Type: string

Payment method. e.g. physicalGiftCard/ creditCard
firstName: Type: string

First name associated with this Payment Group.
lastName: Type: string

Last name associated with this Payment Group.
paidAmount: Type: number

The amount that has been debited to-date for this Payment Group.
paymentGroupId: Type: integer

Id of this payment Group.
paymentState: Type: string

The Payment Group state.
paymentStateDetailsAsUser: Type: string

The payment state description as string.
PONumber: Type: string

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

The amount that has been credited to-date for this Payment Group.
token: Type: string

Token associated with this Payment Group.
totalDue: Type: number

The current working total order price including all discounts, tax, and billing costs.
type: Type: string

Required: true

payment type. payULatamWebcheckout,paypalCheckout,card,invoice,physicalGiftCard
uiIntervention: Type: string

This decides whether the client has to do some intervention for payment. e.g. SOP
zero_value_auto_authorized: Type: string

The Payment Group is auto authorized without any payment details for zero amount. e.g. true

Nested Schema : billingAddress

Type: object

Billing address for the order.

Properties

address1: Type: string

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

City for this billing address.
companyName: Type: string

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

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

First name for this billing address.
jobTitle: Type: string

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

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

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

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

Type: array

The GWP messages information.

Items

Type: object items

Nested Schema : items

Type: object

Properties

identifier: Type: string

The pricing message identifier.
params: Type: array params

The list of all message parameters.
priority: Type: integer

The pricing message priority.
summary: Type: string

The pricing message summary.
type: Type: string

The pricing message type.

Nested Schema : params

Type: array

The list of all message parameters.

Items

Type: object items

Nested Schema : items

Type: object

Properties

promotionId: Type: string

The promotion id.

Nested Schema : organization

Type: object

The Organization associated with the B2B customer profile.

Properties

id: Type: string

The id of the organization.
name: Type: string

The name of of the organization.

Nested Schema : errorInfo

Type: array

the array of errors, if any

Items

Type: string

Nested Schema : notes

Type: array

the notes (history) for the order

Items

Type: object items

Nested Schema : items

Type: object

Properties

profileId: Type: string

the profile id of the user
profileType: Type: string

the profile type of the user that requested the quote
requestDate/quoteDate/rejectionDate: Type: number

the request/quote/rejection date for the note
requesterNote/providerNote/rejectionNote: Type: string

the requester/provider/rejection note

Nested Schema : items

Type: object

Properties

createdDate: Type: string

The creation date of the return request.
returnRequestId: Type: string

The return request id.
state: Type: string

The status of the return request.
totalRefund: Type: number

The total amount to be refunded on return.
totalReturnQuantity: Type: integer

The total quantity for which return request has been raised.

Nested Schema : items

Type: object

Properties

items: Type: array items

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

The price information.
shippingAddress: Type: object shippingAddress

The shipping address details.
shippingMethod: Type: object shippingMethod

The shipping method details for the order.
surcharge: Type: number

The shipping surcharge.

Nested Schema : items

Type: array

The array of products in the shipping group.

Items

Type: object items

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.

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

Address alias.
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.
selectedCountry: Type: string

Country code.
selectedState: Type: string

State code.
state: Type: string

State.
state_ISOCode: Type: string

State ISO code.
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.
shippingMethodDescription: Type: string

The description of the shipping method.
shippingTax: Type: number

The shipping tax.
value: Type: string

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

active or not.
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

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

Child items of the commerce item
configuratorId: Type: string

configurator 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.
discountInfo: Type: array discountInfo

The discount information.
displayName: Type: string

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

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

The Price of the product as per the external pricing system.
externalPriceQuantity: Type: integer

Quantity of the product, the customer is allowed to buy at the external price.
price: Type: integer

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

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

The quantity of the product.
rawTotalPrice: Type: integer

The raw price of the product.
serviceAccountId: Type: string

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

The service ID associated to the current item.
unitPrice: Type: integer

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

List of variants for the product.

Nested Schema : childItems

Type: array

Child items of the commerce item

Items

Type: object items

Nested Schema : discountInfo

Type: array

The discount information.

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

Type: array

List of variants for the product.

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

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

Display name of the child product
externalData: Type: array externalData

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

Product Id of the child item
quantity: Type: number

Quantity of the child item
route: Type: string

Image route
selectedOptions: Type: array selectedOptions

The array of variants 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 : selectedOptions

Type: array

The array of variants of the child item.

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

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

Display name of the child product
externalData: Type: array externalData

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

Product Id of the child item
quantity: Type: number

Quantity of the child item
route: Type: string

Image route
selectedOptions: Type: array selectedOptions

The array of variants 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 : selectedOptions

Type: array

The array of variants of the child item.

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

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

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

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

Nested Schema : items

Type: object

Properties

optionName: Type: string

The variant option name.
optionValue: Type: string

The variant option value

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

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

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

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

Nested Schema : items

Type: object

Properties

optionName: Type: string

The variant option name.
optionValue: Type: string

The variant option value

Nested Schema : items

Type: object

Properties

coupon: Type: string

The coupon ID.
promotionDesc: Type: string

The promotion description.
promotionId: Type: string

The promotion ID.

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

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

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

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

Nested Schema : items

Type: object

Properties

optionName: Type: string

The variant option name.
optionValue: Type: string

The variant option value.

Nested Schema : items

Type: array

The array of products in the shopping cart.

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

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

Child items of the commerce item
configuratorId: Type: string

configurator 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.
discountInfo: Type: array discountInfo

The discount information.
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).
price: Type: integer

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

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

The quantity of the product.
rawTotalPrice: Type: integer

The raw price of the product.
serviceAccountId: Type: string

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

The service ID associated to the current item.
shippingSurchargeValue: Type: integer

The extra handling cost for shipping the product.
unitPrice: Type: integer

The unit price of the product.

Nested Schema : childItems

Type: array

Child items of the commerce item

Items

Type: object items

Nested Schema : discountInfo

Type: array

The discount information.

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

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

Display name of the child product
externalData: Type: array externalData

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

Product Id of the child item
quantity: Type: number

Quantity of the child item
route: Type: string

Image route
selectedOptions: Type: array selectedOptions

The array of variants 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 : selectedOptions

Type: array

The array of variants of the child item.

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

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

Display name of the child product
externalData: Type: array externalData

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

Product Id of the child item
quantity: Type: number

Quantity of the child item
route: Type: string

Image route
selectedOptions: Type: array selectedOptions

The array of variants 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 : selectedOptions

Type: array

The array of variants of the child item.

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

optionName: Type: string

The variant option name.
optionValue: Type: string

The variant option value

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

optionName: Type: string

The variant option name.
optionValue: Type: string

The variant option value

Nested Schema : items

Type: object

Properties

coupon: Type: string

The coupon ID.
promotionDesc: Type: string

The promotion description.
promotionId: Type: string

The promotion ID.
promotionLevel: Type: string

The promotion level.
totalAdjustment: Type: number

Total adjustment by the promotion.

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.

Example application/json


{
    "taxPriceInfo":{
        "cityTax":0,
        "amount":0,
        "valueAddedTax":0,
        "countyTax":0,
        "isTaxIncluded":false,
        "miscTax":0,
        "districtTax":0,
        "stateTax":0,
        "countryTax":0
    },
    "shippingGroups":[
        {
            "shippingMethod":{
                "shippingTax":0,
                "cost":0,
                "value":"hardgoodShippingGroup",
                "shippingMethodDescription":"hardgoodShippingGroup"
            },
            "shippingGroupId":"sg30411",
            "submittedDate":null,
            "priceInfo":{
                "amount":12.99,
                "total":12.99,
                "shipping":0,
                "shippingSurchargeValue":0,
                "tax":0,
                "subTotal":12.99,
                "currencyCode":"USD",
                "totalWithoutTax":12.99
            },
            "recurringChargePriceInfo":{
                "amount":30,
                "total":32.4,
                "shipping":0,
                "subTotalByFrequency":[
                    {
                        "amount":30,
                        "frequency":"Monthly"
                    }
                ],
                "taxByFrequency":[
                    {
                        "amount":2.4,
                        "frequency":"Monthly"
                    }
                ],
                "tax":2.4,
                "subTotal":30,
                "currencyCode":"USD",
                "totalWithoutTax":30
            },
            "discountInfo":{
                "orderDiscount":0,
                "shippingDiscount":0,
                "discountDescList":[
                ]
            },
            "shipOnDate":null,
            "trackingInfo":[
            ],
            "actualShipDate":null,
            "shippingAddress":{
                "lastName":null,
                "country":null,
                "address3":null,
                "address2":null,
                "city":null,
                "prefix":null,
                "address1":null,
                "postalCode":null,
                "companyName":null,
                "jobTitle":null,
                "county":null,
                "suffix":null,
                "firstName":null,
                "phoneNumber":null,
                "faxNumber":null,
                "alias":null,
                "middleName":null,
                "state":null,
                "email":null
            },
            "items":[
                {
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v5784313290557454780/products/ab_meet_frankenstein_LARGE.jpg&height=100&width=100",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "rawTotalPrice":12.99,
                    "returnedQuantity":0,
                    "displayName":"Abbott and Costello Meet Frankenstein",
                    "dynamicProperties":[
                        {
                            "id":"dynamicPropertyMode",
                            "label":"Mode",
                            "value":"pickup"
                        }
                    ],
                    "shippingSurchargeValue":0,
                    "externalData":[
                    ],
                    "discountAmount":0,
                    "billingAccountId":"billingAcc-123",
                    "commerceItemId":"ci3000411",
                    "assetId":"asset10001",
                    "price":12.99,
                    "variant":[
                    ],
                    "onSale":false,
                    "primaryImageAltText":"Abbott and Costello Meet Frankenstein",
                    "actionCode":"Add",
                    "serviceId":"service-123",
                    "stateDetailsAsUser":"The item has been initialized within the shipping group",
                    "serviceAccountId":"serviceAcc-123",
                    "unitPrice":12.99,
                    "primaryImageTitle":"Abbott and Costello Meet Frankenstein",
                    "quantity":1,
                    "productId":"Product_15CD",
                    "salePrice":0,
                    "detailedItemPriceInfo":[
                        {
                            "discounted":false,
                            "amount":12.99,
                            "quantity":1,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":12.99,
                            "currencyCode":"USD"
                        }
                    ],
                    "externalRecurringCharge":10,
                    "active":true,
                    "externalRecurringChargeFrequency":"Monthly",
                    "externalRecurringChargeDuration":"12",
                    "catRefId":"Sku_15DE",
                    "customerAccountId":"customerAcc-123",
                    "discountInfo":[
                    ],
                    "route":"/abbott-and-costello-meet-frankenstein/product/Product_15CD",
                    "detailedRecurringChargeInfo":[
                        {
                            "discounted":false,
                            "amount":10,
                            "quantity":1,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":10,
                            "currencyCode":"USD"
                        }
                    ],
                    "activationDate":"2017-06-27T15:30:00Z",
                    "listPrice":12.99,
                    "recurringCharge":10,
                    "status":"INITIAL"
                }
            ],
            "trackingNumber":null,
            "status":"INITIAL"
        }
    ],
    "creationTime":1.4774795181E12,
    "lastModifiedDate":"2016-10-26T10:58:41.098Z",
    "sourceSystem":"Cloud Commerce",
    "payments":[
    ],
    "priceListGroup":{
        "repositoryId":"defaultPriceGroup"
    },
    "lastPublishedTime":-1,
    "creationDate":"2016-10-26T10:58:38.100Z",
    "uuid":"50c19085-2f79-43e2-8672-4db713fdc9b3",
    "orderProfileId":"120213",
    "priceInfo":{
        "amount":12.99,
        "total":12.99,
        "shipping":0,
        "shippingSurchargeValue":0,
        "tax":0,
        "subTotal":12.99,
        "currencyCode":"USD",
        "totalWithoutTax":12.99
    },
    "recurringChargePriceInfo":{
        "amount":30,
        "total":32.4,
        "shipping":0,
        "subTotalByFrequency":[
            {
                "amount":30,
                "frequency":"Monthly"
            }
        ],
        "taxByFrequency":[
            {
                "amount":2.4,
                "frequency":"Monthly"
            }
        ],
        "tax":2.4,
        "subTotal":30,
        "currencyCode":"USD",
        "totalWithoutTax":30
    },
    "discountInfo":{
        "orderDiscount":0,
        "orderDiscountDescList":[
        ],
        "shippingDiscount":0
    },
    "trackingInfo":[
    ],
    "shoppingCart":{
        "items":[
            {
                "deactivationDate":"2018-06-27T12:59:59Z",
                "rawTotalPrice":12.99,
                "dynamicProperties":[
                    {
                        "id":"dynamicPropertyMode",
                        "label":"Mode",
                        "value":"pickup"
                    }
                ],
                "displayName":"Abbott and Costello Meet Frankenstein",
                "shippingSurchargeValue":0,
                "externalData":[
                ],
                "discountAmount":0,
                "billingAccountId":"billingAcc-123",
                "commerceItemId":"ci3000411",
                "assetId":"asset10001",
                "price":12.99,
                "variant":[
                ],
                "actionCode":"Add",
                "id":"ci3000411",
                "serviceId":"service-123",
                "unitPrice":12.99,
                "serviceAccountId":"serviceAcc-123",
                "quantity":1,
                "productId":"Product_15CD",
                "salePrice":0,
                "detailedItemPriceInfo":[
                    {
                        "discounted":false,
                        "amount":12.99,
                        "quantity":1,
                        "tax":0,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":12.99,
                        "currencyCode":"USD"
                    }
                ],
                "externalRecurringCharge":10,
                "giftWithPurchaseCommerceItemMarkers":[
                ],
                "externalRecurringChargeFrequency":"Monthly",
                "externalRecurringChargeDuration":"12",
                "catRefId":"Sku_15DE",
                "customerAccountId":"customerAcc-123",
                "discountInfo":[
                ],
                "detailedRecurringChargeInfo":[
                    {
                        "discounted":false,
                        "amount":10,
                        "quantity":1,
                        "tax":0,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":10,
                        "currencyCode":"USD"
                    }
                ],
                "activationDate":"2017-06-27T15:30:00Z",
                "listPrice":12.99,
                "recurringCharge":10
            }
        ]
    },
    "orderLocale":"en",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccstoreui/v1/orders/requestQuote"
        }
    ],
    "id":"o30411",
    "state":"PENDING_QUOTE",
    "quoteInfo":{
        "providerNote":null,
        "notes":[
            {
                "profileType":null,
                "profileId":"120213",
                "requestDate":1.477479521002E12,
                "requesterNote":"This is a sample quote"
            }
        ],
        "rejectionDate":null,
        "requestDate":"2016-10-26T10:58:41.002Z",
        "errorInfo":null,
        "externalID":null,
        "rejectionNote":null,
        "quoteDate":null,
        "expirationDate":null
    },
    "giftWithPurchaseOrderMarkers":[
    ]
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

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

Sample Response Payload returned by endpoint:

{
  "taxPriceInfo": {
    "cityTax": 0,
    "amount": 0,
    "valueAddedTax": 0,
    "countyTax": 0,
    "isTaxIncluded": false,
    "miscTax": 0,
    "districtTax": 0,
    "stateTax": 0,
    "countryTax": 0
  },
  "shippingGroups": [{
    "shippingMethod": {
      "shippingTax": 0,
      "cost": 0,
      "value": "hardgoodShippingGroup",
      "shippingMethodDescription": "hardgoodShippingGroup"
    },
    "shippingGroupId": "sg30411",
    "submittedDate": null,
    "priceInfo": {
      "amount": 12.99,
      "total": 12.99,
      "shipping": 0,
      "shippingSurchargeValue": 0,
      "tax": 0,
      "subTotal": 12.99,
      "currencyCode": "USD",
      "totalWithoutTax": 12.99
    },
    "recurringChargePriceInfo": {
      "amount": 30,
      "total": 32.4,
      "shipping": 0,
      "subTotalByFrequency": [{
        "amount": 30,
        "frequency": "Monthly"
      }],
      "taxByFrequency": [{
        "amount": 2.4,
        "frequency": "Monthly"
      }],
      "tax": 2.4,
      "subTotal": 30,
      "currencyCode": "USD",
      "totalWithoutTax": 30
    },
    "discountInfo": {
      "orderDiscount": 0,
      "shippingDiscount": 0,
      "discountDescList": []
    },
    "shipOnDate": null,
    "trackingInfo": [],
    "actualShipDate": null,
    "shippingAddress": {
      "lastName": null,
      "country": null,
      "address3": null,
      "address2": null,
      "city": null,
      "prefix": null,
      "address1": null,
      "postalCode": null,
      "companyName": null,
      "jobTitle": null,
      "county": null,
      "suffix": null,
      "firstName": null,
      "phoneNumber": null,
      "faxNumber": null,
      "alias": null,
      "middleName": null,
      "state": null,
      "email": null
    },
    "items": [{
      "primaryThumbImageURL": "/ccstore/v1/images/?source=/file/v5784313290557454780/products/ab_meet_frankenstein_LARGE.jpg&height=100&width=100",
      "deactivationDate": "2018-06-27T12:59:59Z",
      "rawTotalPrice": 12.99,
      "returnedQuantity": 0,
      "displayName": "Abbott and Costello Meet Frankenstein",
      "dynamicProperties": [{
        "id": "dynamicPropertyMode",
        "label": "Mode",
        "value": "pickup"
      }],
      "shippingSurchargeValue": 0,
      "externalData": [],
      "discountAmount": 0,
      "billingAccountId": "billingAcc-123",
      "commerceItemId": "ci3000411",
      "assetId": "asset10001",
      "price": 12.99,
      "variant": [],
      "onSale": false,
      "primaryImageAltText": "Abbott and Costello Meet Frankenstein",
      "actionCode": "Add",
      "serviceId": "service-123",
      "stateDetailsAsUser": "The item has been initialized within the shipping group",
      "serviceAccountId": "serviceAcc-123",
      "unitPrice": 12.99,
      "primaryImageTitle": "Abbott and Costello Meet Frankenstein",
      "quantity": 1,
      "productId": "Product_15CD",
      "salePrice": 0,
      "detailedItemPriceInfo": [{
        "discounted": false,
        "amount": 12.99,
        "quantity": 1,
        "tax": 0,
        "orderDiscountShare": 0,
        "detailedUnitPrice": 12.99,
        "currencyCode": "USD"
      }],
      "externalRecurringCharge": 10,
      "active": true,
      "externalRecurringChargeFrequency": "Monthly",
      "externalRecurringChargeDuration": "12",
      "catRefId": "Sku_15DE",
      "customerAccountId": "customerAcc-123",
      "discountInfo": [],
      "route": "/abbott-and-costello-meet-frankenstein/product/Product_15CD",
      "detailedRecurringChargeInfo": [{
        "discounted": false,
        "amount": 10,
        "quantity": 1,
        "tax": 0,
        "orderDiscountShare": 0,
        "detailedUnitPrice": 10,
        "currencyCode": "USD"
      }],
      "activationDate": "2017-06-27T15:30:00Z",
      "listPrice": 12.99,
      "recurringCharge": 10,
      "status": "INITIAL"
    }],
    "trackingNumber": null,
    "status": "INITIAL"
  }],
  "creationTime": 1477479518100,
  "lastModifiedDate": "2016-10-26T10:58:41.098Z",
  "sourceSystem": "Cloud Commerce",
  "payments": [],
  "priceListGroup": {"repositoryId": "defaultPriceGroup"},
  "lastPublishedTime": -1,
  "creationDate": "2016-10-26T10:58:38.100Z",
  "uuid": "50c19085-2f79-43e2-8672-4db713fdc9b3",
  "orderProfileId": "120213",
  "priceInfo": {
    "amount": 12.99,
    "total": 12.99,
    "shipping": 0,
    "shippingSurchargeValue": 0,
    "tax": 0,
    "subTotal": 12.99,
    "currencyCode": "USD",
    "totalWithoutTax": 12.99
  },
  "recurringChargePriceInfo": {
    "amount": 30,
    "total": 32.4,
    "shipping": 0,
    "subTotalByFrequency": [{
      "amount": 30,
      "frequency": "Monthly"
    }],
    "taxByFrequency": [{
      "amount": 2.4,
      "frequency": "Monthly"
    }],
    "tax": 2.4,
    "subTotal": 30,
    "currencyCode": "USD",
    "totalWithoutTax": 30
  },
  "discountInfo": {
    "orderDiscount": 0,
    "orderDiscountDescList": [],
    "shippingDiscount": 0
  },
  "trackingInfo": [],
  "shoppingCart": {"items": [{
    "deactivationDate": "2018-06-27T12:59:59Z",
    "rawTotalPrice": 12.99,
    "dynamicProperties": [{
      "id": "dynamicPropertyMode",
      "label": "Mode",
      "value": "pickup"
    }],
    "displayName": "Abbott and Costello Meet Frankenstein",
    "shippingSurchargeValue": 0,
    "externalData": [],
    "discountAmount": 0,
    "billingAccountId": "billingAcc-123",
    "commerceItemId": "ci3000411",
    "assetId": "asset10001",
    "price": 12.99,
    "variant": [],
    "actionCode": "Add",
    "id": "ci3000411",
    "serviceId": "service-123",
    "unitPrice": 12.99,
    "serviceAccountId": "serviceAcc-123",
    "quantity": 1,
    "productId": "Product_15CD",
    "salePrice": 0,
    "detailedItemPriceInfo": [{
      "discounted": false,
      "amount": 12.99,
      "quantity": 1,
      "tax": 0,
      "orderDiscountShare": 0,
      "detailedUnitPrice": 12.99,
      "currencyCode": "USD"
    }],
    "externalRecurringCharge": 10,
    "giftWithPurchaseCommerceItemMarkers": [],
    "externalRecurringChargeFrequency": "Monthly",
    "externalRecurringChargeDuration": "12",
    "catRefId": "Sku_15DE",
    "customerAccountId": "customerAcc-123",
    "discountInfo": [],
    "detailedRecurringChargeInfo": [{
      "discounted": false,
      "amount": 10,
      "quantity": 1,
      "tax": 0,
      "orderDiscountShare": 0,
      "detailedUnitPrice": 10,
      "currencyCode": "USD"
    }],
    "activationDate": "2017-06-27T15:30:00Z",
    "listPrice": 12.99,
    "recurringCharge": 10
  }]},
  "orderLocale": "en",
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccstoreui/v1/orders/requestQuote"
  }],
  "id": "o30411",
  "state": "PENDING_QUOTE",
  "quoteInfo": {
    "providerNote": null,
    "notes": [{
      "profileType": null,
      "profileId": "120213",
      "requestDate": 1477479521002,
      "requesterNote": "This is a sample quote"
    }],
    "rejectionDate": null,
    "requestDate": "2016-10-26T10:58:41.002Z",
    "errorInfo": null,
    "externalID": null,
    "rejectionNote": null,
    "quoteDate": null,
    "expirationDate": null
  },
  "giftWithPurchaseOrderMarkers": []
}