1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Agent
  4. Return Order

updateReturnRequest

put

/ccagent/v1/returnRequests/{id}

Update Return Request. It updates the returnRequest based on the operation value. Operation value can be any of receiveReturns/initiateRefund/adjustRefundAmounts/markManualRefund/markAsComplete. 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
  • application/json
Path Parameters
id
Type: string
Required: true
Return Request Id.
Header Parameters
X-CCOrganization
Type: string
The organization Id to which the order belongs
x-ccsite
Type: string
the site id on which the orders is laced
Body Parameter
Root Schema : updateReturnRequest_request
Nested Schema : returnItems
Type: array
List of returnable Items. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts
Nested Schema : items
Type: object

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : updateReturnRequest_response
Nested Schema : orderInfo
Type: object
Order Information. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
Nested Schema : paymentReversalInfo
Type: object
Payment Reversal Info for Order. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
Nested Schema : profileInfo
Type: object
Profile Information for the order. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts
Nested Schema : promotionAdjustments
Type: object
Total promotions at Return item and Order level. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
Nested Schema : quoteInfo
Type: object
the quote information of the order. Related Endpoint Operations - ReceiveReturns, MarkManualRefund, MarkAsComplete
Nested Schema : refundInfo
Type: object
Refund Information at the returnRequest Level. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
Nested Schema : returnItems
Type: array
List of returnable Items. Related Endpoint Operations - ReceiveReturns, AdjustRefundAmounts, MarkManualRefund, MarkAsComplete
Nested Schema : submitExchangeAllowedValidationMessage
Type: object
submitExchangeAllowedValidationMessage will come in json response if isSubmitExchangeOrderAllowed property is false. Related Endpoint Operations - ReceiveReturns
Nested Schema : priceInfo
Type: object
Price information of the order.
Nested Schema : creditCardInfo
Type: object
Credit Card Details.
Nested Schema : itemPromotionValueAdjustments
Type: object
Item level promotion adjustments
Nested Schema : nonReturnItemCostAdjustment
Type: object
The cost adjustment for item which are not returned.
Nested Schema : orderPromotionValueAdjustments
Type: object
Order Level promotion adjustments
Nested Schema : errorInfo
Type: array
the array of errors, if any
Nested Schema : notes
Type: array
the notes (history) for the order
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : childItems
Type: array
Returned Item child items
Nested Schema : dispositionReason
Type: object
Disposition Reason
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Nested Schema : itemPromotionValueAdjustments
Type: object
Item level promotion adjustments.
Nested Schema : skuOptionInfo
Type: array
Product Variant Information.
Nested Schema : skuProperties
Type: array
Sku properties Information
Nested Schema : items
Type: object
Nested Schema : childItems
Type: array
Returned Item child items
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Nested Schema : selectedOptions
Type: array
Child Product Variant Information.
Nested Schema : items
Type: object
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Nested Schema : selectedOptions
Type: array
Child Product Variant Information.
Nested Schema : items
Type: object
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : values
Type: object
The array of values associated with an externalData item.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : description
Type: object
contains detailed info
Nested Schema : productIds
Type: array
list of product id's
Nested Schema : skuIds
Type: array
list of sku id's
Example application/json

{
    "returnRequestStatus":"Full return",
    "isManuallyAdjusted":false,
    "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.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":"OM-D E-M10 Digital Compact System Camera",
            "externalData":[
            ],
            "billingAccountId":"billingAcc-123",
            "childItems":[
                {
                    "serviceAccountId":"serviceAcc-123",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "quantity":2,
                    "productId":"prod10040",
                    "displayName":"Super Smash Brothers Brawl",
                    "externalData":[
                    ],
                    "billingAccountId":"billingAcc-123",
                    "childItems":[
                        {
                            "serviceAccountId":"serviceAcc-123",
                            "deactivationDate":"2018-06-27T12:59:59Z",
                            "quantity":1,
                            "productId":"prod10039",
                            "displayName":"Wii Music",
                            "externalData":[
                            ],
                            "billingAccountId":"billingAcc-123",
                            "catRefId":"sku10049",
                            "route":"product/prod10039",
                            "customerAccountId":"customerAcc-123",
                            "assetId":"asset10001",
                            "selectedOptions":[
                            ],
                            "actionCode":"Add",
                            "activationDate":"2017-06-27T15:30:00Z",
                            "serviceId":"service-123"
                        }
                    ],
                    "catRefId":"sku10041",
                    "route":"product/prod10040",
                    "customerAccountId":"customerAcc-123",
                    "assetId":"asset10001",
                    "selectedOptions":[
                    ],
                    "actionCode":"Add",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123"
                },
                {
                    "serviceAccountId":"serviceAcc-123",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "quantity":1,
                    "productId":"prod10038",
                    "displayName":"Wii Music",
                    "externalData":[
                    ],
                    "billingAccountId":"billingAcc-123",
                    "catRefId":"sku10042",
                    "route":"product/prod10038",
                    "customerAccountId":"customerAcc-123",
                    "assetId":"asset10001",
                    "selectedOptions":[
                    ],
                    "actionCode":"Add",
                    "activationDate":"2017-06-27T15:30:00Z",
                    "serviceId":"service-123"
                }
            ],
            "configuratorId":"12345677",
            "skuOptionInfo":[
                {
                    "optionValue":"Tan",
                    "optionName":"color"
                },
                {
                    "optionValue":"30.8-megapixels",
                    "optionName":"resolution"
                }
            ],
            "quantityAvailableForReturn":0,
            "commerceItemId":"ci9000467",
            "suggestedShippingRefund":35,
            "assetId":"asset10001",
            "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,
            "catRefId":"camerasku_1_5",
            "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":1,
            "adjustedPromotionReferences":"",
            "activationDate":"2017-06-27T15:30:00Z",
            "actualRefundAmount":200,
            "suggestedRefundAmount":200
        }
    ],
    "orderInfo":{
        "priceInfo":{
            "total":256.31,
            "amount":198,
            "shipping":35,
            "isTaxIncluded":false,
            "tax":23.31,
            "subTotal":200,
            "orderDiscountAmount":2,
            "currencyCode":"USD",
            "totalWithoutTax":189.9
        },
        "orderId":"o10423",
        "siteId":"siteUS",
        "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,
        "actualShippingRefund":35,
        "actualTaxRefund":23.31,
        "otherRefund":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"
        }
    ],
    "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"
    },
    "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.| |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
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Request:

