Jump to

• Request
• Response

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getComments_response

Type: object

Show Source

• items(optional): array items
  array of agent comments

{
    "properties":{
        "items":{
            "description":"array of agent comments",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository Id.",
                        "type":"string"
                    },
                    "comment":{
                        "description":"Comment associated with order.",
                        "type":"string"
                    },
                    "creationDate":{
                        "description":"Order comment creation date.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

array of agent comments

Show Source

• Array of: object items

{
    "description":"array of agent comments",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"Repository Id.",
                "type":"string"
            },
            "comment":{
                "description":"Comment associated with order.",
                "type":"string"
            },
            "creationDate":{
                "description":"Order comment creation date.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• comment(optional): string
  Comment associated with order.
• creationDate(optional): string
  Order comment creation date.
• repositoryId(optional): string
  Repository Id.

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository Id.",
            "type":"string"
        },
        "comment":{
            "description":"Comment associated with order.",
            "type":"string"
        },
        "creationDate":{
            "description":"Order comment creation date.",
            "type":"string"
        }
    }
}

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|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top