Jump to

• Request
• Response

getReturnRequest

get

/ccadmin/v1/returnRequests/{id}

gives return request details

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The ID of the return request.

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"
    }
}

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| |------------------|------------------| |200125|Input passed is null.| |200194|The given Request Id is an exchange request id. Update action not supported.| |00000000|Return Request Update Failed.| |200126|Invalid Input Parameter.| |200195|Original order site id doesn't match current site id|

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