searchReturns
get
/ccagent/v1/returnRequests
Search Returns. Gets a list of return requests from the repository based on given search criteria. Optionally takes X-CCOrganization header which is a JSON field with organization ID as value.
Request
Supported Media Types
- application/json
Query Parameters
-
q: string
Search criteria to filter the search results based on various fields like email etc. Following are the fields supported by this param: |Field|Type|Description| |------------------|------------------|------------------| |returnRequestId|string|The Return Request ID.| |authorizationNumber|string|RMA is the merchant authorization number required for validation.| |pageNumber|integer|The page number for pagination.| |orderId|string|Order id| |limit|integer|The batch size of the return requests to be fetched together.| |siteId|string|site id of the return request| |state|string|state of the return request eg. PENDING_REFUND| |startDateFromTimeSpan|string|Date to start searching from like "yyyy-mm-ddThh:mm:ss.sssz" | |email|string|Email id of the customer profile| |account|string|Account id of the return requests to be fetched|
Header Parameters
-
X-CCOrganization(optional): string
The organization Id to which the order belongs
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : searchReturns_response
Type:
Show Source
object
-
searchResults(optional):
integer
Total number of return requests present in search result.
-
totalRequests(optional):
array totalRequests
Total return requests details.
Nested Schema : items
Type:
Show Source
object
-
authorizationNumber(optional):
string
RMA is the merchant authorization number required for validation
-
createdDate(optional):
string
date of creation
-
firstName(optional):
string
First Name
-
lastName(optional):
string
Last Name
-
operation(optional):
string
Return operation
-
orderId(optional):
string
Order id
-
priceListGroup(optional):
object priceListGroup
PriceList group of the order.
-
returnRequestId(optional):
string
request id
-
siteId(optional):
string
site id of the return request
-
state(optional):
string
return state
-
totalRefund(optional):
string
refund amount
-
totalRefundMap(optional):
object totalRefundMap
Additional Properties Allowed: additionalPropertiesA hashmap with currency code as a key and the refund amount as the value.Map will be returned in response if payment is done with multiple currencies
-
totalReturnQuantity(optional):
string
returned quantities
Nested Schema : priceListGroup
Type:
object
PriceList group of the order.
Show Source
-
active(optional):
boolean
Active status of pricelist group.
-
currency(optional):
object currency
Currency of the PriceList group.
-
deleted(optional):
boolean
Pricelist group deleted status.
-
displayName(optional):
string
Display Name.
-
id(optional):
string
Id.
-
listPriceList(optional):
object listPriceList
Price List for list prices
-
locale(optional):
string
Locale.
-
repositoryId(optional):
string
Repository Id.
-
salePriceList(optional):
object salePriceList
Price List for sale prices
-
shippingSurchargePriceList(optional):
object shippingSurchargePriceList
Price List for shipping surcharge prices
Nested Schema : totalRefundMap
Type:
object
Additional Properties Allowed
Show Source
-
number
refund amount in respective currency
A hashmap with currency code as a key and the refund amount as the value.Map will be returned in response if payment is done with multiple currencies
Nested Schema : currency
Type:
object
Currency of the PriceList group.
Show Source
-
currencyCode(optional):
string
Currency Code.
-
displayName(optional):
string
Display Name.
-
fractionalDigits(optional):
integer
Fractional Digits.
-
numericCode(optional):
string
Numeric Code.
-
repositoryId(optional):
string
Repository Id.
-
symbol(optional):
string
currency Symbol.
Nested Schema : listPriceList
Type:
object
Price List for list prices
Show Source
-
repositoryId(optional):
string
Repository ID of the list prices
Nested Schema : salePriceList
Type:
object
Price List for sale prices
Show Source
-
repositoryId(optional):
string
Repository ID of the sale prices
Nested Schema : shippingSurchargePriceList
Type:
object
Price List for shipping surcharge prices
Show Source
-
repositoryId(optional):
string
Repository ID of the shipping surcharge prices
Example Response (application/json)
{
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccagentui/v1/returnRequests?q=%7B%22returnRequestId%22%3A%22300001%22%2C%22authorizationNumber%22%3A%22300002%22%2C%22orderId%22%3A%22%22%2C%22email%22%3A%22%22%2C%22startDateFromTimeSpan%22%3A%22%22%2C%22limit%22%3A20%2C%22pageNumber%22%3A0%7D"
}
],
"totalRequests":1,
"searchResults":[
{
"returnRequestId":"100003",
"lastName":"Anderson",
"isExchangeRequest":false,
"orderId":"o10401",
"totalRefund":36.46,
"priceListGroup":{
"deleted":false,
"displayName":"UsDollar",
"repositoryId":"UsDollar",
"listPriceList":{
"repositoryId":"listPrices"
},
"active":true,
"salePriceList":{
"repositoryId":"salePrices"
},
"currency":{
"symbol":"$",
"displayName":"US Dollar",
"repositoryId":"en_US",
"fractionalDigits":2,
"currencyCode":"USD",
"numericCode":"840"
},
"id":"UsDollar",
"locale":"en_US",
"shippingSurchargePriceList":{
"repositoryId":"shippingSurchargePrices"
}
},
"firstName":"Kim",
"authorizationNumber":"100001",
"createdDate":"2015-05-12T11:04:09.000Z",
"siteId":"siteUS",
"state":"Approved",
"totalReturnQuantity":1,
"operation":"process"
}
]
}
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|
|------------------|------------------|
|200020|Search Criteria passed is null or empty|
|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|
|100101|The shopper profile does not belong to organization passed in the header|
|200127|Internal error occurred.|
|200137|Invalid limit|
|200136|Invalid offset or limit|
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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