listReturnRequests
get
/ccstore/v1/orders/{id}/returnRequests
Lists all return requests for a given order ID. Optionally takes the x-ccasset-language headers to get translated content in another language. Also it can have optional X-CCOrganization header which is a JSON field to specify current Organization context of logged in user.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The order ID to retreive all related return requests.
Header Parameters
-
X-CCOrganization(optional): string
Current organization context of the logged in user
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listReturnRequests_response
Type:
Show Source
object
-
items(optional):
array items
List of all return requests related to an order.
Nested Schema : items
Type:
Show Source
object
-
additionalProperties(optional):
object additionalProperties
Additional properties returned by return request validation webhook
-
authorizationNumber(optional):
string
RMA of the return request
-
createdDate(optional):
string
The authorization date of the return request.
-
isExchangeRequest(optional):
boolean
Either it is exchange / return request.
-
nonreturnable(optional):
boolean
Indicates whether the item is returnable or not
-
nonReturnableReason(optional):
string
Non returnable reason for the item being non-returnable
-
operation(optional):
string
The return operation of the return request
-
returnItems(optional):
array returnItems
List of return items in the return request.
-
returnLabel(optional):
string
Return label of the return request
-
returnRequestId(optional):
string
The ID of the return request.
-
state(optional):
string
Status of Return Request.
-
totalRefund(optional):
number
The total refund amount of the return request.
-
totalReturnQuantity(optional):
number
The total returned quantity in the return request.
-
trackingNumber(optional):
array trackingNumber
Tracking Number of return request
Nested Schema : additionalProperties
Type:
object
Additional properties returned by return request validation webhook
Nested Schema : items
Type:
Show Source
object
-
actionCode(optional):
string
The action code that has been set on the externalData item by the configurator system.
-
additionalProperties(optional):
object additionalProperties
Additional properties returned by return request validation webhook
-
catRefId(optional):
string
The SKU ID of the return item.
-
productId(optional):
string
The Product ID of the return item.
-
quantityToReturn(optional):
integer
The quantity Returned of the return item.
-
returnReason(optional):
string
The return reason of the return item.
-
returnRequired(optional):
boolean
Boolean value to determine if the item has to be physically received.
-
state(optional):
string
The state of the return item.
Nested Schema : additionalProperties
Type:
object
Additional properties returned by return request validation webhook
Example Response (links)
[
{
"rel":"self",
"href":"http://store.example.com/ccstoreui/v1/orders/o30411/returnRequests"
}
]
Example Response (items)
[
{
"returnRequestId":"200002",
"returnLabel":"a5445afg5",
"isExchangeRequest":false,
"authorizationNumber":"12345",
"createdDate":1.513930292E12,
"returnItems":[
{
"quantityToReturn":1,
"productId":"Product_36Exy",
"returnReason":"Did Not Like",
"additionalProperties":{
"name2":"value2",
"name1":"value1"
},
"state":"AWAITING_RETURN",
"catRefId":"Sku_36Fxy"
}
],
"totalRefund":24.63,
"additionalProperties":{
"name2":"value2",
"name1":"value1"
},
"state":"Approved",
"totalReturnQuantity":1,
"trackingNumber":[
"1234567890"
],
"operation":"process"
},
{
"returnRequestId":"200001",
"returnLabel":"a5445afg5",
"isExchangeRequest":false,
"authorizationNumber":"12345",
"createdDate":1.513929715E12,
"returnItems":[
{
"quantityToReturn":1,
"productId":"Product_36Exy",
"returnReason":"Did Not Like",
"additionalProperties":{
"name2":"value2",
"name1":"value1"
},
"state":"AWAITING_RETURN",
"catRefId":"Sku_36Fxy"
}
],
"totalRefund":24.63,
"additionalProperties":{
"name2":"value2",
"name1":"value1"
},
"state":"Approved",
"totalReturnQuantity":1,
"trackingNumber":[
"1234567890"
],
"operation":"process"
},
{
"returnRequestId":"100003",
"returnLabel":null,
"isExchangeRequest":false,
"authorizationNumber":"100003",
"createdDate":1.513774357E12,
"returnItems":[
{
"quantityToReturn":1,
"productId":"Product_36Exy",
"returnReason":"Did Not Like",
"additionalProperties":{
},
"state":"AWAITING_RETURN",
"catRefId":"Sku_36Fxy"
}
],
"totalRefund":24.63,
"additionalProperties":{
},
"state":"Approved",
"totalReturnQuantity":1,
"trackingNumber":null,
"operation":"process"
},
{
"returnRequestId":"100002",
"returnLabel":null,
"isExchangeRequest":false,
"authorizationNumber":"100002",
"createdDate":1.513774188E12,
"returnItems":[
{
"quantityToReturn":1,
"productId":"Product_36Exy",
"returnReason":"Did Not Like",
"additionalProperties":{
},
"state":"AWAITING_RETURN",
"catRefId":"Sku_36Fxy"
}
],
"totalRefund":24.63,
"additionalProperties":{
},
"state":"Approved",
"totalReturnQuantity":1,
"trackingNumber":null,
"operation":"process"
},
{
"returnRequestId":"100001",
"returnLabel":null,
"isExchangeRequest":false,
"authorizationNumber":"100001",
"createdDate":1.513773501E12,
"returnItems":[
{
"quantityToReturn":1,
"productId":"Product_36Exy",
"returnReason":"Did Not Like",
"additionalProperties":{
},
"state":"AWAITING_RETURN",
"catRefId":"Sku_36Fxy"
}
],
"totalRefund":24.63,
"additionalProperties":{
},
"state":"Approved",
"totalReturnQuantity":1,
"trackingNumber":null,
"operation":"process"
}
]
Default Response
The error response
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