Jump to

• Request
• Response

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

• application/json

Path Parameters

• id: string
  Id of returnRequest.

Header Parameters

• X-CCOrganization(optional): string
  The organization Id to which the order belongs

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getReturnRequest_response

Type: object

Show Source

• actualShippingRefund(optional): number
  Actual Shipping Refund for the return request
• actualShippingSurchargeRefund(optional): number
  Actual Shipping Surcharge Refund for the return request
• actualTaxRefund(optional): number
  Actual Tax Refund for the return request
• additionalProperties(optional): object additionalProperties
  Map of Additional properties for return request
• agentId(optional): string
  Agent id
• appeasementRefundAdjustment(optional): number
  The refund amount adjustment needed for the existing appeasements on the same order
• authorizationNumber(optional): string
  RMA number of Return Request
• originOfReturn(optional): string
  Origin Of return request. Can be either default or contactCenter
• otherRefund(optional): number
  Other Refund
• refundMethodList(optional): array refundMethodList
  List of refund methods
• returnFee(optional): number
  Return Fee for the return request
• returnItemList(optional): array returnItemList
  List of returnable Items
• returnLabel(optional): string
  return label of the return request
• secondaryCurrencyActualShippingRefund(optional): number
  Actual shipping refund of all Return Items in secondary currency
• secondaryCurrencyActualShippingSurchargeRefund(optional): number
  Actual shipping surcharge refund of all Return Items in secondary currency
• secondaryCurrencyActualTaxRefund(optional): number
  Actual tax refund of all Return Items in secondary currency
• secondaryCurrencyAppeasementRefundAdjustment(optional): number
  The secondary currency refund amount adjustment needed for the existing appeasements on the same order. This amount is deducted from the seconday currency refund total.
• secondaryCurrencyShippingTaxRefund(optional): number
  Shipping Tax refund of all Return Items in secondary currency
• shippingTaxRefund(optional): number
  Shipping tax Refund for the return request
• state(optional): string
  State of Return Request
• trackingNumber(optional): string
  Tracking Number of the return request. Provide comma separated tacking numbers in a single string for mulitple tracking numbers.

{
    "properties":{
        "agentId":{
            "description":"Agent id",
            "type":"string"
        },
        "shippingTaxRefund":{
            "description":"Shipping tax Refund for the return request",
            "type":"number"
        },
        "secondaryCurrencyShippingTaxRefund":{
            "description":"Shipping Tax refund of all Return Items in secondary currency",
            "type":"number"
        },
        "actualShippingRefund":{
            "description":"Actual Shipping Refund for the return request",
            "type":"number"
        },
        "actualTaxRefund":{
            "description":"Actual Tax Refund for the return request",
            "type":"number"
        },
        "otherRefund":{
            "description":"Other Refund",
            "type":"number"
        },
        "secondaryCurrencyActualTaxRefund":{
            "description":"Actual tax refund of all Return Items in secondary currency",
            "type":"number"
        },
        "refundMethodList":{
            "description":"List of refund methods",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "paymentGroupId":{
                        "description":"Payment Group Id of the refund Method",
                        "type":"string"
                    },
                    "amount":{
                        "description":"Amount of refund at refund method level. This is the final amount that will be refunded",
                        "type":"number"
                    },
                    "methodType":{
                        "description":"Refund method type ex.tokenizedCreditCard, creditCard, manualRefund etc",
                        "type":"string"
                    },
                    "refundPaidTo":{
                        "description":"Refund paid to",
                        "type":"string"
                    },
                    "state":{
                        "description":"State of refund method.\nIt can be either INCOMPLETE\nor COMPLETE\nor PENDING_REFUND",
                        "type":"string"
                    },
                    "currencyCode":{
                        "description":"Currency code",
                        "type":"string"
                    }
                }
            }
        },
        "returnLabel":{
            "description":"return label of the return request",
            "type":"string"
        },
        "authorizationNumber":{
            "description":"RMA number of Return Request",
            "type":"string"
        },
        "returnFee":{
            "description":"Return Fee for the return request",
            "type":"number"
        },
        "secondaryCurrencyActualShippingRefund":{
            "description":"Actual shipping refund of all Return Items in secondary currency",
            "type":"number"
        },
        "state":{
            "description":"State of Return Request",
            "type":"string"
        },
        "additionalProperties":{
            "description":"Map of Additional properties for return request",
            "type":"object"
        },
        "appeasementRefundAdjustment":{
            "description":"The refund amount adjustment needed for the existing appeasements on the same order",
            "type":"number"
        },
        "originOfReturn":{
            "description":"Origin Of return request. Can be either default or contactCenter",
            "type":"string"
        },
        "trackingNumber":{
            "description":"Tracking Number of the return request. \nProvide comma separated tacking numbers in a single string for mulitple tracking numbers.",
            "type":"string"
        },
        "returnItemList":{
            "description":"List of returnable Items",
            "type":"array",
            "items":{
                "type":"object",
                "$ref":"#/definitions/returnItems_response"
            }
        },
        "actualShippingSurchargeRefund":{
            "description":"Actual Shipping Surcharge Refund for the return request",
            "type":"number"
        },
        "secondaryCurrencyActualShippingSurchargeRefund":{
            "description":"Actual shipping surcharge refund of all Return Items in secondary currency",
            "type":"number"
        },
        "secondaryCurrencyAppeasementRefundAdjustment":{
            "description":"The secondary currency refund amount adjustment needed for the existing appeasements on the same order. This amount is deducted from the seconday currency refund total.",
            "type":"number"
        }
    },
    "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"
            }
        ],
        "appeasementRefundAdjustment":0,
        "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",
                "childReturnItems":[
                ],
                "actualShippingRefundShare":25,
                "state":"RETURNED",
                "additionalProperties":{
                },
                "actualTaxRefundShare":6,
                "quantityReceived":1,
                "refundAmount":49.99
            }
        ],
        "actualShippingSurchargeRefund":10,
        "secondaryCurrencyActualShippingSurchargeRefund":0,
        "secondaryCurrencyAppeasementRefundAdjustment":0
    }
}

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"
        }
    ],
    "appeasementRefundAdjustment":0,
    "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",
            "childReturnItems":[
            ],
            "actualShippingRefundShare":25,
            "state":"RETURNED",
            "additionalProperties":{
            },
            "actualTaxRefundShare":6,
            "quantityReceived":1,
            "refundAmount":49.99
        }
    ],
    "actualShippingSurchargeRefund":10,
    "secondaryCurrencyActualShippingSurchargeRefund":0,
    "secondaryCurrencyAppeasementRefundAdjustment":0
}

