1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Store
  4. Orders

Reject a quote

post

/ccstore/v1/orders/rejectQuote

Allows the quote on an order (cart) containing a quote (quoted order) to be rejected. Returns the updated order.

Pre-requisite: The integration with CPQ quoting needs to be enabled. See Oracle CPQ integration for more information.

Request

Supported Media Types
Header Parameters
Body ()
Root Schema : rejectQuote_request
Type: object
Show Source
Example:
{
    "note":"This is a sample quote",
    "id":"o90417"
}
Back to Top

Response

Supported Media Types

200 Response

Returned when the operation succeeds.
Body ()
Root Schema : rejectQuote_response
Type: object
Show Source
Nested Schema : approvalSystemMessages
Type: array
The array of messages which are stored during order processing
Show Source
Nested Schema : discountInfo
Type: object
The discount information.
Show Source
Nested Schema : dynamicProperties
Type: array
Read-only list of dynamic properties for the order along with meta-data.
Show Source
Nested Schema : giftWithPurchaseCommerceItemMarkers
Type: array
The array of giftWithPurchaseCommerceItemMarkers.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
gift with purchase order marker information
Show Source
Nested Schema : markers
Type: array
Order markers
Show Source
Nested Schema : orderComments
Type: array
The list of all logged comments for the order.
Show Source
Nested Schema : paymentGroups
Type: array
List of payment Groups for the order.
Show Source
Nested Schema : priceInfo
Type: object
The price information.
Show Source
  • The total order amount.
  • The currency code.
  • An order can be paid in points and monetary currency. This field represent order value which will be paid in points. It includes items amount, item discount, order discount. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
  • This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
  • The shipping surcharges added at item level in monetary currency.
  • This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. Prerequisites for the value in this Attribute: Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled. 3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
  • An order can be paid in points and monetary currency. This field represent order value which will be paid in monetary currency. It includes shipping charges, shipping surcharges, shipping discount and total tax in monetary currency. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled. 3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
  • The total shipping cost.
  • Extra handling costs for shipping the products.
  • Sub-total.
  • The total tax amount.
  • Total excluding shipping and tax in monetary currency
  • The order total.
Nested Schema : priceListGroup
Type: object
The price list group object.
Show Source
Nested Schema : pricingMessages
Type: object
The Pricing messages information.
Show Source
Nested Schema : profile
Type: object
Profile Information for the order.
Show Source
Nested Schema : quoteInfo
Type: object
the quote information of the order
Show Source
Nested Schema : returnRequests
Type: array
The list of the requests raised for the order.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
Nested Schema : shippingGroups
Type: array
The shipping groups for the order.
Show Source
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Show Source
Nested Schema : shoppingCart
Type: object
The shopping cart contents of the current order.
Show Source
Nested Schema : submissionErrorCodes
Type: array
Set of error codes recorded during each unsuccessful retry of queued orders.
Show Source
Nested Schema : submissionErrorMessages
Type: array
List of failure reasons recorded during each unsuccessful retry of queued orders.
Show Source
Nested Schema : submissionProgress
Type: array
Checkpoints crossed successfully during each unsuccessful retry of queued orders.
Show Source
Nested Schema : taxPriceInfo
Type: object
tax price information for the order
Show Source
Nested Schema : orderDiscountDescList
Type: array
The list of all the order discounts.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
  • The quantity of free sku for this gift selection that has already been auto added to the order.
  • Flag to indicate whether free gifts should be auto removed if the promotion no longer qualifies.
  • Gift hash code to track which gift selection in the promotion this is. It allows the commerce item marker to link to this one.
  • The amount of automatic free quantity that failed to be added to the cart due to some pricing error, e.g. invalid site.
  • String identifying the free gift, usually the repository id of the gift type.
  • The type of the gift. (sku, product)
  • atg.gwp
  • The total quantity of sku for this gift selection.
  • The amount of free quantity that has since been manually removed by a Shopper.
  • The quantity of free sku for this gift selection that has already been selected by the Shopper and added to the order.
  • The quantity of free sku for this gift selection that has already been targeted and made free by the calculator in the order.
  • The gift with purchase promotion id
