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

rejectQuote

post

/ccstore/v1/orders/rejectQuote

Reject Quote. Request for a quote on an incomplete order or request for a requote on a quoated 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 : rejectQuote_request

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : rejectQuote_response
Nested Schema : discountInfo
Type: object
The discount information.
Nested Schema : dynamicProperties
Type: array
Read-only list of dynamic properties for the order along with meta-data.
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
gift with purchase order marker information
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.
Nested Schema : priceInfo
Type: object
The price information.
Nested Schema : priceListGroup
Type: object
The price list group object.
Nested Schema : quoteInfo
Type: object
the quote information of the order
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Nested Schema : shippingAddress
Type: object
The shipping address details.
Nested Schema : shippingGroups
Type: array
The shipping groups for the order.
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Nested Schema : shoppingCart
Type: object
The shopping cart contents of the current order.
Nested Schema : taxPriceInfo
Type: object
tax price information for the order
Nested Schema : orderDiscountDescList
Type: array
The list of all the order discounts.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : errorInfo
Type: array
the array of errors, if any
Nested Schema : notes
Type: array
the notes (history) for the order
Nested Schema : items
Type: object
Nested Schema : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: array
The array of products in the shipping group.
Nested Schema : priceInfo
Type: object
The price information.
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Nested Schema : shippingAddress
Type: object
The shipping address details.
Nested Schema : shippingMethod
Type: object
The shipping method details for the order.
Nested Schema : items
Type: object
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Nested Schema : discountInfo
Type: array
The discount information.
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Nested Schema : variant
Type: array
List of variants for the product.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Nested Schema : items
Type: object
Nested Schema : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: array
The array of products in the shopping cart.
Nested Schema : items
Type: object
Nested Schema : childItems
Type: array
The array of child items in the item, if the item is a configurable item. A child item can itself contain child item array if it is a configurable product in itself.
Nested Schema : discountInfo
Type: array
The discount information.
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Nested Schema : recurringChargePriceInfo
Type: object
Recurring charge price information.
Nested Schema : items
Type: object
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price Information.
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Nested Schema : items
Type: object
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Nested Schema : frequencyAmountTotals
Type: array
The total for each recurring charge frequency
Nested Schema : frequencyTaxTotals
Type: array
The tax for each recurring charge frequency
Nested Schema : items
Type: object
Nested Schema : items
Type: object
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"
    },
    "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/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 error response
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

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"},
  "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/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,
    "rejectionNote": null,
    "quoteDate": null,
    "expirationDate": null
  },
  "giftWithPurchaseOrderMarkers": []
}