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

receiveReturnRequest

put

/ccagent/v1/returnRequests/{id}/receive

Receive Return Request. 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 : receiveReturnRequest_request
Type: object
Show Source
Example:
{
    "returnItems":[
        {
            "returnItemId":"100003",
            "dispositionReason":"acceptedWithRefund",
            "quantityReceived":1
        }
    ]
}
Nested Schema : returnItems
Type: array
List of returnable Items
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 : receiveReturnRequest_response
Type: object
Show Source
Nested Schema : orderInfo
Type: object
Order Information.
Show Source
Nested Schema : paymentReversalInfo
Type: object
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 : submitExchangeAllowedValidationMessage
Type: object
submitExchangeAllowedValidationMessage will come in json response if isSubmitExchangeOrderAllowed property is false
Show Source
Nested Schema : priceInfo
Type: object
Price information of the order.
Show Source
  • The raw number that represents the price.
  • Indicates the currency of the price. For example, USD indicates that the price is in US dollars.
  • Indicates if tax is included in item price
  • Total order Discount Amount.
  • An order can be paid in points and monetary currency. This field represent order value which will be paid in points. It includes items amount, item discount, order discount. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
  • This field represents the shipping amount, shipping discount and shipping surcharge in monetary Currency. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled.
  • The secondary currency shipping surcharge amount.
  • This field represents the total tax(Item Tax and Shipping Tax) of the order in Monetary Currency. Prerequisites for the value in this Attribute: Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled. 3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
  • An order can be paid in points and monetary currency. This field represent order value which will be paid in monetary currency. It includes shipping charges, shipping surcharges, shipping discount and total tax in monetary currency. Prerequisites for the value in this Attribute: 1. PriceList configured for the site is in custom currency. 2. payTaxInSecondaryCurrency and payShippingInSecondaryCurrency flags are enabled. 3. If the tax is included in the price of the item, then this value represents only shipping tax in monetary currency.
  • The shipping cost of the order.
  • The subtotal of the order before applying order-level promotions.
  • The tax on the order.
  • The current working total, including all promotions, tax, and billing costs.
  • The total cost without Tax.
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 : childItems
Type: array
Returned Item child 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 : itemPromotionValueAdjustments
Type: object
Item level promotion adjustments.
Show Source
Nested Schema : skuOptionInfo
Type: array
Product Variant 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 : 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":1,
            "deactivationDate":"2018-06-27T12:59:59Z",
            "dynamicProperties":[
                {
                    "id":"ReferralCode",
                    "label":"ReferralCode",
                    "value":null
                },
                {
                    "id":"OfferEndsDate",
                    "label":"OfferEndsDate",
                    "value":"2020-07-02T03:42:42.000Z"
                },
                {
                    "id":"Discount",
                    "label":"Discount",
                    "value":10
                },
                {
                    "id":"GiftWrapping",
                    "label":"Gift Wrapping",
                    "value":false
                },
                {
                    "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 I",
                            "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":"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":"1234",
                    "transactionDate":"2018-06-27T12:59:59Z",
                    "catRefId":"sku10042",
                    "assetKey":"93847",
                    "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,
            "returnReasonId":"10001",
            "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",
            "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",
        "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/receive"
        }
    ],
    "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|
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