listCancelReasons
get
/ccagent/v1/merchant/orderCancelReasons
List Cancel Reasons. Lists the Cancel Reasons for cancelling an order
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listCancelReasons_response
Type:
Show Source
object
-
items(optional):
array items
The list of all Cancel Reasons
Nested Schema : items
Type:
Show Source
object
-
displayValue(optional):
string
Display Name of the cancel reason
-
Key(optional):
string
Display Key of the cancel reason
Example Response (application/json)
[
{
"displayValue":"Bad product review",
"key":"badProductReview"
},
{
"displayValue":"Better competitor price",
"key":"betterCompetitorPrice"
},
{
"displayValue":"Change of mind",
"key":"changeOfMind"
},
{
"displayValue":"Item available at discount currently",
"key":"itemAvailableAtDiscountCurrently"
},
{
"displayValue":"No longer needed",
"key":"noLongerNeeded"
},
{
"displayValue":"No update on shipment status",
"key":"noUpdateOnShipmentStatus"
}
]
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