Nested Schema : items
Type: object
Show Source
  • Order marker key. In a marketing campaign marker, key signifies that it is a campaign marker and it also identifies the external marketing system that is the source of the campaign, e.g., campaign_eloqua
  • Order marker value. In a marketing campaign marker, value holds the marketing system's unique campaign ID.
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
Billing address for the order.
Show Source
Nested Schema : GiftWithPurchaseMessages
Type: array
The GWP messages information.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : params
Type: array
The list of all message parameters.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : organization
Type: object
The Organization associated with the B2B customer profile.
Show Source
Nested Schema : errorInfo
Type: array
the array of errors, if any
Show Source
Nested Schema : notes
Type: array
the notes (history) for the order
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
The array of products in the shipping group.
Show Source
Nested Schema : priceInfo
Type: object
The price information.
Show Source
Nested Schema : shippingAddress
Type: object
The shipping address details.
Show Source
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Show Source
Nested Schema : store
Type: object
Information about the Store that the items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Child items of the commerce item
Show Source
Nested Schema : discountInfo
Type: array
The discount information.
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : variant
Type: array
List of variants for the product.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Child items of the commerce item
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : selectedOptions
Type: array
The array of variants of the child item.
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type: object
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : selectedOptions
Type: array
The array of variants of the child item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
The array of products in the shopping cart.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Child items of the commerce item
Show Source
Nested Schema : discountInfo
Type: array
The discount information.
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Child items of the commerce item
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : selectedOptions
Type: array
The array of variants of the child item.
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : items
Type: object
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : selectedOptions
Type: array
The array of variants of the child item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Example Response (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",
                "externalId":null,
                "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":[
                    ],
                    "billingProfileId":"billingProfile-123",
                    "discountAmount":"0",
                    "billingAccountId":"billingAcc-123",
                    "assetKey":null,
                    "commerceItemId":"ci3000411",
                    "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",
                    "pointOfNoRevision":false,
                    "relationshipType":"SHIPPINGQUANTITY",
                    "productId":"Product_15CD",
                    "salePrice":"0",
                    "detailedItemPriceInfo":[
                        {
                            "discounted":false,
                            "amount":"12.99",
                            "quantity":"1",
                            "tax":"0",
                            "orderDiscountShare":"0",
                            "detailedUnitPrice":"12.99",
                            "currencyCode":"USD"
                        }
                    ],
                    "externalRecurringCharge":"10",
                    "parentAssetKey":null,
                    "active":true,
                    "rootAssetKey":null,
                    "externalRecurringChargeFrequency":"Monthly",
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "externalRecurringChargeDuration":"12",
                    "catRefId":"Sku_15DE",
                    "customerAccountId":"customerAcc-123",
                    "discountInfo":[
                    ],
                    "route":"/abbott-and-costello-meet-frankenstein/product/Product_15CD",
                    "siteId":"siteUS",
                    "detailedRecurringChargeInfo":[
                        {
                            "discounted":false,
                            "amount":"10",
                            "quantity":"1",
                            "tax":"0",
                            "orderDiscountShare":"0",
                            "detailedUnitPrice":"10",
                            "currencyCode":"USD"
                        }
                    ],
                    "activationDate":"2017-06-27T15:30:00Z",
                    "asset":false,
                    "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"
    },
    "cartName":"Test Name",
    "creationDate":"2016-10-26T10:58:38.100Z",
    "uuid":"50c19085-2f79-43e2-8672-4db713fdc9b3",
    "orderProfileId":"120213",
    "orderAction":"order",
    "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":[
                ],
                "billingProfileId":"billingProfile-123",
                "discountAmount":"0",
                "billingAccountId":"billingAcc-123",
                "assetKey":"12345",
                "commerceItemId":"ci3000411",
                "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":[
                ],
                "parentAssetKey":null,
                "originalCommerceItemId":null,
                "externalRecurringChargeFrequency":"Monthly",
                "rootAssetKey":null,
                "transactionDate":"2018-06-27T12:59:59Z",
                "externalRecurringChargeDuration":"12",
                "catRefId":"Sku_15DE",
                "customerAccountId":"customerAcc-123",
                "discountInfo":[
                ],
                "siteId":"siteUS",
                "detailedRecurringChargeInfo":[
                    {
                        "discounted":false,
                        "amount":"10",
                        "quantity":"1",
                        "tax":"0",
                        "orderDiscountShare":"0",
                        "detailedUnitPrice":"10",
                        "currencyCode":"USD"
                    }
                ],
                "activationDate":"2017-06-27T15:30:00Z",
                "asset":false,
                "listPrice":"12.99",
                "recurringCharge":"10"
            }
        ]
    },
    "orderLocale":"en",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccstoreui/v1/orders/rejectQuote"
        }
    ],
    "id":"o30411",
    "state":"REJECTED_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,
        "quoteSubmitted":false,
        "rejectionNote":null,
        "quoteDate":null,
        "expirationDate":null
    },
    "giftWithPurchaseOrderMarkers":[
    ]
}

Default Response

The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
Error CodeDescriptionPossible Fix
28361Failed to reject quoted order.Check error message for additional information.

The error response:
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top