getComments
get
/ccagent/v1/comments
Get Comments. Gets order comments from the repository by passing orderId and type(set as 'order').
Request
Supported Media Types
- application/json
Query Parameters
-
orderId: string
Order Id.
-
type: string
Type of comment. Value can be order/profile.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getComments_response
Type:
Show Source
object
-
items(optional):
array items
array of agent comments
Nested Schema : items
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)
{
"items":[
{
"repositoryId":"100002",
"comment":"Issue related to billing address",
"creationDate":"2015-03-25T10:10:02.000Z"
},
{
"repositoryId":"200001",
"comment":"Issue related to order number o30411 is resolved",
"creationDate":"2015-05-12T10:10:02.000Z"
}
]
}
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|
|------------------|------------------|
|28107|Specified order does not exist|
|200126|Invalid Input Parameter|
|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