1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Agent
  4. Return Order

updateReturnRequest

put

/ccagent/v1/returnRequests/{id}

Update Return Request. It updates the returnRequest based on the operation value. Operation value can be any of receiveReturns/initiateRefund/adjustRefundAmounts/markManualRefund/markAsComplete. Updates details of items received against a return request with operation set as 'receiveReturns'.Additonally takes x-ccsite header. If the site information is not provided by default it 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 : updateReturnRequest_request
Type: object
Show Source
Example:
{
    "shippingTaxRefund":3,
    "agentId":"service",
    "secondaryCurrencyShippingTaxRefund":0,
    "actualShippingRefund":25,
    "actualTaxRefund":6,
    "otherRefund":0,
    "secondaryCurrencyActualTaxRefund":0,
    "refundMethodList":[
        {
            "refundType":"manualRefund",
            "amount":86,
            "state":"INCOMPLETE"
        }
    ],
    "returnLabel":null,
    "authorizationNumber":"100001",
    "returnFee":0,
    "requestId":"100001",
    "secondaryCurrencyActualShippingRefund":0,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/returnRequests/100001"
        }
    ],
    "appeasementRefundAdjustment":0,
    "state":"FULL_RETURN",
    "additionalProperties":{
        "abc":"123"
    },
    "originOfReturn":"contactCenter",
    "trackingNumber":null,
    "returnItemList":[
        {
            "secondaryCurrencyActualTaxRefundShare":0,
            "comments":"this is comment 112222",
            "shippingGroupId":"sg40412",
            "secondaryCurrencyActualShippingSurchargeRefundShare":0,
            "quantityWithFractionReceived":0,
            "commerceItemId":"ci3000414",
            "secondaryCurrencyActualShippingRefundShare":0,
            "disposition":"acceptedWithRefund",
            "actualShippingSurchargeRefundShare":0,
            "returnReason":"defective",
            "childReturnItems":[
                {
                    "secondaryCurrencyActualTaxRefundShare":0,
                    "comments":"this is comment 334444",
                    "shippingGroupId":"sg40413",
                    "secondaryCurrencyActualShippingSurchargeRefundShare":0,
                    "quantityWithFractionReceived":0,
                    "commerceItemId":"ci3000415",
                    "secondaryCurrencyActualShippingRefundShare":0,
                    "disposition":"rejectedWithRefund",
                    "actualShippingSurchargeRefundShare":0,
                    "returnReason":"defective",
                    "actualShippingRefundShare":0,
                    "state":"RETURNED",
                    "additionalProperties":{
                    },
                    "actualTaxRefundShare":0,
                    "quantityReceived":1,
                    "refundAmount":0
                }
            ],
            "actualShippingRefundShare":25,
            "state":"RETURNED",
            "additionalProperties":{
            },
            "actualTaxRefundShare":6,
            "quantityReceived":1,
            "refundAmount":49.99
        }
    ],
    "actualShippingSurchargeRefund":11,
    "secondaryCurrencyActualShippingSurchargeRefund":0,
    "secondaryCurrencyAppeasementRefundAdjustment":0
}
Nested Schema : additionalProperties
Type: object
Map of Additional properties for return request
Nested Schema : refundMethodList
Type: array
List of refund methods
Show Source
Nested Schema : returnItemList
Type: array
List of returnable Items
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : returnItems_request
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Map of Additional properties for each return item
Nested Schema : childReturnItems
Type: array
List of child return items of this return item
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateReturnRequest_response
Type: object
Show Source
Example:
{
    "shippingTaxRefund":3,
    "agentId":"service",
    "secondaryCurrencyShippingTaxRefund":0,
    "actualShippingRefund":25,
    "actualTaxRefund":6,
    "otherRefund":0,
    "secondaryCurrencyActualTaxRefund":0,
    "refundMethodList":[
        {
            "refundType":"manualRefund",
            "amount":86,
            "state":"INCOMPLETE"
        }
    ],
    "returnLabel":null,
    "authorizationNumber":"100001",
    "returnFee":0,
    "requestId":"100001",
    "secondaryCurrencyActualShippingRefund":0,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/returnRequests/100001"
        }
    ],
    "appeasementRefundAdjustment":0,
    "state":"FULL_RETURN",
    "additionalProperties":{
        "abc":"123"
    },
    "originOfReturn":"contactCenter",
    "trackingNumber":null,
    "returnItemList":[
        {
            "secondaryCurrencyActualTaxRefundShare":0,
            "comments":"this is comment 112222",
            "shippingGroupId":"sg40412",
            "secondaryCurrencyActualShippingSurchargeRefundShare":0,
            "quantityWithFractionReceived":0,
            "commerceItemId":"ci3000414",
            "secondaryCurrencyActualShippingRefundShare":0,
            "disposition":"acceptedWithRefund",
            "actualShippingSurchargeRefundShare":0,
            "returnReason":"defective",
            "childReturnItems":[
                {
                    "secondaryCurrencyActualTaxRefundShare":0,
                    "comments":"this is comment 334444",
                    "shippingGroupId":"sg40413",
                    "secondaryCurrencyActualShippingSurchargeRefundShare":0,
                    "quantityWithFractionReceived":0,
                    "commerceItemId":"ci3000415",
                    "secondaryCurrencyActualShippingRefundShare":0,
                    "disposition":"rejectedWithRefund",
                    "actualShippingSurchargeRefundShare":0,
                    "returnReason":"defective",
                    "actualShippingRefundShare":0,
                    "state":"RETURNED",
                    "additionalProperties":{
                    },
                    "actualTaxRefundShare":0,
                    "quantityReceived":1,
                    "refundAmount":0
                }
            ],
            "actualShippingRefundShare":25,
            "state":"RETURNED",
            "additionalProperties":{
            },
            "actualTaxRefundShare":6,
            "quantityReceived":1,
            "refundAmount":49.99
        }
    ],
    "actualShippingSurchargeRefund":11,
    "secondaryCurrencyActualShippingSurchargeRefund":0,
    "secondaryCurrencyAppeasementRefundAdjustment":0
}
Nested Schema : additionalProperties
Type: object
Map of Additional properties for return request
Nested Schema : refundMethodList
Type: array
List of refund methods
Show Source
Nested Schema : returnItemList
Type: array
List of returnable Items
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : returnItems_response
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Map of Additional properties for each return item
Nested Schema : childReturnItems
Type: array
List of child return items of this return item.
Show Source
Example Response (application/json)
{
    "returnRequestStatus":"Full return",
    "isExchangeRequest":false,
    "returnItems":[
        {
            "quantityReturned":1,
            "deactivationDate":"2018-06-27T12:59:59Z",
            "dynamicProperties":[
                {
                    "id":"ReferralCode",
                    "label":"ReferralCode",
                    "value":null
                },
                {
                    "id":"OfferEndsDate",
                    "label":"OfferEndsDate",
                    "value":"2020-07-02T03:42:42.962Z"
                },
                {
                    "id":"Discount",
                    "label":"Discount",
                    "value":0
                },
                {
                    "id":"GiftWrapping",
                    "label":"Gift Wrapping",
                    "value":false
                },
                {
                    "id":"CustomMessage",
                    "label":"Custom Message",
                    "value":null
                },
                {
                    "id":"name",
                    "label":"Name on product(Mug)",
                    "value":"My name"
                },
                {
                    "id":"ShippingInstructions",
                    "label":"Shipping Instructions",
                    "value":null
                }
            ],
            "displayName":"OM-D E-M10 Digital Compact System Camera",
            "externalData":[
            ],
            "billingProfileId":"billingProfile-123",
            "billingAccountId":"billingAcc-123",
            "childItems":[
                {
                    "serviceAccountId":"serviceAcc-123",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "quantity":2,
                    "productId":"prod10040",
                    "displayName":"Super Smash Brothers Brawl",
                    "externalData":[
                    ],
                    "parentAssetKey":"12345",
                    "billingProfileId":"billingProfile-123",
                    "billingAccountId":"billingAcc-123",
                    "childItems":[
                        {
                            "serviceAccountId":"serviceAcc-123",
                            "deactivationDate":"2018-06-27T12:59:59Z",
                            "quantity":1,
                            "productId":"prod10039",
                            "displayName":"Wii Music",
                            "externalData":[
                            ],
                            "parentAssetKey":"23456",
                            "billingProfileId":"billingProfile-123",
                            "billingAccountId":"billingAcc-123",
                            "rootAssetKey":"12345",
                            "transactionDate":"2018-06-27T12:59:59Z",
                            "catRefId":"sku10049",
                            "assetKey":"34567",
                            "route":"product/prod10039",
                            "customerAccountId":"customerAcc-123",
                            "selectedOptions":[
                            ],
                            "actionCode":"Add",
                            "activationDate":"2017-06-27T15:30:00Z",
                            "serviceId":"service-123",
                            "asset":false
                        }
                    ],
                    "rootAssetKey":"12345",
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "catRefId":"sku10041",
                    "assetKey":"84848",
                    "route":"product/prod10040",
                    "customerAccountId":"customerAcc-123",
                    "selectedOptions":[
                    ],
                    "actionCode":"Add",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123",
                    "asset":false
                },
                {
                    "serviceAccountId":"serviceAcc-123",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "quantity":1,
                    "productId":"prod10038",
                    "displayName":"Wii Music",
                    "externalData":[
                    ],
                    "parentAssetKey":"12345",
                    "billingProfileId":"billingProfile-123",
                    "billingAccountId":"billingAcc-123",
                    "rootAssetKey":"12345",
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "catRefId":"sku10042",
                    "assetKey":"93754",
                    "route":"product/prod10038",
                    "customerAccountId":"customerAcc-123",
                    "selectedOptions":[
                    ],
                    "actionCode":"Add",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123",
                    "asset":false
                }
            ],
            "configuratorId":"12345677",
            "skuOptionInfo":[
                {
                    "optionValue":"Tan",
                    "optionName":"color"
                },
                {
                    "optionValue":"30.8-megapixels",
                    "optionName":"resolution"
                }
            ],
            "assetKey":"12345",
            "quantityAvailableForReturn":0,
            "commerceItemId":"ci9000467",
            "suggestedShippingRefund":35,
            "price":200,
            "returnReason":"Incorrect Item",
            "actionCode":"Add",
            "promotionAdjustments":[
            ],
            "serviceId":"service-123",
            "quantityReceived":1,
            "dispositionReason":{
                "displayKey":"acceptedWithRefund",
                "displayName":"Accepted With Refund"
            },
            "serviceAccountId":"serviceAcc-123",
            "unitPrice":200,
            "quantityToReturn":1,
            "comments":null,
            "productId":"camera_1",
            "returnItemId":"100003",
            "quantityToReceive":0,
            "shippingGroupId":"sg80417",
            "suggestedTaxRefund":23.31,
            "parentAssetKey":null,
            "rootAssetKey":null,
            "transactionDate":"2018-06-27T12:59:59Z",
            "catRefId":"camerasku_1_5",
            "skuProperties":[
                {
                    "propertyType":"sku-base",
                    "name":"Name",
                    "id":"displayName",
                    "value":null
                },
                {
                    "propertyType":"sku-base",
                    "name":"Id",
                    "id":"id",
                    "value":"camerasku_1_1"
                },
                {
                    "propertyType":"sku-custom",
                    "name":"dynamicskuprop1",
                    "id":"dynamicskuprop1",
                    "value":"dynamicskuprop1"
                }
            ],
            "customerAccountId":"customerAcc-123",
            "quantityShipped":1,
            "adjustedPromotionReferences":"",
            "additionalProperties":{
                "property2":"tag",
                "property":"display"
            },
            "activationDate":"2017-06-27T15:30:00Z",
            "asset":false,
            "actualRefundAmount":200,
            "suggestedRefundAmount":200
        }
    ],
    "returnLabel":"return label 1",
    "isManuallyAdjusted":false,
    "orderInfo":{
        "originOfOrder":"contactCenter",
        "priceInfo":{
            "total":256.31,
            "amount":198,
            "shipping":35,
            "isTaxIncluded":false,
            "tax":23.31,
            "subTotal":200,
            "orderDiscountAmount":2,
            "currencyCode":"USD",
            "totalWithoutTax":189.9
        },
        "recurringChargePriceInfo":{
            "amount":20,
            "total":20,
            "shipping":0,
            "subTotalByFrequency":[
                {
                    "amount":20,
                    "frequency":"Monthly"
                }
            ],
            "taxByFrequency":[
                {
                    "amount":0,
                    "frequency":"Monthly"
                }
            ],
            "tax":0,
            "subTotal":20,
            "currencyCode":"USD",
            "totalWithoutTax":20
        },
        "orderId":"o10423",
        "siteId":"siteUS",
        "creationDate":"2015-03-27 15:53:01.0",
        "submittedDate":"2015-03-27 15:54:01.0"
    },
    "refundInfo":{
        "refundDue":256.31,
        "suggestedShippingRefund":35,
        "returnFee":0,
        "suggestedOrderRefund":200,
        "suggestedTaxRefund":23.31,
        "suggestedTotalRefund":256.31,
        "appeasementRefundAdjustment":0,
        "actualShippingRefund":35,
        "actualTaxRefund":23.31,
        "otherRefund":0,
        "secondaryCurrencyAppeasementRefundAdjustment":0
    },
    "isSetteled":false,
    "promotionAdjustments":{
        "promotionAdjustmentsCount":1,
        "orderPromotionValueAdjustments":[
            {
                "adjustedAmount":2,
                "promotionAdjustmentType":"Removed",
                "promotionDesc":"Order Discount - SAVE$2ON20 - Coupon",
                "couponCode":"SAVE2ON20",
                "promotionId":"explicitOrderDiscount2on20"
            }
        ],
        "totalOrderDiscountAdjustment":2,
        "nonReturnItemCostAdjustment":[
        ],
        "itemPromotionValueAdjustments":[
        ],
        "manyToManyPromotionCouponAdjustment":{
            "SAVE2ON20":[
                {
                    "adjustedAmount":2,
                    "promotionAdjustmentType":"Removed",
                    "promotionDesc":"Order Discount - SAVE$2ON20 - Coupon",
                    "promotionId":"explicitOrderDiscount2on20"
                }
            ]
        }
    },
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/returnRequests/100003"
        }
    ],
    "additionalProperties":{
        "property2":"tag",
        "property":"display"
    },
    "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"
    },
    "trackingNumber":[
        "http://localhost:9080/trackingNumber",
        "http://localhost:9080/trackingNumber2"
    ],
    "paymentReversalInfo":{
        "creditCardInfo":{
            "cardNumber":"xxxxxxxxxxxx1111"
        },
        "reversalMethod":"Card Payment Reversal"
    }
}

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| |200219|{0} is an inactive reason.| |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| |200127|Internal error occurred.| |200218|{0} is an invalid reason.| |200126|Invalid Input Parameter.| |200125|Input passed in is null.| |200131|Return Request Id passed in is null.| |200132|Return Request is not in pending refund state.| |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| |200145|Refund amount cannot exceed payment group's amount.(Payment Group Type: {0}, Payment Group Id: {1})|
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