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

rejectQuote

post

/ccagent/v1/orders/quote/reject

Reject Quote. Reject for a quote. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value. If this header is not provided, then the endPoint will consider first active organization as the current organization for a B2B user.

Request

Supported Media Types
  • application/json
Header Parameters
X-CCOrganization
Type: string
the organization Id in which order should be created
x-ccsite
Type: string
the site id on which the orders is laced
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

{
    "creationTime":1.478685761E12,
    "orderComments":[
    ],
    "sourceSystem":"Cloud Commerce",
    "dynamicProperties":[
    ],
    "stateString":"REJECTED_QUOTE",
    "paymentGroups":[
    ],
    "priceInfo":{
        "amount":500,
        "total":577.8,
        "shipping":35,
        "shippingSurchargeValue":0,
        "tax":42.8,
        "subTotal":500,
        "currencyCode":"USD",
        "totalWithoutTax":535
    },
    "pricingMessages":{
    },
    "shoppingCart":{
        "items":[
            {
                "deactivationDate":"2018-06-27T12:59:59Z",
                "rawTotalPrice":500,
                "returnedQuantity":0,
                "displayName":"Dr. Dolittle",
                "shippingSurchargeValue":0,
                "discountAmount":0,
                "externalData":[
                ],
                "billingAccountId":"billingAcc-123",
                "imageInfo":{
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v6155711626513500309/products/doctordolittle_LARGE.jpg&height=100&width=100"
                },
                "externalPrice":500,
                "assetId":"asset10001",
                "price":500,
                "variant":[
                ],
                "onSale":false,
                "actionCode":"Add",
                "serviceId":"service-123",
                "stateDetailsAsUser":"Added to order",
                "serviceAccountId":"serviceAcc-123",
                "unitPrice":14.99,
                "quantity":1,
                "productId":"Product_18Cxi",
                "salePrice":0,
                "detailedItemPriceInfo":[
                    {
                        "discounted":false,
                        "amount":500,
                        "quantity":1,
                        "tax":40,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":500,
                        "currencyCode":"USD"
                    }
                ],
                "giftWithPurchaseCommerceItemMarkers":[
                ],
                "tax":40,
                "externalPriceQuantity":1,
                "catRefId":"Sku_18Dxi",
                "customerAccountId":"customerAcc-123",
                "discountInfo":[
                ],
                "stateDescription":"INITIAL",
                "activationDate":"2017-06-27T15:30:00Z",
                "listPrice":14.99,
                "status":0
            }
        ]
    },
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/orders/quote/reject"
        }
    ],
    "id":"o90419",
    "state":4005,
    "quoteInfo":{
        "providerNote":null,
        "notes":[
            {
                "profileType":null,
                "profileId":"se-570031",
                "rejectionDate":"2016-11-09T10:14:21.397Z",
                "rejectionNote":"Quote Rejected"
            },
            {
                "profileType":null,
                "profileId":"se-570031",
                "requestDate":"2016-11-09T10:03:16.240Z",
                "requesterNote":"jh"
            }
        ],
        "rejectionDate":"2016-11-09T10:14:21.397Z",
        "requestDate":"2016-11-09T10:03:16.240Z",
        "errorInfo":null,
        "externalId":null,
        "rejectionNote":"Quote Rejected",
        "quoteDate":"2016-11-09T10:13:56.206Z",
        "expirationDate":"2260-11-10T18:56:36.000Z"
    },
    "stateDetailsAsUser":"This quote has been rejected",
    "taxPriceInfo":{
        "cityTax":0,
        "amount":42.8,
        "valueAddedTax":0,
        "countyTax":21.4,
        "isTaxIncluded":false,
        "miscTax":0,
        "districtTax":0,
        "stateTax":21.4,
        "countryTax":0
    },
    "shippingGroups":[
        {
            "taxPriceInfo":{
                "cityTax":0,
                "amount":42.8,
                "valueAddedTax":0,
                "countyTax":21.4,
                "isTaxIncluded":false,
                "miscTax":0,
                "districtTax":0,
                "stateTax":21.4,
                "countryTax":0
            },
            "shippingMethod":{
                "shippingTax":2.8,
                "cost":35,
                "displayName":"Standard",
                "value":"standardShippingMethod",
                "shippingMethodDescription":"Standard"
            },
            "shippingGroupId":"sg100419",
            "submittedDate":null,
            "priceInfo":{
                "amount":500,
                "total":577.8,
                "shipping":35,
                "shippingSurchargeValue":0,
                "tax":42.8,
                "subTotal":500,
                "currencyCode":"USD",
                "totalWithoutTax":535
            },
            "discountInfo":{
                "orderDiscount":0,
                "shippingDiscount":0,
                "discountDescList":[
                ]
            },
            "shipOnDate":null,
            "trackingInfo":[
            ],
            "actualShipDate":null,
            "siteId":"siteUS",
            "shippingAddress":{
                "lastName":"Anderson",
                "country":"US",
                "address3":null,
                "address2":null,
                "city":"Syracuse",
                "prefix":null,
                "address1":"21 Cedar Ave",
                "postalCode":"13202",
                "companyName":null,
                "jobTitle":null,
                "county":null,
                "suffix":null,
                "selectedCountry":"US",
                "firstName":"Kim",
                "phoneNumber":"212-555-1977",
                "stateName":"New York",
                "faxNumber":null,
                "alias":"Home",
                "middleName":null,
                "state":"NY",
                "countryName":"United States",
                "email":"kim@example.com",
                "selectedState":"NY",
                "state_ISOCode":"US-NY"
            },
            "items":[
                {
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v6155711626513500309/products/doctordolittle_LARGE.jpg&height=100&width=100",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "rawTotalPrice":14.99,
                    "returnedQuantity":0,
                    "displayName":"Dr. Dolittle",
                    "shippingSurchargeValue":0,
                    "discountAmount":0,
                    "externalData":[
                    ],
                    "billingAccountId":"billingAcc-123",
                    "externalPrice":500,
                    "assetId":"asset10001",
                    "price":500,
                    "variant":[
                    ],
                    "onSale":false,
                    "primaryImageAltText":"Dr. Dolittle",
                    "actionCode":"Add",
                    "serviceId":"service-123",
                    "stateDetailsAsUser":"The item has been initialized within the shipping group",
                    "serviceAccountId":"serviceAcc-123",
                    "unitPrice":14.99,
                    "primaryImageTitle":"Dr. Dolittle",
                    "quantity":1,
                    "productId":"Product_18Cxi",
                    "salePrice":0,
                    "detailedItemPriceInfo":[
                        {
                            "discounted":false,
                            "amount":500,
                            "quantity":1,
                            "tax":40,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":500,
                            "currencyCode":"USD"
                        }
                    ],
                    "active":true,
                    "externalPriceQuantity":1,
                    "catRefId":"Sku_18Dxi",
                    "customerAccountId":"customerAcc-123",
                    "discountInfo":[
                    ],
                    "route":"/product/Product_18Cxi",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "listPrice":14.99,
                    "status":"INITIAL"
                }
            ],
            "trackingNumber":null,
            "status":"INITIAL"
        }
    ],
    "approvalSystemMessages":[
        "Order is pending approval because total is greater than the approved order limit."
    ],
    "shippingMethod":{
        "shippingTax":2.8,
        "cost":35,
        "displayName":"Standard",
        "value":"standardShippingMethod",
        "shippingMethodDescription":"Standard"
    },
    "profile":{
        "firstName":"Kim",
        "lastName":"Anderson",
        "middleName":null,
        "email":"kim@example.com"
    },
    "priceListGroup":{
        "repositoryId":"defaultPriceGroup"
    },
    "returnRequests":[
    ],
    "creationDate":"2016-11-09T10:02:41.000Z",
    "discountInfo":{
        "unclaimedCouponMultiPromotions":{
        },
        "orderCouponsMap":{
        },
        "orderDiscount":0,
        "shippingDiscount":0,
        "orderImplicitDiscountList":[
        ],
        "unclaimedCouponsMap":{
        },
        "claimedCouponMultiPromotions":{
        }
    },
    "profileId":"se-570031",
    "exchangeRequests":[
    ],
    "giftWithPurchaseInfo":[
    ],
    "shippingAddress":{
        "lastName":"Anderson",
        "country":"US",
        "address3":null,
        "address2":null,
        "city":"Syracuse",
        "prefix":null,
        "address1":"21 Cedar Ave",
        "postalCode":"13202",
        "companyName":null,
        "jobTitle":null,
        "county":null,
        "suffix":null,
        "selectedCountry":"US",
        "firstName":"Kim",
        "phoneNumber":"212-555-1977",
        "stateName":"New York",
        "faxNumber":null,
        "alias":"Home",
        "middleName":null,
        "state":"NY",
        "countryName":"United States",
        "email":"kim@example.com",
        "selectedState":"NY",
        "state_ISOCode":"US-NY"
    },
    "giftWithPurchaseOrderMarkers":[
    ]
}
Default Response
The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |100094|Organization passed in the header is currently inactive| |100095|The order or return request does not belong to the current organization of the shopper profile| |100096|The organization associated to the order or return request was deleted / does not exist| |100097|The organization associated to the order or return request is currently inactive| |100098|Current operation is being performed in an organization context and the shopper profile is not associated to any organization| |100099|Current operation is being performed in an organization context and the order or return request does not belong to any organization| |28107|If no order is found of the order id which is mentioned in request paylaod.| |200105|No Order id specified in request.| |28315|Error occured while updating the order.| |28364|Error occured when quote is not allowed.| |30015|SiteId passed in x-ccsite header is currently inactive| |30014|SiteId passed in x-ccsite header is invalid or the site was deleted| |30020|The Site to which the order belongs was deleted| |28365|Error occured while rejecting the code.| |28300|Internal error while creating the order| |30021|The Site to which the order belongs is currently inactive| |100101|The shopper profile does not belong to organization passed in the header| |30019|SiteId passed in x-ccsite header is not related to the order being worked upon|
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",
  "id": "o90417"
}

