REST API for Oracle Commerce Cloud December 2017

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: Type: string

Required: true

Order Id.
type: Type: string

Required: true

Type of comment. Value can be order/profile.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getComments_response

Properties

items: Type: array items

Additional Properties Allowed:

array of agent comments

Nested Schema : items

Type: array

array of agent comments

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

comment: Type: string

Comment associated with order.
creationDate: Type: string

Order comment creation date.
repositoryId: Type: string

Repository Id.

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

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 Response Payload returned by endpoint:

{"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"
  }
]}