submitOrderAmendment

put

/ccagent/v1/orderAmendments/{orderId}

Submit Order Amendment. Applies the changes made during amend process to the order.Additonally takes x-ccsite header to submit the edited order in a site. If the site information is not provided takes the order site. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
Root Schema : submitOrderAmendment_request
Show Source
Example:
PUT v1/ccagent/v1/orderAmendments/o10411
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : submitOrderAmendment_response
Type: object
Show Source
Nested Schema : approvalSystemMessages
Type: array
The array of messages which are stored during order processing
Show Source
Nested Schema : discountInfo
Type: object
Discount information.
Show Source
Nested Schema : orderComments
Type: array
The list of all logged comments for the order.
Show Source
Nested Schema : paymentGroup
Type: object
Payment Group for the order.
Show Source
Nested Schema : paymentGroups
Type: array
List of payment Groups for the order.
Show Source
Nested Schema : priceInfo
Type: object
Price information of the order.
Show Source
Nested Schema : profile
Type: object
Profile Information for the order.
Show Source
Nested Schema : quoteInfo
Type: object
the quote information of the order
Show Source
Nested Schema : returnRequests
Type: array
The list of the requests raised for the order.
Show Source
Nested Schema : shippingAddress
Type: object
shipping address for the order.
Show Source
Nested Schema : shippingGroups
Type: array
List of shipping groups for the order.
Show Source
Nested Schema : shippingMethod
Type: object
Shipping method information.
Show Source
Nested Schema : shoppingCart
Type: object
Shopping cart information.
Show Source
Nested Schema : taxPriceInfo
Type: object
The tax pricing details for the order.
Show Source
Nested Schema : claimedCouponMultiPromotions
Type: object
The coupons that were claimed
Show Source
Nested Schema : orderCouponsMap
Type: array
Map of coupons.
Show Source
Nested Schema : orderImplicitDiscountList
Type: array
List of discounts.
Show Source
Nested Schema : unclaimedCouponMultiPromotions
Type: object
The coupons that were not claimed
Show Source
Nested Schema : unclaimedCouponsMap
Type: array
Map of unclaimed coupons.
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 : items
Type: object
Show Source
Nested Schema : couonInfo
Type: array
The couopn Info
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
Billing address for the order.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : billingAddress
Type: object
Billing address for the order.
Show Source
Nested Schema : errorInfo
Type: array
the array of errors, if any
Show Source
Nested Schema : notes
Type: array
the notes (history) for the order
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : priceInfo
Type: object
Price information of the order.
Show Source
Nested Schema : pricingMessages
Type: object
The Pricing messages information.
Show Source
Nested Schema : shippingAddress
Type: object
shipping address for the order.
Show Source
Nested Schema : shippingMethod
Type: object
Shipping method information.
Show Source
Nested Schema : taxPriceInfo
Type: object
The tax pricing details for the order.
Show Source
Nested Schema : trackingInfo
Type: array
Tracking Information for the Order
Show Source
Nested Schema : promotionUpsellMessages
Type: array
The promotion upsell messages.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : tags
Type: array
The tags the promotion upsell message is associated with.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: array
Items in the cart.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Child items of the commerce item
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : imageInfo
Type: object
The image information.
Show Source
Nested Schema : variant
Type: array
Sku Information
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Child items of the commerce item
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : selectedOptions
Type: array
Child Product Variant Information.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Show Source
Nested Schema : selectedOptions
Type: array
Child Product Variant Information.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "totalAmountAuthorized":124.18,
    "orderComments":[
    ],
    "creationTime":1.44766699E12,
    "submittedDate":"2015-07-15T09:10:15.000Z",
    "paymentGroups":[
        {
            "lastName":"Anderson",
            "amountAuthorized":124.18,
            "amount":124.18,
            "totalDue":124.18,
            "cardType":null,
            "type":"card",
            "token":"9997000108950573",
            "paymentGroupId":"pg30411",
            "firstName":"Kim",
            "paymentStateDetailsAsUser":"The authorization succeeded",
            "uiIntervention":"sop",
            "billingAddress":{
                "lastName":"Anderson",
                "country":"US",
                "address3":null,
                "address2":null,
                "city":"Syracuse",
                "address1":"21 Cedar Ave",
                "prefix":null,
                "companyName":null,
                "postalCode":"13202",
                "jobTitle":null,
                "county":null,
                "suffix":null,
                "firstName":"Kim",
                "phoneNumber":"212-555-1977",
                "stateName":"New York",
                "faxNumber":null,
                "middleName":null,
                "countryName":"United States",
                "state":"NY",
                "email":"kim@example.com"
            },
            "paymentState":1,
            "paidAmount":0,
            "cardNumber":"xxxxxxxxxxxx1111",
            "refundAmount":0
        }
    ],
    "priceInfo":{
        "amount":89.98,
        "total":124.18,
        "shipping":25,
        "shippingSurchargeValue":0,
        "tax":9.2,
        "subTotal":89.98,
        "currencyCode":"USD",
        "totalWithoutTax":114.98
    },
    "pricingMessages":{
        "promotionUpsellMessages":[
            {
                "text":"Spend $20 more get free shipping!",
                "tags":[
                    "CART_UPSELL"
                ]
            },
            {
                "text":"You have qualified for a free Sports DVD!",
                "tags":[
                    "BANNER_UPSELL",
                    "CART_UPSELL"
                ]
            }
        ]
    },
    "paymentGroup":{
        "lastName":"Anderson",
        "amountAuthorized":124.18,
        "amount":124.18,
        "totalDue":124.18,
        "cardType":null,
        "type":"card",
        "token":"9997000108950573",
        "paymentGroupId":"pg30411",
        "firstName":"Kim",
        "paymentStateDetailsAsUser":"The authorization succeeded",
        "uiIntervention":"sop",
        "billingAddress":{
            "lastName":"Anderson",
            "country":"US",
            "address3":null,
            "address2":null,
            "city":"Syracuse",
            "address1":"21 Cedar Ave",
            "prefix":null,
            "companyName":null,
            "postalCode":"13202",
            "jobTitle":null,
            "county":null,
            "suffix":null,
            "firstName":"Kim",
            "phoneNumber":"212-555-1977",
            "stateName":"New York",
            "faxNumber":null,
            "middleName":null,
            "countryName":"United States",
            "state":"NY",
            "email":"kim@example.com"
        },
        "paymentState":1,
        "paidAmount":0,
        "cardNumber":"xxxxxxxxxxxx1111",
        "refundAmount":0
    },
    "shoppingCart":{
        "items":[
            {
                "deactivationDate":"2018-06-27T12:59:59Z",
                "rawTotalPrice":39.99,
                "returnedQuantity":0,
                "displayName":"Fable II",
                "shippingSurchargeValue":0,
                "externalData":[
                ],
                "billingProfileId":"billingProfile-123",
                "billingAccountId":"billingAcc-123",
                "imageInfo":{
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/fableIIxbox_LARGE.jpg&height=100&width=100"
                },
                "childItems":[
                    {
                        "commerceItemId":"ci19000424",
                        "configurationOptionId":"co40001",
                        "quantity":1,
                        "route":"/intel-pentium-dual-core/product/prod40001",
                        "productId":"prod40001",
                        "displayName":"Intel Pentium Dual Core",
                        "isAddOnItem":true,
                        "selectedOptions":[
                        ],
                        "externalData":[
                        ],
                        "actionCode":"Add",
                        "configurablePropertyId":"cp40001",
                        "catRefId":"sku40001"
                    },
                    {
                        "serviceAccountId":"serviceAcc-123",
                        "deactivationDate":"2018-06-27T12:59:59Z",
                        "quantity":1,
                        "productId":"prod40007",
                        "displayName":"8 GB Kingston Sodimm DDR3 1600MHz",
                        "isAddOnItem":false,
                        "externalData":[
                        ],
                        "parentAssetKey":null,
                        "billingProfileId":"billingProfile-123",
                        "billingAccountId":"billingAcc-123",
                        "childItems":[
                            {
                                "quantity":1,
                                "route":"/intel-pentium-dual-core/product/prod40009",
                                "productId":"prod40009",
                                "displayName":"Intel Pentium i9",
                                "selectedOptions":[
                                ],
                                "externalData":[
                                ],
                                "actionCode":"Add",
                                "catRefId":"sku40009"
                            }
                        ],
                        "rootAssetKey":null,
                        "transactionDate":"2018-06-27T12:59:59Z",
                        "catRefId":"sku40007",
                        "assetKey":null,
                        "commerceItemId":"ci19000425",
                        "route":"/8-gb-kingston-sodimm-ddr3-1600mhz/product/prod40007",
                        "customerAccountId":"customerAcc-123",
                        "assetId":"asset10001",
                        "selectedOptions":[
                        ],
                        "actionCode":"Add",
                        "activationDate":"2017-06-27T15:30:00Z",
                        "serviceId":"service-123",
                        "asset":false
                    }
                ],
                "configuratorId":"36379716",
                "assetKey":null,
                "commerceItemId":"ci1000785",
                "assetId":"asset10001",
                "price":39.99,
                "variant":[
                ],
                "onSale":"true",
                "actionCode":"Add",
                "serviceId":"service-123",
                "stateDetailsAsUser":"The item has been initialized",
                "unitPrice":39.99,
                "serviceAccountId":"serviceAcc-123",
                "quantity":1,
                "productId":"prod10041",
                "parentAssetKey":null,
                "tax":4.08,
                "rootAssetKey":null,
                "transactionDate":"2018-06-27T12:59:59Z",
                "catRefId":"sku10045",
                "customerAccountId":"customerAcc-123",
                "discountInfo":[
                ],
                "activationDate":"2017-06-27T15:30:00Z",
                "asset":false,
                "listPrice":39.99,
                "status":0
            },
            {
                "unitPrice":49.99,
                "quantity":1,
                "productId":"Product_21Cxi",
                "rawTotalPrice":49.99,
                "returnedQuantity":0,
                "displayName":"Dora the Explorer - Season 1",
                "shippingSurchargeValue":0,
                "imageInfo":{
                    "primaryThumbImageURL":"/ccstore/v1/images/?source=http://localhost:9080/file/products/doratheexplorer_season1_LARGE.jpg&height=100&width=100"
                },
                "tax":5.11,
                "catRefId":"Sku_21Dxy",
                "discountInfo":[
                ],
                "price":49.99,
                "variant":[
                ],
                "stateDetailsAsUser":"The item has been initialized",
                "listPrice":49.99,
                "status":0
            }
        ]
    },
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagent/v1/orderAmendments/o10411"
        }
    ],
    "state":1,
    "id":"o10411",
    "quoteInfo":{
        "providerNote":null,
        "notes":[
            {
                "providerDate":"2016-11-25T13:33:48.000Z",
                "providerNote":"The quote is approved as per the request",
                "profileType":null,
                "profileId":"se-570031"
            },
            {
                "profileType":null,
                "profileId":"se-570031",
                "requestDate":"2016-10-25T13:33:48.000Z",
                "requesterNote":"provide 10 percent off on the total quantity"
            }
        ],
        "rejectionDate":null,
        "requestDate":"2016-10-25T13:33:48.000Z",
        "errorInfo":null,
        "externalID":null,
        "rejectionNote":null,
        "quoteDate":"2016-10-25T13:35:32.000Z",
        "expirationDate":"2026-04-28T18:53:48.000Z"
    },
    "stateDetailsAsUser":"Submitted to fulfillment",
    "taxPriceInfo":{
        "cityTax":0,
        "amount":9.2,
        "valueAddedTax":0,
        "countyTax":4.6,
        "isTaxIncluded":false,
        "miscTax":0,
        "districtTax":0,
        "stateTax":4.6,
        "countryTax":0
    },
    "shippingGroups":[
        {
            "trackingInfo":[
            ],
            "shippingMethod":{
                "cost":25,
                "displayName":"Standard",
                "value":"standardShippingMethod"
            },
            "shippingAddress":{
                "lastName":"Anderson",
                "country":"US",
                "address3":null,
                "address2":null,
                "city":"Syracuse",
                "address1":"21 Cedar Ave",
                "prefix":null,
                "companyName":null,
                "postalCode":"13202",
                "jobTitle":null,
                "county":null,
                "suffix":null,
                "firstName":"Kim",
                "phoneNumber":"212-555-1977",
                "stateName":"New York",
                "faxNumber":null,
                "middleName":null,
                "countryName":"United States",
                "state":"NY",
                "email":"kim@example.com"
            },
            "trackingNumber":null
        }
    ],
    "approvalSystemMessages":[
    ],
    "shippingMethod":{
        "cost":25,
        "displayName":"Standard",
        "value":"standardShippingMethod"
    },
    "profile":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "middleName":null,
        "email":"kim@example.com"
    },
    "returnRequests":[
    ],
    "creationDate":"2015-07-15T09:09:15.000Z",
    "originOfOrder":"contactCenter",
    "discountInfo":{
        "unclaimedCouponMultiPromotions":{
        },
        "orderCouponsMap":{
        },
        "orderDiscount":0,
        "shippingDiscount":0,
        "orderImplicitDiscountList":[
        ],
        "unclaimedCouponsMap":{
        },
        "claimedCouponMultiPromotions":{
        }
    },
    "profileId":"se-570031",
    "exchangeRequests":[
    ],
    "shippingAddress":{
        "lastName":"Anderson",
        "country":"US",
        "address3":null,
        "address2":null,
        "city":"Syracuse",
        "address1":"21 Cedar Ave",
        "prefix":null,
        "companyName":null,
        "postalCode":"13202",
        "jobTitle":null,
        "county":null,
        "suffix":null,
        "firstName":"Kim",
        "phoneNumber":"212-555-1977",
        "stateName":"New York",
        "faxNumber":null,
        "middleName":null,
        "countryName":"United States",
        "state":"NY",
        "email":"kim@example.com"
    }
}

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| |200105|Order id passed is null or empty| |200119|Internal error occurred| |200113|Internal error occurred| |20107|Specified order does not exist| |200120|Edit not initiated for the order| |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| |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| |28410|The structure of add-ons defined for the order is invalid| |28329|One of the dynamic properties is not writable by the Agent user|
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