Sample Response Payload returned by endpoint:

{
  "creationTime": 1478685761000,
  "orderComments": [],
  "sourceSystem": "Cloud Commerce",
  "dynamicProperties": [],
  "stateString": "REJECTED_QUOTE",
  "paymentGroups": [],
  "priceInfo": {
    "amount": 500,
    "total": 577.8,
    "shipping": 35,
    "shippingSurchargeValue": 0,
    "tax": 42.8,
    "subTotal": 500,
    "currencyCode": "USD",
    "totalWithoutTax": 535
  },
  "pricingMessages": {},
  "shoppingCart": {"items": [{
    "deactivationDate": "2018-06-27T12:59:59Z",
    "rawTotalPrice": 500,
    "returnedQuantity": 0,
    "displayName": "Dr. Dolittle",
    "shippingSurchargeValue": 0,
    "discountAmount": 0,
    "externalData": [],
    "billingAccountId": "billingAcc-123",
    "imageInfo": {"primaryThumbImageURL": "/ccstore/v1/images/?source=/file/v6155711626513500309/products/doctordolittle_LARGE.jpg&height=100&width=100"},
    "externalPrice": 500,
    "assetId": "asset10001",
    "price": 500,
    "variant": [],
    "onSale": false,
    "actionCode": "Add",
    "serviceId": "service-123",
    "stateDetailsAsUser": "Added to order",
    "serviceAccountId": "serviceAcc-123",
    "unitPrice": 14.99,
    "quantity": 1,
    "productId": "Product_18Cxi",
    "salePrice": 0,
    "detailedItemPriceInfo": [{
      "discounted": false,
      "amount": 500,
      "quantity": 1,
      "tax": 40,
      "orderDiscountShare": 0,
      "detailedUnitPrice": 500,
      "currencyCode": "USD"
    }],
    "giftWithPurchaseCommerceItemMarkers": [],
    "tax": 40,
    "externalPriceQuantity": 1,
    "catRefId": "Sku_18Dxi",
    "customerAccountId": "customerAcc-123",
    "discountInfo": [],
    "stateDescription": "INITIAL",
    "activationDate": "2017-06-27T15:30:00Z",
    "listPrice": 14.99,
    "status": 0
  }]},
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccagentui/v1/orders/quote/reject"
  }],
  "id": "o90419",
  "state": 4005,
  "quoteInfo": {
    "providerNote": null,
    "notes": [
      {
        "profileType": null,
        "profileId": "se-570031",
        "rejectionDate": "2016-11-09T10:14:21.397Z",
        "rejectionNote": "Quote Rejected"
      },
      {
        "profileType": null,
        "profileId": "se-570031",
        "requestDate": "2016-11-09T10:03:16.240Z",
        "requesterNote": "jh"
      }
    ],
    "rejectionDate": "2016-11-09T10:14:21.397Z",
    "requestDate": "2016-11-09T10:03:16.240Z",
    "errorInfo": null,
    "externalId": null,
    "rejectionNote": "Quote Rejected",
    "quoteDate": "2016-11-09T10:13:56.206Z",
    "expirationDate": "2260-11-10T18:56:36.000Z"
  },
  "stateDetailsAsUser": "This quote has been rejected",
  "taxPriceInfo": {
    "cityTax": 0,
    "amount": 42.8,
    "valueAddedTax": 0,
    "countyTax": 21.4,
    "isTaxIncluded": false,
    "miscTax": 0,
    "districtTax": 0,
    "stateTax": 21.4,
    "countryTax": 0
  },
  "shippingGroups": [{
    "taxPriceInfo": {
      "cityTax": 0,
      "amount": 42.8,
      "valueAddedTax": 0,
      "countyTax": 21.4,
      "isTaxIncluded": false,
      "miscTax": 0,
      "districtTax": 0,
      "stateTax": 21.4,
      "countryTax": 0
    },
    "shippingMethod": {
      "shippingTax": 2.8,
      "cost": 35,
      "displayName": "Standard",
      "value": "standardShippingMethod",
      "shippingMethodDescription": "Standard"
    },
    "shippingGroupId": "sg100419",
    "submittedDate": null,
    "priceInfo": {
      "amount": 500,
      "total": 577.8,
      "shipping": 35,
      "shippingSurchargeValue": 0,
      "tax": 42.8,
      "subTotal": 500,
      "currencyCode": "USD",
      "totalWithoutTax": 535
    },
    "discountInfo": {
      "orderDiscount": 0,
      "shippingDiscount": 0,
      "discountDescList": []
    },
    "shipOnDate": null,
    "trackingInfo": [],
    "actualShipDate": null,
    "siteId": "siteUS",
    "shippingAddress": {
      "lastName": "Anderson",
      "country": "US",
      "address3": null,
      "address2": null,
      "city": "Syracuse",
      "prefix": null,
      "address1": "21 Cedar Ave",
      "postalCode": "13202",
      "companyName": null,
      "jobTitle": null,
      "county": null,
      "suffix": null,
      "selectedCountry": "US",
      "firstName": "Kim",
      "phoneNumber": "212-555-1977",
      "stateName": "New York",
      "faxNumber": null,
      "alias": "Home",
      "middleName": null,
      "state": "NY",
      "countryName": "United States",
      "email": "kim@example.com",
      "selectedState": "NY",
      "state_ISOCode": "US-NY"
    },
    "items": [{
      "primaryThumbImageURL": "/ccstore/v1/images/?source=/file/v6155711626513500309/products/doctordolittle_LARGE.jpg&height=100&width=100",
      "deactivationDate": "2018-06-27T12:59:59Z",
      "rawTotalPrice": 14.99,
      "returnedQuantity": 0,
      "displayName": "Dr. Dolittle",
      "shippingSurchargeValue": 0,
      "discountAmount": 0,
      "externalData": [],
      "billingAccountId": "billingAcc-123",
      "externalPrice": 500,
      "assetId": "asset10001",
      "price": 500,
      "variant": [],
      "onSale": false,
      "primaryImageAltText": "Dr. Dolittle",
      "actionCode": "Add",
      "serviceId": "service-123",
      "stateDetailsAsUser": "The item has been initialized within the shipping group",
      "serviceAccountId": "serviceAcc-123",
      "unitPrice": 14.99,
      "primaryImageTitle": "Dr. Dolittle",
      "quantity": 1,
      "productId": "Product_18Cxi",
      "salePrice": 0,
      "detailedItemPriceInfo": [{
        "discounted": false,
        "amount": 500,
        "quantity": 1,
        "tax": 40,
        "orderDiscountShare": 0,
        "detailedUnitPrice": 500,
        "currencyCode": "USD"
      }],
      "active": true,
      "externalPriceQuantity": 1,
      "catRefId": "Sku_18Dxi",
      "customerAccountId": "customerAcc-123",
      "discountInfo": [],
      "route": "/product/Product_18Cxi",
      "activationDate": "2017-06-27T15:30:00Z",
      "listPrice": 14.99,
      "status": "INITIAL"
    }],
    "trackingNumber": null,
    "status": "INITIAL"
  }],
  "approvalSystemMessages": ["Order is pending approval because total is greater than the approved order limit."],
  "shippingMethod": {
    "shippingTax": 2.8,
    "cost": 35,
    "displayName": "Standard",
    "value": "standardShippingMethod",
    "shippingMethodDescription": "Standard"
  },
  "profile": {
    "firstName": "Kim",
    "lastName": "Anderson",
    "middleName": null,
    "email": "kim@example.com"
  },
  "priceListGroup": {"repositoryId": "defaultPriceGroup"},
  "returnRequests": [],
  "creationDate": "2016-11-09T10:02:41.000Z",
  "discountInfo": {
    "unclaimedCouponMultiPromotions": {},
    "orderCouponsMap": {},
    "orderDiscount": 0,
    "shippingDiscount": 0,
    "orderImplicitDiscountList": [],
    "unclaimedCouponsMap": {},
    "claimedCouponMultiPromotions": {}
  },
  "profileId": "se-570031",
  "exchangeRequests": [],
  "giftWithPurchaseInfo": [],
  "shippingAddress": {
    "lastName": "Anderson",
    "country": "US",
    "address3": null,
    "address2": null,
    "city": "Syracuse",
    "prefix": null,
    "address1": "21 Cedar Ave",
    "postalCode": "13202",
    "companyName": null,
    "jobTitle": null,
    "county": null,
    "suffix": null,
    "selectedCountry": "US",
    "firstName": "Kim",
    "phoneNumber": "212-555-1977",
    "stateName": "New York",
    "faxNumber": null,
    "alias": "Home",
    "middleName": null,
    "state": "NY",
    "countryName": "United States",
    "email": "kim@example.com",
    "selectedState": "NY",
    "state_ISOCode": "US-NY"
  },
  "giftWithPurchaseOrderMarkers": []
}