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
Path Parameters
Body ()
Root Schema : updateReturnRequest_request
Type: object
Show Source
Example:
{
    "op":"receiveReturns",
    "returnItems":[
        {
            "returnItemId":"100003",
            "dispositionReason":"acceptedWithRefund",
            "quantityReceived":1
        }
    ]
}
Nested Schema : returnItems
Type: array
List of returnable Items. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts
Show Source
Nested Schema : items
Type: object
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
Nested Schema : additionalProperties
Type: object
Additional properties of the return request
Show Source
Nested Schema : orderInfo
Type: object
Order Information. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
Show Source
Nested Schema : paymentReversalInfo
Type: object
Payment Reversal Info for Order. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
Show Source
Nested Schema : profileInfo
Type: object
Profile Information for the order. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts
Show Source
Nested Schema : promotionAdjustments
Type: object
Total promotions at Return item and Order level. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
Show Source
Nested Schema : quoteInfo
Type: object
the quote information of the order. Related Endpoint Operations - ReceiveReturns, MarkManualRefund, MarkAsComplete
Show Source
Nested Schema : refundInfo
Type: object
Refund Information at the returnRequest Level. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
Show Source
Nested Schema : returnItems
Type: array
List of returnable Items. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
Show Source
Nested Schema : submitExchangeAllowedValidationMessage
Type: object
submitExchangeAllowedValidationMessage will come in json response if isSubmitExchangeOrderAllowed property is false. Related Endpoint Operations - ReceiveReturns
Show Source
Nested Schema : trackingNumber
Type: array
List of tracking numbers for the return request
Show Source
Nested Schema : priceInfo
Type: object
Price information of the order.
Show Source
Nested Schema : recurringChargePriceInfo
Type: object
Detailed information of the recurring charges at the shipping groups level
Show Source
Nested Schema : subTotalByFrequency
Type: array
subtotal of the item by frequency
Show Source
Nested Schema : taxByFrequency
Type: array
tax by frequency
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : creditCardInfo
Type: object
Credit Card Details.
Show Source
Nested Schema : itemPromotionValueAdjustments
Type: object
Item level promotion adjustments
Show Source
Nested Schema : nonReturnItemCostAdjustment
Type: object
The cost adjustment for item which are not returned.
Show Source
Nested Schema : orderPromotionValueAdjustments
Type: object
Order Level promotion adjustments
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 : refundDueMap
Type: object
Additional Properties Allowed
Show Source
  • refund due amount in respective currency
A hashmap with currency code as a key and the refund due amount as the value.Map will be returned in response if payment is done with multiple currencies
Nested Schema : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional properties of the return item
Show Source
Nested Schema : childItems
Type: array
Returned Item child items
Show Source
Nested Schema : dispositionReason
Type: object
Disposition Reason
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 : itemPromotionValueAdjustments
Type: object
Item level promotion adjustments.
Show Source
Nested Schema : skuOptionInfo
Type: array
Product Variant Information.
Show Source
Nested Schema : skuProperties
Type: array
Sku properties Information
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : childItems
Type: array
Returned Item child items
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
Nested Schema : items
Type: object
Show Source
Nested Schema : description
Type: object
contains detailed info
Show Source
Nested Schema : productIds
Type: array
list of product id's
Show Source
Nested Schema : skuIds
Type: array
list of sku id's
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
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