1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Store
  4. Return Requests

calculateRefund

post

/ccstore/v1/returnRequests/calculateRefund

Calculates Refund Amounts. Gets list of items along with suggested refund amounts. Optionally takes the x-ccasset-language headers to get translated content in another language. Also, additionally takes X-CCOrganization and x-ccsite headers.

Request

Supported Media Types
  • application/json
Body Parameter
Root Schema : calculateRefund_request
Nested Schema : returnItems
Type: array
List of returnable Items.
Nested Schema : items
Type: object

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : calculateRefund_response
Nested Schema : profileInfo
Type: object
Profile Information for the order.
Nested Schema : quoteInfo
Type: object
The quote information of the order.
Nested Schema : returnItems
Type: array
List of returnable Items.
Nested Schema : organization
Type: object
The Organization associated with the B2B customer profile.
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 : dynamicProperties
Type: array
Array of custom properties at order line item level.
Nested Schema : externalData
Type: array
External data to be associated with a commerce item, provided by a configurator system.
Nested Schema : skuOptionInfo
Type: array
Product Variant Information.
Nested Schema : skuProperties
Type: array
Sku properties 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 : 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
Example application/json

{
    "returnItems":[
        {
            "quantityReturned":0,
            "unitPrice":9.99,
            "shippingGroup":{
                "shippingMethod":{
                    "shippingMethod":"standardShippingMethod",
                    "shippingMethodDescription":"Standard"
                },
                "shippingGroupId":"sg40411",
                "shippingAddress":{
                    "lastName":"Spencers",
                    "country":"US",
                    "address3":null,
                    "address2":null,
                    "city":"Montgomery",
                    "prefix":null,
                    "address1":"600 Dexter Avenue",
                    "postalCode":"36130",
                    "companyName":null,
                    "jobTitle":null,
                    "county":null,
                    "suffix":null,
                    "firstName":"Mark",
                    "phoneNumber":"973-974-1234",
                    "faxNumber":null,
                    "alias":null,
                    "middleName":null,
                    "state":"AL",
                    "email":"mspens@abc.com"
                }
            },
            "comments":null,
            "productId":"prod10035",
            "detailedItemPriceInfo":[
                {
                    "discounted":false,
                    "secondaryCurrencyTaxAmount":0,
                    "amount":12.99,
                    "quantity":1,
                    "tax":1.29,
                    "orderDiscountShare":0,
                    "detailedUnitPrice":12.99,
                    "currencyCode":"USD"
                }
            ],
            "displayName":"Fifa 2010",
            "dynamicProperties":[
                {
                    "id":"ReferralCode",
                    "label":"ReferralCode",
                    "value":null
                },
                {
                    "id":"OfferEndsDate",
                    "label":"OfferEndsDate",
                    "value":"2020-07-02T03:42:42.962Z"
                },
                {
                    "id":"Discount",
                    "label":"Discount",
                    "value":10
                },
                {
                    "id":"GiftWrapping",
                    "label":"Gift Wrapping",
                    "value":false
                },
                {
                    "id":"name",
                    "label":"Name on product(Mug)",
                    "value":"My name"
                }
            ],
            "externalData":[
            ],
            "childItems":[
                {
                    "serviceAccountId":"serviceAcc-123",
                    "deactivationDate":"2018-06-27T12:59:59Z",
                    "quantity":2,
                    "productId":"prod10040",
                    "displayName":"Super Smash Brothers Brawl",
                    "externalData":[
                    ],
                    "billingAccountId":"billingAcc-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"
                }
            ],
            "catRefId":"sku10037",
            "configuratorId":"12345677",
            "skuOptionInfo":[
            ],
            "quantityAvailableForReturn":3,
            "commerceItemId":"ci9000467",
            "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"
                }
            ],
            "quantityShipped":3,
            "price":29.97,
            "actionCode":"Add"
        }
    ],
    "profileInfo":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "organization":{
            "name":"Oracle India Pvt Ltd",
            "id":"oracle"
        },
        "middleName":null,
        "email":"kim@example.com"
    },
    "orderId":"o10400",
    "refundInfo":{
        "shippingTaxRefund":2.51,
        "suggestedOtherRefund":0,
        "suggestedTaxRefund":3.8,
        "suggestedTotalRefund":41.79,
        "actualShippingRefund":25,
        "actualTaxRefund":3.8,
        "otherRefund":0,
        "suggestedShippingRefund":25,
        "refundDue":41.79,
        "returnFee":0,
        "suggestedShippingSurchargeRefund":0,
        "suggestedOrderRefund":12.99,
        "unAdjustedRefundSubtotal":12.99,
        "actualShippingSurchargeRefund":0
    },
    "links":[
        {
            "rel":"self",
            "href":"http://example.com/ccstoreui/v1/returnRequests/calculateRefund"
        }
    ],
    "promotionAdjustments":{
        "promotionAdjustmentsCount":0,
        "orderPromotionValueAdjustments":[
        ],
        "totalOrderDiscountAdjustment":0,
        "nonReturnItemCostAdjustment":[
        ],
        "itemPromotionValueAdjustments":[
        ],
        "manyToManyPromotionCouponAdjustment":{
        }
    },
    "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":[
        {
            "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| |200114|Order is not allowed for return.| |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| |210105|Specified order does not exist.|
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:

{
  "returnItems": [{
    "quantityToReturn": 1,
    "commerceItemId": "ci8000005",
    "productId": "prod10003",
    "returnReason": "didNotLike",
    "shippingGroupId": "sg80003",
    "catRefId": "sku30019"
  }],
  "orderId": "o80003"
}

Sample Response Payload returned by endpoint:

{
  "returnItems": [{
    "quantityReturned": 0,
    "unitPrice": 9.99,
    "shippingGroup": {
      "shippingMethod": {
        "shippingMethod": "standardShippingMethod",
        "shippingMethodDescription": "Standard"
      },
      "shippingGroupId": "sg40411",
      "shippingAddress": {
        "lastName": "Spencers",
        "country": "US",
        "address3": null,
        "address2": null,
        "city": "Montgomery",
        "prefix": null,
        "address1": "600 Dexter Avenue",
        "postalCode": "36130",
        "companyName": null,
        "jobTitle": null,
        "county": null,
        "suffix": null,
        "firstName": "Mark",
        "phoneNumber": "973-974-1234",
        "faxNumber": null,
        "alias": null,
        "middleName": null,
        "state": "AL",
        "email": "mspens@abc.com"
      }
    },
    "comments": null,
    "productId": "prod10035",
    "detailedItemPriceInfo": [{
      "discounted": false,
      "secondaryCurrencyTaxAmount": 0,
      "amount": 12.99,
      "quantity": 1,
      "tax": 1.29,
      "orderDiscountShare": 0,
      "detailedUnitPrice": 12.99,
      "currencyCode": "USD"
    }],
    "displayName": "Fifa 2010",
    "dynamicProperties": [
      {
        "id": "ReferralCode",
        "label": "ReferralCode",
        "value": null
      },
      {
        "id": "OfferEndsDate",
        "label": "OfferEndsDate",
        "value": "2020-07-02T03:42:42.962Z"
      },
      {
        "id": "Discount",
        "label": "Discount",
        "value": 10
      },
      {
        "id": "GiftWrapping",
        "label": "Gift Wrapping",
        "value": false
      },
      {
        "id": "name",
        "label": "Name on product(Mug)",
        "value": "My name"
      }
    ],
    "externalData": [],
    "childItems": [
      {
        "serviceAccountId": "serviceAcc-123",
        "deactivationDate": "2018-06-27T12:59:59Z",
        "quantity": 2,
        "productId": "prod10040",
        "displayName": "Super Smash Brothers Brawl",
        "externalData": [],
        "billingAccountId": "billingAcc-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"
      }
    ],
    "catRefId": "sku10037",
    "configuratorId": "12345677",
    "skuOptionInfo": [],
    "quantityAvailableForReturn": 3,
    "commerceItemId": "ci9000467",
    "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"
      }
    ],
    "quantityShipped": 3,
    "price": 29.97,
    "actionCode": "Add"
  }],
  "profileInfo": {
    "lastName": "Anderson",
    "firstName": "Kim",
    "organization": {
      "name": "Oracle India Pvt Ltd",
      "id": "oracle"
    },
    "middleName": null,
    "email": "kim@example.com"
  },
  "orderId": "o10400",
  "refundInfo": {
    "shippingTaxRefund": 2.51,
    "suggestedOtherRefund": 0,
    "suggestedTaxRefund": 3.8,
    "suggestedTotalRefund": 41.79,
    "actualShippingRefund": 25,
    "actualTaxRefund": 3.8,
    "otherRefund": 0,
    "suggestedShippingRefund": 25,
    "refundDue": 41.79,
    "returnFee": 0,
    "suggestedShippingSurchargeRefund": 0,
    "suggestedOrderRefund": 12.99,
    "unAdjustedRefundSubtotal": 12.99,
    "actualShippingSurchargeRefund": 0
  },
  "links": [{
    "rel": "self",
    "href": "http://example.com/ccstoreui/v1/returnRequests/calculateRefund"
  }],
  "promotionAdjustments": {
    "promotionAdjustmentsCount": 0,
    "orderPromotionValueAdjustments": [],
    "totalOrderDiscountAdjustment": 0,
    "nonReturnItemCostAdjustment": [],
    "itemPromotionValueAdjustments": [],
    "manyToManyPromotionCouponAdjustment": {}
  },
  "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": [{
    "paymentGroupId": "pg10042",
    "refundType": "tokenizedCreditCard",
    "amount": 32.84,
    "creditCardInfo": {"cardNumber": "xxxxxxxxxxxx1111"},
    "creditCardType": null,
    "reversalMethod": "Card Payment Reversal",
    "maxRefundAmount": 156.82
  }]
}