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

approveOrder

post

/ccstore/v1/orders/approve

Approve Order. Approver approves an order. Optionally takes the x-ccasset-language headers to get translated content in another language. Also it can have optional X-CCOrganization header which is a JSON field to specify current Organization context of logged in user.

Request

Supported Media Types
Header Parameters
Body ()
Root Schema : approveOrder_request
Type: object
Show Source
Example:
{
    "approverMessage":"Approving order",
    "orderId":"o30411",
    "ignorePriceWarnings":true
}
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : approveOrder_response
Type: object
Show Source
Nested Schema : approvalSystemMessages
Type: array
An array of approval messages when order going in pending approval state
Show Source
Nested Schema : approverMessages
Type: array
An array of approval messages when approver approving order
Show Source
Nested Schema : approvers
Type: array
List of approvers of the organization.
Show Source
Nested Schema : billingAddress
Type: object
The billing address details.
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 : giftWithPurchaseInfo
Type: array
The gift information.
Show Source
Nested Schema : giftWithPurchaseOrderMarkers
Type: array
gift with purchase order marker information
Show Source
Nested Schema : payments
Type: array
Payment details for the order, including additional properties specific to the payment type.
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 : scheduledOrder
Type: array
schedule order 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/order
Type: object
The shopping-cart or order contents of the current order.
Show Source
Nested Schema : trackingInfo
Type: array
Tracking Information for the Order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : claimedCouponMultiPromotions
Type: object
The coupons that were claimed
Show Source
Nested Schema : orderCouponsMap
Type: array
The list of all the coupons with the order.
Show Source
Nested Schema : orderImplicitDiscountList
Type: array
The implicit order discounts with the order.
Show Source
Nested Schema : unclaimedCouponMultiPromotions
Type: object
The coupons that were not claimed
Show Source
Nested Schema : unclaimedCouponsMap
Type: object
The unclaimed coupons with the order.
Show Source
Nested Schema : coupon code
Type: array
Coupon Code, corresponding to which promotions were applied
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 : coupon code
Type: array
Coupon Code, corresponding to which some promotions were not applied
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coupon code
Type: array
Coupon Code, corresponding to which some promotions were not applied
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
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 : clonedOrders
Type: array
list of orders that is created using this as template.
Show Source
Nested Schema : executionStatusList
Type: array
list of orders with status that are placed with this schedule.
Show Source
Nested Schema : lastError
Type: object
last error of this scheduled order.
Show Source
Nested Schema : schedule
Type: object
schedule details for the schedule.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : errorMessages
Type: array
The error messages list.
Show Source
Nested Schema : errorMessages
Type: array
An array of error messages
Show Source
Nested Schema : daysInMonth
Type: array
mention which days of Month schedule should run. values can be 1 to 31.
Show Source
Nested Schema : daysOfWeek
Type: array
mention which days of week schedule should run. values can be 1 to 7.
Show Source
Nested Schema : monthsInYear
Type: array
The months in year of the Scheduled order. Values can be 0 to 11.
Show Source
Nested Schema : weeksInMonth
Type: array
The weeks in month of the Scheduled order.Values can be 1 to 5
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : discountInfo
Type: object
The shipping group price information.
Show Source
Nested Schema : items
Type: array
The array of products in the shipping group.
Show Source
Nested Schema : priceInfo
Type: object
The shipping group 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.
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 : taxPriceInfo
Type: object
The shipping tax price info details.
Show Source
Nested Schema : discountDescList
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 : detailedItemPriceInfo
Type: object
Detailed Item Price Information.
Show Source
Nested Schema : detailedRecurringChargeInfo
Type: object
Detailed Item Price 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 : 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 : 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 : giftWithPurchaseCommerceItemMarkers
Type: array
The array of giftWithPurchaseCommerceItemMarkers.
Show Source
Nested Schema : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
Nested Schema : variant
Type: array
List of variants for the product.
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 : shopperInput
Type: object
Additional Properties Allowed
Show Source
Map of shopper input keys to values
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 : giftWithPurchaseDiscountInfo
Type: array
The gift information.
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: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "creationTime":1.428563503E12,
    "dynamicProperties":[
        {
            "id":"dynamicPropertyShippingInstructions",
            "label":"Shipping Instructions",
            "value":"Test Instructions"
        }
    ],
    "payments":[
        {
            "paymentGroupId":"pg30411",
            "PONumber":null,
            "amount":78.67,
            "gatewayName":"invoiceGateway",
            "uiIntervention":null,
            "paymentMethod":"invoiceRequest",
            "isAmountRemaining":true,
            "paymentState":"INITIAL"
        }
    ],
    "orderStatus":"Pending payment",
    "approvers":[
        {
            "firstName":"Peter",
            "lastName":"Grun",
            "approverId":"bb-110020"
        }
    ],
    "submittedDate":"2015-04-09T07:21:43.000Z",
    "uuid":"a15543c2-a44f-4640-8ac4-674c594efc85",
    "priceInfo":{
        "amount":52,
        "total":62.6,
        "shipping":6.5,
        "shippingSurchargeValue":20,
        "tax":4.1,
        "subTotal":52,
        "currencyCode":"USD"
    },
    "links":[
        {
            "rel":"self",
            "href":"http://www.example.com/ccstoreui/v1/orders/approve"
        }
    ],
    "id":"o10004",
    "state":"PENDING_PAYMENT",
    "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
    },
    "order":{
        "numberOfItems":1,
        "items":[
            {
                "primaryThumbImageURL":"/ccstoreui/v1/images/?source=http://www.example.com/file/products/APP_CowboyShirt_full.jpg&height=100&width=100",
                "deactivationDate":"2018-06-27T12:59:59Z",
                "rawTotalPrice":52,
                "displayName":"Cowboy Shirt",
                "dynamicProperties":[
                    {
                        "id":"dynamicPropertyMode",
                        "label":"Mode",
                        "value":"pickup"
                    }
                ],
                "externalData":[
                ],
                "billingProfileId":"billingProfile-123",
                "billingAccountId":"billingAcc-123",
                "assetKey":"12345",
                "price":52,
                "variant":[
                    {
                        "optionValue":"Blue",
                        "optionName":"Color"
                    },
                    {
                        "optionValue":"Medium",
                        "optionName":"Size"
                    }
                ],
                "actionCode":"Add",
                "serviceId":"service-123",
                "unitPrice":52,
                "serviceAccountId":"serviceAcc-123",
                "quantity":1,
                "productId":"prod10002",
                "externalRecurringCharge":10,
                "giftWithPurchaseCommerceItemMarkers":[
                ],
                "active":true,
                "parentAssetKey":null,
                "rootAssetKey":null,
                "externalRecurringChargeFrequency":"Monthly",
                "transactionDate":"2018-06-27T12:59:59Z",
                "catRefId":"sku40087",
                "externalRecurringChargeDuration":"12",
                "customerAccountId":"customerAcc-123",
                "discountInfo":[
                ],
                "route":"/cowboy-shirt/product/prod10002",
                "detailedRecurringChargeInfo":[
                    {
                        "discounted":false,
                        "amount":10,
                        "quantity":1,
                        "tax":0,
                        "orderDiscountShare":0,
                        "detailedUnitPrice":10,
                        "currencyCode":"USD"
                    }
                ],
                "shopperInput":{
                    "color":"neon",
                    "initials":"M.C.K",
                    "font":"courier"
                },
                "activationDate":"2017-06-27T15:30:00Z",
                "asset":false,
                "recurringCharge":10
            }
        ]
    },
    "shippingGroup":{
        "shippingMethodDescription":"Ground"
    },
    "shippingGroups":[
        {
            "taxPriceInfo":{
                "cityTax":0,
                "amount":4.1,
                "valueAddedTax":0,
                "countyTax":1.76,
                "isTaxIncluded":false,
                "miscTax":0,
                "districtTax":0,
                "stateTax":2.34,
                "countryTax":0
            },
            "shippingMethod":{
                "shippingTax":0.46,
                "cost":6.5,
                "value":"ground",
                "shippingMethodDescription":"Ground"
            },
            "shippingGroupId":"sg10032",
            "submittedDate":null,
            "priceInfo":{
                "amount":52,
                "total":62.6,
                "shipping":6.5,
                "shippingSurchargeValue":0,
                "tax":4.1,
                "subTotal":52,
                "currencyCode":"USD",
                "totalWithoutTax":58.5
            },
            "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":"a",
                "country":"US",
                "address3":"",
                "address2":"a",
                "city":"a",
                "address1":"a",
                "prefix":"",
                "companyName":"",
                "postalCode":"30005",
                "jobTitle":"",
                "county":"",
                "suffix":"",
                "firstName":"a",
                "phoneNumber":"5675675678",
                "alias":"Address##0",
                "faxNumber":"",
                "middleName":"",
                "state":"GA",
                "email":"a@example.com"
            },
            "trackingNumber":null,
            "items":[
                {
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=/file/v2/products/APP_CowboyShirt_full.jpg&height=100&width=100",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "rawTotalPrice":52,
                    "returnedQuantity":0,
                    "dynamicProperties":[
                        {
                            "id":"dynamicPropertyMode",
                            "label":"Mode",
                            "value":"pickup"
                        }
                    ],
                    "displayName":"Cowboy Shirt",
                    "shippingSurchargeValue":0,
                    "discountAmount":0,
                    "externalData":[
                    ],
                    "billingProfileId":"billingProfile-123",
                    "billingAccountId":"billingAcc-123",
                    "assetKey":"12345",
                    "commerceItemId":"ci3000411",
                    "price":52,
                    "variant":[
                        {
                            "optionValue":"Blue",
                            "optionName":"Color"
                        },
                        {
                            "optionValue":"Medium",
                            "optionName":"Size"
                        }
                    ],
                    "onSale":false,
                    "primaryImageAltText":"Cowboy Shirt",
                    "actionCode":"Add",
                    "serviceId":"service-123",
                    "stateDetailsAsUser":"The item has been initialized within the shipping group",
                    "serviceAccountId":"serviceAcc-123",
                    "unitPrice":52,
                    "primaryImageTitle":"Cowboy Shirt",
                    "quantity":1,
                    "pointOfNoRevision":false,
                    "relationshipType":"SHIPPINGQUANTITY",
                    "productId":"prod10002",
                    "salePrice":0,
                    "detailedItemPriceInfo":[
                        {
                            "discounted":false,
                            "amount":52,
                            "quantity":1,
                            "tax":3.64,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":52,
                            "currencyCode":"USD"
                        }
                    ],
                    "externalRecurringCharge":10,
                    "parentAssetKey":null,
                    "active":true,
                    "rootAssetKey":null,
                    "externalRecurringChargeFrequency":"Monthly",
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "externalRecurringChargeDuration":"12",
                    "catRefId":"sku40087",
                    "customerAccountId":"customerAcc-123",
                    "discountInfo":[
                    ],
                    "route":"/cowboy-shirt/product/prod10002",
                    "detailedRecurringChargeInfo":[
                        {
                            "discounted":false,
                            "amount":10,
                            "quantity":1,
                            "tax":0,
                            "orderDiscountShare":0,
                            "detailedUnitPrice":10,
                            "currencyCode":"USD"
                        }
                    ],
                    "activationDate":"2017-06-27T15:30:00Z",
                    "asset":false,
                    "listPrice":52,
                    "recurringCharge":10,
                    "status":"INITIAL"
                }
            ],
            "status":"INITIAL"
        }
    ],
    "lastModifiedDate":"2015-04-09T07:21:43.000Z",
    "approvalSystemMessages":[
        "Order is pending approval because total is greater than the approved order limit."
    ],
    "shippingMethod":{
        "cost":6.5,
        "value":"ground"
    },
    "approverMessages":[
        "I am approving this order"
    ],
    "priceListGroup":{
        "repositoryId":"UsDollar"
    },
    "cartName":"My New Cart",
    "creationDate":"2015-04-09T07:11:43.000Z",
    "orderProfileId":"120029",
    "orderAction":"order",
    "paymentGroupId":"pg10004",
    "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":{
        "unclaimedCouponMultiPromotions":{
            "coupon2":[
                {
                    "promotionLevel":"order",
                    "promotionDesc":"promo4",
                    "promotionId":"promo20004"
                }
            ]
        },
        "orderCouponsMap":{
            "coupon1":{
                "promotionLevel":"order",
                "totalAdjustment":-1,
                "promotionDesc":"promo1",
                "promotionId":"promo20001"
            },
            "coupon2":{
                "promotionLevel":"order",
                "totalAdjustment":-1,
                "promotionDesc":"promo2",
                "promotionId":"promo20002"
            }
        },
        "orderDiscount":0,
        "shippingDiscount":0,
        "orderImplicitDiscountList":[
            {
                "promotionLevel":"item",
                "totalAdjustment":"-0.66",
                "promotionDesc":"Implicit Item Discount - 3PercentOff",
                "promotionId":"implicitItemPercentDiscount"
            }
        ],
        "claimedCouponMultiPromotions":{
            "coupon1":[
                {
                    "promotionLevel":"order",
                    "totalAdjustment":-1,
                    "promotionDesc":"promo1",
                    "promotionId":"promo20001"
                },
                {
                    "promotionLevel":"order",
                    "totalAdjustment":-1,
                    "promotionDesc":"promo3",
                    "promotionId":"promo20003"
                }
            ],
            "coupon2":[
                {
                    "promotionLevel":"order",
                    "totalAdjustment":-1,
                    "promotionDesc":"promo2",
                    "promotionId":"promo20002"
                }
            ]
        },
        "unclaimedCouponsMap":{
            "coupon2":{
                "promotionLevel":"order",
                "promotionDesc":"promo4",
                "promotionId":"promo20004"
            }
        }
    },
    "trackingInfo":[
        {
            "carrierName":"OnTrac",
            "carrierUrl":"http://www.ontrac.com/trackingdetail.asp?tracking=1224",
            "carrierId":"OnTrac",
            "trackingNumber":"1224"
        }
    ],
    "orderLocale":"en",
    "shippingAddress":{
        "lastName":"a",
        "country":"US",
        "address3":null,
        "address2":"a",
        "city":"a",
        "address1":"a",
        "prefix":null,
        "companyName":null,
        "postalCode":"30005",
        "jobTitle":null,
        "county":null,
        "suffix":null,
        "firstName":"a",
        "phoneNumber":"5675675678",
        "faxNumber":null,
        "alias":null,
        "middleName":null,
        "state":"GA",
        "email":"a@example.com"
    },
    "billingAddress":{
        "lastName":"a",
        "country":"US",
        "address3":null,
        "address2":"a",
        "city":"a",
        "address1":"a",
        "prefix":null,
        "companyName":null,
        "postalCode":"30005",
        "jobTitle":null,
        "county":null,
        "suffix":null,
        "firstName":"a",
        "phoneNumber":"5675675678",
        "faxNumber":null,
        "alias":null,
        "middleName":null,
        "state":"GA",
        "email":"a@example.com"
    },
    "giftWithPurchaseOrderMarkers":[
        {
            "quantity":1,
            "selectedQuantity":0,
            "removedQuantity":0,
            "data":"-1275480226",
            "automaticQuantity":0,
            "giftType":"product",
            "autoRemove":true,
            "giftDetail":"camera_1",
            "repositoryId":"200001",
            "failedQuantity":0,
            "value":"promo10002",
            "targetedQuantity":0,
            "key":"atg.gwp"
        }
    ]
}

Default Response

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