getReturnRequest

get

/ccadmin/v1/returnRequests/{id}

gives return request details

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getReturnRequest_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"
        }
    ],
    "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",
            "actualShippingRefundShare":25,
            "state":"RETURNED",
            "additionalProperties":{
            },
            "actualTaxRefundShare":6,
            "quantityReceived":1,
            "refundAmount":49.99
        }
    ],
    "actualShippingSurchargeRefund":10,
    "secondaryCurrencyActualShippingSurchargeRefund":0
}
Nested Schema : additionalProperties
Type: object
Map of Additional properties for return request
Show Source
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 : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Map of Additional properties for each 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.| |200194|The given Request Id is an exchange request id. Update action not supported.| |00000000|Return Request Update Failed.| |200126|Invalid Input Parameter.| |200195|Original order site id doesn't match current site id|
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