createComment
post
/ccagent/v1/comments
Create Comment. Creates an order comment in the repository by passing the orderId in the input.
Request
Supported Media Types
- application/json
Root Schema : createComment_request
Type:
Show Source
object
-
comment:
string
Comments entered by an agent.
-
orderId:
string
Order Id.
Example:
{
"orderId":"o50001",
"comment":"Issue related to billing address"
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : createComment_response
Type:
Show Source
object
-
comment(optional):
string
Comment associated with order.
-
creationDate(optional):
string
Order comment creation date.
-
repositoryId(optional):
string
Repository Id.
Example Response (application/json)
{
"repositoryId":"800022",
"comment":"Issue related to billing address",
"creationDate":"2014-06-24 17:37:01.883"
}
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|
|------------------|------------------|
|200001|Order Comment Submission Failed.|
|200018|No Input Specified|
|200017|Invalid Input Parameter|
|200005|Invalid Order Comment|
|200004|Invalid Order Id|
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