Nested Schema : additionalProperties

Type: object

Map of Additional properties for return request

Nested Schema : refundMethodList

Type: array

List of refund methods

Show Source

• Array of: object items

{
    "description":"List of refund methods",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "paymentGroupId":{
                "description":"Payment Group Id of the refund Method",
                "type":"string"
            },
            "amount":{
                "description":"Amount of refund at refund method level. This is the final amount that will be refunded",
                "type":"number"
            },
            "methodType":{
                "description":"Refund method type ex.tokenizedCreditCard, creditCard, manualRefund etc",
                "type":"string"
            },
            "refundPaidTo":{
                "description":"Refund paid to",
                "type":"string"
            },
            "state":{
                "description":"State of refund method.\nIt can be either INCOMPLETE\nor COMPLETE\nor PENDING_REFUND",
                "type":"string"
            },
            "currencyCode":{
                "description":"Currency code",
                "type":"string"
            }
        }
    }
}

Nested Schema : returnItemList

Type: array

List of returnable Items

Show Source

• Array of: object returnItems_response

{
    "description":"List of returnable Items",
    "type":"array",
    "items":{
        "type":"object",
        "$ref":"#/definitions/returnItems_response"
    }
}

Nested Schema : items

Type: object

Show Source

• amount(optional): number
  Amount of refund at refund method level. This is the final amount that will be refunded
• currencyCode(optional): string
  Currency code
• methodType(optional): string
  Refund method type ex.tokenizedCreditCard, creditCard, manualRefund etc
• paymentGroupId(optional): string
  Payment Group Id of the refund Method
• refundPaidTo(optional): string
  Refund paid to
• state(optional): string
  State of refund method. It can be either INCOMPLETE or COMPLETE or PENDING_REFUND

{
    "type":"object",
    "properties":{
        "paymentGroupId":{
            "description":"Payment Group Id of the refund Method",
            "type":"string"
        },
        "amount":{
            "description":"Amount of refund at refund method level. This is the final amount that will be refunded",
            "type":"number"
        },
        "methodType":{
            "description":"Refund method type ex.tokenizedCreditCard, creditCard, manualRefund etc",
            "type":"string"
        },
        "refundPaidTo":{
            "description":"Refund paid to",
            "type":"string"
        },
        "state":{
            "description":"State of refund method.\nIt can be either INCOMPLETE\nor COMPLETE\nor PENDING_REFUND",
            "type":"string"
        },
        "currencyCode":{
            "description":"Currency code",
            "type":"string"
        }
    }
}

