createReason
post
/ccadmin/v1/reasons
Create Reason. Create the reason of given type with the given data. Valid reason types are appeasementReason, cancelReasons, priceOverrideReasons, returnReasons and returnItemDisposition.
eg. /ccadmin/v1/reasons?type=returnItemDisposition
Request
Supported Media Types
- application/json
Root Schema : createReason_request
Type:
Show Source
object
-
active:
boolean
Indicates whether reason is enabled or disabled.
-
description:
string
Description of the reason.
-
id(optional):
string
Id of the reason. It is an optional property to create reason with given id, else system generated id will be considered, by default.
-
readableDescription:
string
Name of the reason.
Example:
{
"readableDescription":"accepted",
"description":"accepted",
"active":false,
"id":200001
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : createReason_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":"accepted",
"description":"accepted",
"active":false,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadmin/v1/reasons?type=returnItemDisposition"
}
],
"id":"200001"
}
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|
|------------------|------------------|
|200217|Error while validating the input reason json|
|200211|Error while creating the reason|
|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