updateReturnRequest
put
/ccadmin/v1/returnRequests/{id}
Updates return request. NOTE: In case of any updates to any amount related fields, corresponding amount at refund method level in return request and amount at payment group level in original order should also be updated.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the return request.
Root Schema : updateReturnRequest_request
Type:
Show Source
object-
actualShippingRefund(optional):
number
Actual Shipping Refund for the return request
-
actualShippingSurchargeRefund(optional):
number
Actual Shipping Surcharge Refund for the return request
-
actualTaxRefund(optional):
number
Actual Tax Refund for the return request
-
additionalProperties(optional):
object additionalProperties
Map of Additional properties for return request
-
agentId(optional):
string
Agent id
-
appeasementRefundAdjustment(optional):
number
The refund amount adjustment needed for the existing appeasements on the same order
-
authorizationNumber(optional):
string
RMA number of Return Request
-
originOfReturn(optional):
string
Origin Of return request. Can be either default or contactCenter
-
otherRefund(optional):
number
Other Refund
-
refundMethodList(optional):
array refundMethodList
List of refund methods
-
returnFee(optional):
number
Return Fee for the return request
-
returnItemList(optional):
array returnItemList
List of returnable Items
-
returnLabel(optional):
string
return label of the return request
-
secondaryCurrencyActualShippingRefund(optional):
number
Actual shipping refund of all Return Items in secondary currency
-
secondaryCurrencyActualShippingSurchargeRefund(optional):
number
Actual shipping surcharge refund of all Return Items in secondary currency
-
secondaryCurrencyActualTaxRefund(optional):
number
Actual tax refund of all Return Items in secondary currency
-
secondaryCurrencyAppeasementRefundAdjustment(optional):
number
The secondary currency refund amount adjustment needed for the existing appeasements on the same order. This amount is deducted from the seconday currency refund total.
-
secondaryCurrencyShippingTaxRefund(optional):
number
Shipping Tax refund of all Return Items in secondary currency
-
shippingTaxRefund(optional):
number
Shipping tax Refund for the return request
-
state(optional):
string
State of Return Request
-
trackingNumber(optional):
string
Tracking Number of the return request. Provide comma separated tacking numbers in a single string for mulitple tracking numbers.
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:
objectMap of Additional properties for return request
Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
Amount of refund at refund method level. This is the final amount that will be refunded
-
currencyCode(optional):
string
Currency code
-
methodType(optional):
string
Refund method type ex.tokenizedCreditCard, creditCard, manualRefund etc
-
paymentGroupId(optional):
string
Payment Group Id of the refund Method
-
refundPaidTo(optional):
string
Refund paid to
-
state(optional):
string
State of refund method. It can be either INCOMPLETE or COMPLETE
Nested Schema : returnItems_request
Type:
Show Source
object- actualShippingRefundShare(optional): number
- actualShippingSurchargeRefundShare(optional): number
- actualTaxRefundShare(optional): number
-
additionalProperties(optional):
object additionalProperties
Map of Additional properties for each return item
-
childReturnItems(optional):
array childReturnItems
List of child return items of this return item
-
comments(optional):
string
Comments at ReturnItem Level
-
commerceItemId(optional):
string
Commerce Id of the returned item
-
disposition(optional):
string
Disposition reason
-
dispositionReason(optional):
string
Disposition Reason
-
quantityReceived(optional):
number
Quantity received in integer
-
quantityWithFractionReceived(optional):
number
Quantity received in fraction
-
refundAmount(optional):
number
Refund Amount at Item level
-
returnItemId(optional):
string
Id of the return Item
-
returnReason(optional):
string
Reason to return an Item
- secondaryCurrencyActualShippingRefundShare(optional): number
- secondaryCurrencyActualShippingSurchargeRefundShare(optional): number
- secondaryCurrencyActualTaxRefundShare(optional): number
-
shippingGroupId(optional):
string
Shipping group Id of the returned item
-
state(optional):
string
State of return item
Nested Schema : additionalProperties
Type:
objectMap of Additional properties for each return item
Nested Schema : childReturnItems
Type:
arrayList of child return items of this return item
Show Source
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateReturnRequest_response
Type:
Show Source
object-
actualShippingRefund(optional):
number
Actual Shipping Refund for the return request
-
actualShippingSurchargeRefund(optional):
number
Actual Shipping Surcharge Refund for the return request
-
actualTaxRefund(optional):
number
Actual Tax Refund for the return request
-
additionalProperties(optional):
object additionalProperties
Map of Additional properties for return request
-
agentId(optional):
string
Agent id
-
appeasementRefundAdjustment(optional):
number
The refund amount adjustment needed for the existing appeasements on the same order
-
authorizationNumber(optional):
string
RMA number of Return Request
-
originOfReturn(optional):
string
Origin Of return request. Can be either default or contactCenter
-
otherRefund(optional):
number
Other Refund
-
refundMethodList(optional):
array refundMethodList
List of refund methods
-
returnFee(optional):
number
Return Fee for the return request
-
returnItemList(optional):
array returnItemList
List of returnable Items
-
returnLabel(optional):
string
return label of the return request
-
secondaryCurrencyActualShippingRefund(optional):
number
Actual shipping refund of all Return Items in secondary currency
-
secondaryCurrencyActualShippingSurchargeRefund(optional):
number
Actual shipping surcharge refund of all Return Items in secondary currency
-
secondaryCurrencyActualTaxRefund(optional):
number
Actual tax refund of all Return Items in secondary currency
-
secondaryCurrencyAppeasementRefundAdjustment(optional):
number
The secondary currency refund amount adjustment needed for the existing appeasements on the same order. This amount is deducted from the seconday currency refund total.
-
secondaryCurrencyShippingTaxRefund(optional):
number
Shipping Tax refund of all Return Items in secondary currency
-
shippingTaxRefund(optional):
number
Shipping tax Refund for the return request
-
state(optional):
string
State of Return Request
-
trackingNumber(optional):
string
Tracking Number of the return request. Provide comma separated tacking numbers in a single string for mulitple tracking numbers.
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:
objectMap of Additional properties for return request
Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
Amount of refund at refund method level. This is the final amount that will be refunded
-
currencyCode(optional):
string
Currency code
-
methodType(optional):
string
Refund method type ex.tokenizedCreditCard, creditCard, manualRefund etc
-
paymentGroupId(optional):
string
Payment Group Id of the refund Method
-
refundPaidTo(optional):
string
Refund paid to
-
state(optional):
string
State of refund method. It can be either INCOMPLETE or COMPLETE
Nested Schema : returnItems_response
Type:
Show Source
object- actualShippingRefundShare(optional): number
- actualShippingSurchargeRefundShare(optional): number
- actualTaxRefundShare(optional): number
-
additionalProperties(optional):
object additionalProperties
Map of Additional properties for each return item
-
childReturnItems(optional):
array childReturnItems
List of child return items of this return item.
-
comments(optional):
string
Comments at ReturnItem Level
-
commerceItemId(optional):
string
Commerce Id of the returned item
-
disposition(optional):
string
Disposition reason
-
dispositionReason(optional):
string
Disposition Reason
-
quantityReceived(optional):
number
Quantity received in integer
-
quantityWithFractionReceived(optional):
number
Quantity received in fraction
-
refundAmount(optional):
number
Refund Amount at Item level
-
returnItemId(optional):
string
Id of the return Item
-
returnReason(optional):
string
Reason to return an Item
- secondaryCurrencyActualShippingRefundShare(optional): number
- secondaryCurrencyActualShippingSurchargeRefundShare(optional): number
- secondaryCurrencyActualTaxRefundShare(optional): number
-
shippingGroupId(optional):
string
Shipping group Id of the returned item
-
state(optional):
string
State of return item
Nested Schema : additionalProperties
Type:
objectMap of Additional properties for each return item
Nested Schema : childReturnItems
Type:
arrayList of child return items of this return item.
Show Source
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|
|------------------|------------------|
|200125|Input passed is null.|
|200126|Invalid Input Parameter.|
|200194|The given Request Id is an exchange request id. Update action not supported.|
|200195|Request site id doesn't match current site id.|
|00000000|It will be a list of errors where each error will have 200192 as error code
Root Schema : errorModel
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code