Nested Schema : returnItems_response

Type: object

Show Source

• actualShippingRefundShare(optional): number
  Actual Shipping Refund at Item level
• actualShippingSurchargeRefundShare(optional): number
  Actual Shipping Surcharge Refund at Item level
• actualTaxRefundShare(optional): number
  Actual Tax Refund at Item level
• additionalProperties(optional): object additionalProperties
  Map of Additional properties for each return item
• childReturnItems(optional): array childReturnItems
  List of child return items of this return item.
• comments(optional): string
  Comments at ReturnItem Level
• commerceItemId(optional): string
  Commerce Id of the returned item
• disposition(optional): string
  Disposition reason
• dispositionReason(optional): string
  Disposition Reason
• quantityReceived(optional): number
  Quantity received in integer
• quantityWithFractionReceived(optional): number
  Quantity received in fraction
• refundAmount(optional): number
  Refund Amount at Item level
• returnItemId(optional): string
  Id of the return Item
• returnReason(optional): string
  Reason to return an Item
• secondaryCurrencyActualShippingRefundShare(optional): number
  Actual shipping refund at return item level in secondary currency
• secondaryCurrencyActualShippingSurchargeRefundShare(optional): number
  Actual shipping surcharge refund at return item level in secondary currency
• secondaryCurrencyActualTaxRefundShare(optional): number
  Actual Tax refund at return item level in secondary currency
• shippingGroupId(optional): string
  Shipping group Id of the returned item
• state(optional): string
  State of return item

{
    "properties":{
        "comments":{
            "description":"Comments at ReturnItem Level",
            "type":"string"
        },
        "secondaryCurrencyActualTaxRefundShare":{
            "description":"Actual Tax refund at return item level in secondary currency",
            "type":"number"
        },
        "returnItemId":{
            "description":"Id of the return Item",
            "type":"string"
        },
        "shippingGroupId":{
            "description":"Shipping group Id of the returned item",
            "type":"string"
        },
        "secondaryCurrencyActualShippingSurchargeRefundShare":{
            "description":"Actual shipping surcharge refund at return item level in secondary currency",
            "type":"number"
        },
        "quantityWithFractionReceived":{
            "description":"Quantity received in fraction",
            "type":"number"
        },
        "commerceItemId":{
            "description":"Commerce Id of the returned item",
            "type":"string"
        },
        "secondaryCurrencyActualShippingRefundShare":{
            "description":"Actual shipping refund at return item level in secondary currency",
            "type":"number"
        },
        "disposition":{
            "description":"Disposition reason",
            "type":"string"
        },
        "actualShippingSurchargeRefundShare":{
            "description":"Actual Shipping Surcharge Refund at Item level",
            "type":"number"
        },
        "returnReason":{
            "description":"Reason to return an Item",
            "type":"string"
        },
        "childReturnItems":{
            "description":"List of child return items of this return item. ",
            "type":"array",
            "items":{
                "type":"object",
                "$ref":"#/definitions/returnItems_response"
            }
        },
        "actualShippingRefundShare":{
            "description":"Actual Shipping Refund at Item level",
            "type":"number"
        },
        "additionalProperties":{
            "description":"Map of Additional properties for each return item",
            "type":"object"
        },
        "state":{
            "description":"State of return item",
            "type":"string"
        },
        "actualTaxRefundShare":{
            "description":"Actual Tax Refund at Item level",
            "type":"number"
        },
        "quantityReceived":{
            "description":"Quantity received in integer",
            "type":"number"
        },
        "dispositionReason":{
            "description":"Disposition Reason",
            "type":"string"
        },
        "refundAmount":{
            "description":"Refund Amount at Item level",
            "type":"number"
        }
    }
}

Nested Schema : additionalProperties

Type: object

Map of Additional properties for each return item

Nested Schema : childReturnItems

Type: array

List of child return items of this return item.

Show Source

• Array of: object returnItems_response

{
    "description":"List of child return items of this return item. ",
    "type":"array",
    "items":{
        "type":"object",
        "$ref":"#/definitions/returnItems_response"
    }
}

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":"[e-mail]"
    },
    "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

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top