{
  "op": "receiveReturns",
  "returnItems": [{
    "returnItemId": "100003",
    "dispositionReason": "acceptedWithRefund",
    "quantityReceived": 1
  }]
}

Sample Response Payload returned by endpoint:

{
  "returnRequestStatus": "Full return",
  "isManuallyAdjusted": false,
  "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.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": "OM-D E-M10 Digital Compact System Camera",
    "externalData": [],
    "billingAccountId": "billingAcc-123",
    "childItems": [
      {
        "serviceAccountId": "serviceAcc-123",
        "deactivationDate": "2018-06-27T12:59:59Z",
        "quantity": 2,
        "productId": "prod10040",
        "displayName": "Super Smash Brothers Brawl",
        "externalData": [],
        "billingAccountId": "billingAcc-123",
        "childItems": [{
          "serviceAccountId": "serviceAcc-123",
          "deactivationDate": "2018-06-27T12:59:59Z",
          "quantity": 1,
          "productId": "prod10039",
          "displayName": "Wii Music",
          "externalData": [],
          "billingAccountId": "billingAcc-123",
          "catRefId": "sku10049",
          "route": "product/prod10039",
          "customerAccountId": "customerAcc-123",
          "assetId": "asset10001",
          "selectedOptions": [],
          "actionCode": "Add",
          "activationDate": "2017-06-27T15:30:00Z",
          "serviceId": "service-123"
        }],
        "catRefId": "sku10041",
        "route": "product/prod10040",
        "customerAccountId": "customerAcc-123",
        "assetId": "asset10001",
        "selectedOptions": [],
        "actionCode": "Add",
        "activationDate": "2017-06-27T15:30:00Z",
        "serviceId": "service-123"
      },
      {
        "serviceAccountId": "serviceAcc-123",
        "deactivationDate": "2018-06-27T12:59:59Z",
        "quantity": 1,
        "productId": "prod10038",
        "displayName": "Wii Music",
        "externalData": [],
        "billingAccountId": "billingAcc-123",
        "catRefId": "sku10042",
        "route": "product/prod10038",
        "customerAccountId": "customerAcc-123",
        "assetId": "asset10001",
        "selectedOptions": [],
        "actionCode": "Add",
        "activationDate": "2017-06-27T15:30:00Z",
        "serviceId": "service-123"
      }
    ],
    "configuratorId": "12345677",
    "skuOptionInfo": [
      {
        "optionValue": "Tan",
        "optionName": "color"
      },
      {
        "optionValue": "30.8-megapixels",
        "optionName": "resolution"
      }
    ],
    "quantityAvailableForReturn": 0,
    "commerceItemId": "ci9000467",
    "suggestedShippingRefund": 35,
    "assetId": "asset10001",
    "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,
    "catRefId": "camerasku_1_5",
    "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": 1,
    "adjustedPromotionReferences": "",
    "activationDate": "2017-06-27T15:30:00Z",
    "actualRefundAmount": 200,
    "suggestedRefundAmount": 200
  }],
  "orderInfo": {
    "priceInfo": {
      "total": 256.31,
      "amount": 198,
      "shipping": 35,
      "isTaxIncluded": false,
      "tax": 23.31,
      "subTotal": 200,
      "orderDiscountAmount": 2,
      "currencyCode": "USD",
      "totalWithoutTax": 189.9
    },
    "orderId": "o10423",
    "siteId": "siteUS",
    "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,
    "actualShippingRefund": 35,
    "actualTaxRefund": 23.31,
    "otherRefund": 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"
  }],
  "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"
  },
  "paymentReversalInfo": {
    "creditCardInfo": {"cardNumber": "xxxxxxxxxxxx1111"},
    "reversalMethod": "Card Payment Reversal"
  }
}