REST API for Oracle Commerce Cloud December 2017

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

Body Parameter

Root Schema : createComment_request

Example


{
    "orderId":"o50001",
    "comment":"Issue related to billing address"
}

Properties

comment: Type: string

Required: true

Comments entered by an agent.
orderId: Type: string

Required: true

Order Id.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : createComment_response

Properties

comment: Type: string

Comment associated with order.
creationDate: Type: string

Order comment creation date.
repositoryId: Type: string

Repository Id.

Example 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|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{
  "orderId": "o50001",
  "comment": "Issue related to billing address"
}

Sample Response Payload returned by endpoint:

{
  "repositoryId": "800022",
  "comment": "Issue related to billing address",
  "creationDate": "2014-06-24 17:37:01.883"
}