1. REST API for Oracle Commerce Cloud 21B
  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",
    "orderId":"o30411"
}
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 : 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 : giftWithPurchaseOrderMarkers
Type: array
gift with purchase order marker information
Show Source
Nested Schema : payments
Type: object
Payment details for the order, including additional properties specific to the payment type. This should be an empty array for request of a quote.
Show Source
Nested Schema : priceInfo
Type: object
The price information.
Show Source
Nested Schema : priceListGroup
Type: object
The price list group object.
Show Source
Nested Schema : quoteInfo
Type: object
the quote information of the order
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
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 : 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 : 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 : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
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 : recurringChargePriceInfo
Type: object
Recurring charge 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 from which items are being picked up from (if shipping group type is inStorePickupShippingGroup)
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : discountInfo
Type: array
The discount information.
Show Source
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
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 : 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 : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
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 shopping cart.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
The array of child items in the item, if the item is a configurable item. A child item can itself contain a child item array if it is a configurable product in itself.
Show Source
Nested Schema : discountInfo
Type: array
The discount information.
Show Source
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
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 : recurringChargePriceInfo
Type: object
Recurring charge price information.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price 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 : 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 : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Show Source
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
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,
                "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":1.4774795181E12,
    "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":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 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