1. REST API for Oracle Commerce Cloud 21B
  2. Tasks
  3. Agent
  4. Return Order

getReturnRequest

get

/ccagent/v1/returnRequests/{id}

Get Return Request. Gets the return request details for a given ReturnRequestId. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.

Request

Supported Media Types
Path Parameters
Header 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
Nested Schema : additionalProperties
Type: object
Additional properties if any returned by the webhook.
Nested Schema : orderInfo
Type: object
Order Information.
Show Source
Nested Schema : paymentReversalInfo
Type: array
Payment Reversal Info for Order.
Show Source
Nested Schema : profileInfo
Type: object
Profile Information for the order.
Show Source
Nested Schema : promotionAdjustments
Type: object
Total promotions at Return item and Order level
Show Source
Nested Schema : quoteInfo
Type: object
the quote information of the order
Show Source
Nested Schema : refundInfo
Type: object
Refund Information at the returnRequest Level.
Show Source
Nested Schema : returnItems
Type: array
List of returnable Items
Show Source
Nested Schema : state
Type: object
state
Show Source
Nested Schema : submitExchangeAllowedValidationMessage
Type: object
submitExchangeAllowedValidationMessage will come in json response if isSubmitExchangeOrderAllowed property is false
Show Source
Nested Schema : trackingNumber
Type: array
Tracking Number of the return request
Show Source
Nested Schema : priceInfo
Type: object
Price information of the order.
Show Source
Nested Schema : priceListGroup
Type: object
PriceList group of the order.
Show Source
Nested Schema : currency
Type: object
Currency of the PriceList group.
Show Source
Nested Schema : listPriceList
Type: object
Price List for list prices
Show Source
Nested Schema : salePriceList
Type: object
Price List for sale prices
Show Source
Nested Schema : shippingSurchargePriceList
Type: object
Price List for shipping surcharge prices
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : creditCardInfo
Type: object
Credit Card Details.
Show Source
Nested Schema : organization
Type: array
The Organization associated with the B2B customer profile.
Show Source
Nested Schema : items
Type: object
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 : items
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional Properties if any returned by webhook.
Nested Schema : childItems
Type: array
Returned Item child items
Show Source
Nested Schema : childReturnItems
Type: array
List of child return Items
Show Source
Nested Schema : dispositionReason
Type: object
Disposition Reason
Show Source
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
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 : 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 : childReturnItems_def
Type: object
Show Source
Nested Schema : additionalProperties
Type: object
Additional Properties if any returned by webhook.
Nested Schema : childReturnItems
Type: array
List of child return Items
Show Source
Nested Schema : dispositionReason
Type: object
Disposition Reason
Show Source
Nested Schema : dynamicProperties
Type: array
Array of custom properties at order line item level.
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 : 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 : 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
Example Response (application/json)
{
    "returnRequestStatus":"Full return",
    "isExchangeRequest":false,
    "returnItems":[
        {
            "quantityReturned":2,
            "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":"Playstation",
            "externalData":[
            ],
            "billingProfileId":"billingProfile-123",
            "billingAccountId":"billingAcc-123",
            "orderDiscountShare":0,
            "childItems":[
                {
                    "serviceAccountId":"serviceAcc-123",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "quantity":2,
                    "productId":"prod10040",
                    "displayName":"Super Smash Brothers Brawl",
                    "externalData":[
                    ],
                    "parentAssetKey":"123456",
                    "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":"sku10047",
                            "assetKey":"34567",
                            "route":"product/prod10039",
                            "customerAccountId":"customerAcc-123",
                            "selectedOptions":[
                            ],
                            "actionCode":"Add",
                            "activationDate":"2017-06-27T15:30:00Z",
                            "serviceId":"service-123",
                            "asset":false
                        }
                    ],
                    "rootAssetKey":"123456",
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "catRefId":"sku10041",
                    "assetKey":"23456",
                    "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":"85748",
                    "route":"product/prod10038",
                    "customerAccountId":"customerAcc-123",
                    "selectedOptions":[
                    ],
                    "actionCode":"Add",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123",
                    "asset":false
                }
            ],
            "skuOptionInfo":[
            ],
            "configuratorId":"12345677",
            "assetKey":"12345",
            "quantityAvailableForReturn":3,
            "commerceItemId":"ci9000467",
            "unAdjustedRefundAmount":25,
            "suggestedShippingRefund":5.83,
            "price":115,
            "returnReason":"Incorrect Item",
            "actionCode":"Add",
            "promotionAdjustments":[
            ],
            "serviceId":"service-123",
            "quantityReceived":1,
            "dispositionReason":{
                "displayKey":"rejectedWithRefund",
                "displayName":"Rejected With Refund"
            },
            "serviceAccountId":"serviceAcc-123",
            "unitPrice":25,
            "quantityToReturn":1,
            "comments":null,
            "productId":"prod10013",
            "returnItemId":"300002",
            "quantityToReceive":0,
            "suggestedTaxRefund":2.01,
            "shippingGroupId":"sg80417",
            "parentAssetKey":null,
            "manualAdjustmentShare":0,
            "rootAssetKey":null,
            "transactionDate":"2018-06-27T12:59:59Z",
            "catRefId":"sku10030",
            "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":5,
            "adjustedPromotionReferences":"",
            "additionalProperties":{
                "property_2":"value_2",
                "property_1":"value_1"
            },
            "activationDate":"2017-06-27T15:30:00Z",
            "asset":false,
            "actualRefundAmount":25,
            "suggestedRefundAmount":25
        }
    ],
    "profileInfo":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "organization":{
            "name":"Oracle India Pvt Ltd",
            "id":"oracle"
        },
        "middleName":null,
        "email":"kim@example.com"
    },
    "returnLabel":"return label 1",
    "isManuallyAdjusted":false,
    "authorizationNumber":"100001",
    "orderInfo":{
        "originOfOrder":"contactCenter",
        "priceInfo":{
            "total":156.82,
            "amount":110.2,
            "shipping":35,
            "isTaxIncluded":false,
            "tax":23.31,
            "subTotal":200,
            "orderDiscountAmount":2,
            "currencyCode":"USD",
            "totalWithoutTax":129.89
        },
        "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":"o10042",
        "priceListGroup":{
            "deleted":false,
            "displayName":"UsDollar",
            "repositoryId":"UsDollar",
            "listPriceList":{
                "repositoryId":"listPrices"
            },
            "active":true,
            "salePriceList":{
                "repositoryId":"salePrices"
            },
            "currency":{
                "symbol":"$",
                "displayName":"US Dollar",
                "repositoryId":"hi_US",
                "fractionalDigits":2,
                "currencyCode":"USD",
                "numericCode":"356"
            },
            "id":"UsDollar",
            "locale":"hi_US",
            "shippingSurchargePriceList":{
                "repositoryId":"shippingSurchargePrices"
            }
        },
        "siteId":"siteUS",
        "creationDate":"2015-05-16T04:50:53.000Z",
        "submittedDate":"2015-06-16T04:50:53.000Z"
    },
    "refundInfo":{
        "shippingTaxRefund":2,
        "suggestedTaxRefund":2.01,
        "suggestedTotalRefund":32.84,
        "actualShippingRefund":5.83,
        "actualTaxRefund":2.01,
        "otherRefund":0,
        "refundDue":32.84,
        "suggestedShippingRefund":5.83,
        "returnFee":0,
        "suggestedOrderRefund":25,
        "appeasementRefundAdjustment":-15.3,
        "unAdjustedRefundSubtotal":25,
        "secondaryCurrencyAppeasementRefundAdjustment":0
    },
    "isSetteled":false,
    "promotionAdjustments":{
        "promotionAdjustmentsCount":0,
        "orderPromotionValueAdjustments":[
        ],
        "totalOrderDiscountAdjustment":0,
        "nonReturnItemCostAdjustment":[
        ],
        "itemPromotionValueAdjustments":[
        ],
        "manyToManyPromotionCouponAdjustment":{
        }
    },
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccagentui/v1/returnRequests/300002"
        }
    ],
    "additionalProperties":{
        "property2":"tag",
        "property":"display"
    },
    "state":{
        "displayKey":"FULL_RETURN",
        "displayName":"Full return"
    },
    "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"
    ],
    "operation":"refund",
    "paymentReversalInfo":[
        {
            "paymentGroupId":"pg10042",
            "refundType":"tokenizedCreditCard",
            "amount":32.84,
            "creditCardInfo":{
                "cardNumber":"xxxxxxxxxxxx1111"
            },
            "creditCardType":null,
            "reversalMethod":"Card Payment Reversal",
            "maxRefundAmount":156.82
        }
    ]
}

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| |200127|Internal error occurred.| |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| |100102|Organization passed in the header is invalid or does not exist| |30019|SiteId passed in x-ccsite header is not related to the order being worked upon|
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