getReasons
get
/ccadmin/v1/reasons
Get Reasons. Gets the reasons based on the reason type provided.
eg. /ccadmin/v1/reasons?type=cancelReasons
Request
Supported Media Types
- application/json
Query Parameters
-
type: string
type of the reason valid values are appeasementReason, cancelReasons, priceOverrideReasons, returnReasons and returnItemDisposition
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getReasons_response
Type:
Show Source
object
-
active(optional):
boolean
Indicates whether reason is enabled or disabled.
-
description(optional):
string
Description of the reason.
-
id(optional):
string
Id of the reason.
-
readableDescription(optional):
string
Name of the reason.
Example:
[
{
"readableDescription":"Bad product review_updated",
"active":true,
"description":"badProductReview",
"id":"badProductReview"
},
{
"readableDescription":"NewCancelReason_updated_EN",
"active":true,
"description":"NewCancelReason",
"id":"NewCancelReason"
},
{
"readableDescription":"newDescriptionForCancel",
"active":true,
"description":"newDescriptionForCancel",
"id":"100001"
},
{
"readableDescription":"No longer needed",
"active":true,
"description":"noLongerNeeded",
"id":"noLongerNeeded"
},
{
"readableDescription":"No update on shipment status",
"active":true,
"description":"noUpdateOnShipmentStatus",
"id":"noUpdateOnShipmentStatus"
}
]
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|
|------------------|------------------|
|200215|Error while retrieving the reasons|
|200213|Invalid reason type passed.|
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