---
title: "Retrieves the comments for a transaction."
url: "https://developers.zinnia.com/apis/market-connect-order-entry/versions/50f981c3-db50-4358-884f-31eb427255ec/operations/getComments"
---

> Full API specification: https://developers.zinnia.com/apis/market-connect-order-entry/versions/50f981c3-db50-4358-884f-31eb427255ec.md

# Retrieves the comments for a transaction.

`GET` `/market-connect/order-entry/v1/comments/{transactionId}`

Operation ID: `getComments`

#### Error Responses - **400 Bad Request** - ```INVALID_TRANSACTION_ID``` - The supplied transaction ID is invalid (not a positive integer). - ```VALIDATION_ERROR``` - Pagination parameters are invalid (both page and pageSize must be supplied together; page must be ≥ 1; pageSize must be between 1 and 100). - **401 Unauthorized** - ```UNAUTHORIZED``` - Authentication failed or the access token is missing, expired, or invalid. - **403 Forbidden** - ```FORBIDDEN``` - The authenticated user is not authorized to access this resource. - **404 Not Found** - ```NOT_FOUND``` - No comments exist for the specified transaction ID. - **429 Too Many Requests** - ```RATE_LIMIT_EXCEEDED``` - The client has exceeded the permitted request rate or quota. - **500 Internal Server Error** - ```UNEXPECTED_ERROR``` - An unexpected internal system error occurred while processing the request. - **502 Bad Gateway** - ```UPSTREAM_SERVICE_ERROR``` - An upstream dependency returned an invalid or unsuccessful response. - **503 Service Unavailable** - ```SERVICE_UNAVAILABLE``` - The service or a required dependency is temporarily unavailable. - **504 Gateway Timeout** - ```UPSTREAM_TIMEOUT``` - A required downstream service did not respond within the configured timeout. #### Standard Error Response All error responses conform to the standard ```ErrorResponse``` schema and include: - A stable error code from ```ErrorInfo.code```. - A human-readable error message. - Optional diagnostic details, when applicable. - A timestamp indicating when the error occurred. This consistent format enables clients to implement standardized error processing, logging, and troubleshooting across all Order Entry API endpoints.

## Path parameters

- `transactionId` (string, required) - Unique identifier of the transaction (positive integer encoded as a string).

## Query parameters

- `page` (integer, int32, optional) - Optional 1-based page number. When omitted with pageSize, all comments are returned.
- `pageSize` (integer, int32, optional) - Optional page size (1–100). When omitted with page, all comments are returned.

## Responses

- `200` - Returns the comments envelope
- `400` - `VALIDATION_ERROR` - The request failed input validation. `INVALID_TRANSACTION_ID` - The supplied transaction ID is invalid (less than or equal to zero).
- `401` - `UNAUTHORIZED` - Authentication failed or the access token is missing, expired, or invalid.
- `403` - `FORBIDDEN` - The authenticated user is not authorized to access the requested transaction.
- `404` - `TRANSACTION_ID_NOT_FOUND` - No transaction exists for the specified transaction ID. `NOT_FOUND` - The requested transaction or blueprint step could not be found.
- `429` - `RATE_LIMIT_EXCEEDED` - The client has exceeded the permitted request rate or quota.
- `500` - `BUILD_BLUEPRINT_ERROR` - An error occurred while generating the order entry blueprint. `JSON_PARSE_ERROR` - The system encountered an error while parsing the transaction response. `UNEXPECTED_ERROR` - An unexpected internal system error occurred while processing the request.
- `502` - `UPSTREAM_SERVICE_ERROR` - An upstream dependency returned an invalid or unsuccessful response.
- `503` - `SERVICE_UNAVAILABLE` - The service or a required dependency is temporarily unavailable.
- `504` - `UPSTREAM_TIMEOUT` - A required downstream service did not respond within the configured timeout.

## OpenAPI definition

````yaml
openapi: 3.0.1
info:
  title: Market Connect Order Entry API
  version: 1.0.3
servers:
  - url: https://dev.api.zinnia.io
  - url: https://qa.api.zinnia.io
  - url: https://uat.api.zinnia.io
paths:
  /market-connect/order-entry/v1/comments/{transactionId}:
    get:
      tags:
        - Comments
      summary: Retrieves the comments for a transaction.
      description: >-
        #### Error Responses


        - **400 Bad Request**
            
        - ```INVALID_TRANSACTION_ID``` - The supplied transaction ID is invalid
        (not a positive integer).

        - ```VALIDATION_ERROR``` - Pagination parameters are invalid (both page
        and pageSize must be supplied together; page must be ≥ 1; pageSize must
        be between 1 and 100).


        - **401 Unauthorized**
            
        - ```UNAUTHORIZED``` - Authentication failed or the access token is
        missing, expired, or invalid.


        - **403 Forbidden**
            
        - ```FORBIDDEN``` - The authenticated user is not authorized to access
        this resource.


        - **404 Not Found**
            
        - ```NOT_FOUND``` - No comments exist for the specified transaction ID.


        - **429 Too Many Requests**
            
        - ```RATE_LIMIT_EXCEEDED``` - The client has exceeded the permitted
        request rate or quota.


        - **500 Internal Server Error**
            
        - ```UNEXPECTED_ERROR``` - An unexpected internal system error occurred
        while processing the request.


        - **502 Bad Gateway**
            
        - ```UPSTREAM_SERVICE_ERROR``` - An upstream dependency returned an
        invalid or unsuccessful response.


        - **503 Service Unavailable**
            
        - ```SERVICE_UNAVAILABLE``` - The service or a required dependency is
        temporarily unavailable.


        - **504 Gateway Timeout**
            
        - ```UPSTREAM_TIMEOUT``` - A required downstream service did not respond
        within the configured timeout.


        #### Standard Error Response


        All error responses conform to the standard ```ErrorResponse``` schema
        and include:


        - A stable error code from ```ErrorInfo.code```.

        - A human-readable error message.

        - Optional diagnostic details, when applicable.

        - A timestamp indicating when the error occurred.

        This consistent format enables clients to implement standardized error
        processing, logging, and troubleshooting across all Order Entry API
        endpoints.
      operationId: getComments
      parameters:
        - name: transactionId
          in: path
          description: Unique identifier of the transaction (positive integer encoded as a
            string).
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: Optional 1-based page number. When omitted with pageSize, all
            comments are returned.
          schema:
            type: integer
            description: 1-based page number. Omit both page and pageSize to return all
              comments.
            format: int32
        - name: pageSize
          in: query
          description: Optional page size (1–100). When omitted with page, all comments
            are returned.
          schema:
            type: integer
            description: Number of comments per page (1–100). Omit both page and pageSize to
              return all comments.
            format: int32
      responses:
        "200":
          description: Returns the comments envelope
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetCommentsResponse"
        "400":
          description: >-
            `VALIDATION_ERROR` - The request failed input validation.


            `INVALID_TRANSACTION_ID` - The supplied transaction ID is invalid
            (less than or equal to zero).
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                transactionId: "12345"
                errors:
                  - code: VALIDATION_ERROR
                    description: Validation failed for field '$.unknownField'
                    details: The request contains an unrecognized property. Only documented fields
                      are allowed.
                    timestamp: 2025-01-16T13:21:19.4355657Z
        "401":
          description: "`UNAUTHORIZED` - Authentication failed or the access token is
            missing, expired, or invalid."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                transactionId: "12345"
                errors:
                  - code: UNAUTHORIZED
                    description: Unauthorized access
                    details: The request requires authentication
                    timestamp: 2025-01-16T13:21:19.4355657Z
        "403":
          description: "`FORBIDDEN` - The authenticated user is not authorized to access
            the requested transaction."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                transactionId: "12345"
                errors:
                  - code: FORBIDDEN
                    description: Access denied
                    details: You do not have permission to access this resource
                    timestamp: 2025-01-16T13:21:19.4355657Z
        "404":
          description: >-
            `TRANSACTION_ID_NOT_FOUND` - No transaction exists for the specified
            transaction ID.


            `NOT_FOUND` - The requested transaction or blueprint step could not
            be found.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                transactionId: "12345"
                errors:
                  - code: NOT_FOUND
                    description: Resource not found
                    details: The requested resource could not be found
                    timestamp: 2025-01-16T13:21:19.4355657Z
        "429":
          description: "`RATE_LIMIT_EXCEEDED` - The client has exceeded the permitted
            request rate or quota."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                transactionId: "12345"
                errors:
                  - code: RATE_LIMIT_EXCEEDED
                    description: Request rate limit exceeded
                    details: The client has exceeded the permitted request rate or quota.
                    timestamp: 2025-01-16T13:21:19.4355657Z
        "500":
          description: >-
            `BUILD_BLUEPRINT_ERROR` - An error occurred while generating the
            order entry blueprint.


            `JSON_PARSE_ERROR` - The system encountered an error while parsing
            the transaction response.


            `UNEXPECTED_ERROR` - An unexpected internal system error occurred
            while processing the request.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                transactionId: "12345"
                errors:
                  - code: UNEXPECTED_ERROR
                    description: An unexpected error occurred
                    details: An internal error occurred. Please contact support if the problem
                      persists.
                    timestamp: 2025-01-16T13:21:19.4355657Z
        "502":
          description: "`UPSTREAM_SERVICE_ERROR` - An upstream dependency returned an
            invalid or unsuccessful response."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                transactionId: "12345"
                errors:
                  - code: UPSTREAM_SERVICE_ERROR
                    description: Upstream service error
                    details: An upstream dependency returned an invalid or unsuccessful response.
                    timestamp: 2025-01-16T13:21:19.4355657Z
        "503":
          description: "`SERVICE_UNAVAILABLE` - The service or a required dependency is
            temporarily unavailable."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                transactionId: "12345"
                errors:
                  - code: SERVICE_UNAVAILABLE
                    description: Service unavailable
                    details: The service or a required dependency is temporarily unavailable.
                    timestamp: 2025-01-16T13:21:19.4355657Z
        "504":
          description: "`UPSTREAM_TIMEOUT` - A required downstream service did not respond
            within the configured timeout."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                transactionId: "12345"
                errors:
                  - code: UPSTREAM_TIMEOUT
                    description: Upstream timeout
                    details: A required downstream service did not respond within the configured
                      timeout.
                    timestamp: 2025-01-16T13:21:19.4355657Z
security:
  - openIdConnect: []
components:
  schemas:
    GetCommentsResponse:
      type: object
      properties:
        caseId:
          type: string
          description: Case identifier associated with the transaction
          nullable: true
        data:
          allOf:
            - $ref: "#/components/schemas/CommentsData"
          description: Comments data payload
        isSuccess:
          type: boolean
          description: Indicates whether the operation was successful
        message:
          type: string
          description: Human-readable message describing the result
          nullable: true
        status:
          type: string
          description: Status code of the operation
          nullable: true
      additionalProperties: false
      example:
        caseId: CASE-2026-001234
        data:
          comments:
            - commentId: "54321"
              commentSource: OrderEntryUI
              commentText: Customer requested a follow-up call before submission.
              createdDateTime: 2026-04-21T09:15:00Z
              lastUpdatedDateTime: 2026-04-21T09:15:00Z
              logonID: jdoe
              statusAtStep: InProgress
              statusDisplayName: In Progress
              stepTitle: Owner Information
              userName: Jane Doe
          totalCount: 1
          page: 1
          pageSize: 20
        isSuccess: true
        message: Comments retrieved successfully.
        status: Success
    ErrorResponse:
      required:
        - errors
        - transactionId
      type: object
      properties:
        transactionId:
          minLength: 1
          type: string
        errors:
          type: array
          items:
            $ref: "#/components/schemas/ErrorInfo"
      additionalProperties: false
      example:
        transactionId: "12345"
        errors:
          - code: UNAUTHORIZED
            description: Unauthorized access
            details: The request requires authentication
            timestamp: 2025-01-16T13:21:19.4355657Z
    CommentsData:
      type: object
      properties:
        comments:
          type: array
          items:
            $ref: "#/components/schemas/CommentItem"
          description: List of comments for the current page
          nullable: true
        totalCount:
          type: integer
          description: Total number of comments for the transaction across all pages
          format: int32
        page:
          type: integer
          description: Current page number (1-based). Present when pagination query
            parameters are supplied.
          format: int32
          nullable: true
        pageSize:
          type: integer
          description: Number of comments per page. Present when pagination query
            parameters are supplied.
          format: int32
          nullable: true
      additionalProperties: false
    ErrorInfo:
      required:
        - code
        - timestamp
      type: object
      properties:
        code:
          enum:
            - VALIDATION_ERROR
            - INVALID_TRANSACTION_ID
            - INVALID_STEP_NAME
            - TRANSACTION_CREATION_FAILED
            - TRANSACTION_ID_NOT_FOUND
            - SAVE_TRANSACTION_ERROR
            - SAVE_TRANSACTION_FAILED
            - INVALID_RESPONSE_FORMAT
            - BUILD_BLUEPRINT_ERROR
            - JSON_PARSE_ERROR
            - TRANSFORMER_NULL_RESPONSE
            - EMPTY_BLUEPRINT
            - UNEXPECTED_ERROR
            - SERVICE_ERROR
            - UNAUTHORIZED
            - FORBIDDEN
            - NOT_FOUND
            - RATE_LIMIT_EXCEEDED
            - UPSTREAM_SERVICE_ERROR
            - SERVICE_UNAVAILABLE
            - UPSTREAM_TIMEOUT
            - FIRST_STEP_SETUP_FAILED
            - METHOD_NOT_ALLOWED
          type: string
          description: Backend error codes returned by the Order Entry API indicating
            validation failures, transaction issues, blueprint generation
            errors, authorization errors, or unexpected system failures.
        description:
          type: string
          nullable: true
        details:
          type: string
          nullable: true
        timestamp:
          type: string
          format: date-time
      additionalProperties: false
      example:
        code: VALIDATION_ERROR
        description: Validation failed for field '$.fieldName'
        details: The request contains an unrecognized property. Only documented fields
          are allowed.
        timestamp: 2024-01-15T10:30:00.000Z
    CommentItem:
      type: object
      properties:
        commentId:
          type: string
          description: Unique identifier of the comment (positive integer encoded as a
            string)
          nullable: true
        commentSource:
          type: string
          description: Source system or user group that authored the comment
          nullable: true
        commentText:
          type: string
          description: Free-form comment text
          nullable: true
        createdDateTime:
          type: string
          description: Date and time the comment was created
          nullable: true
        lastUpdatedDateTime:
          type: string
          description: Date and time the comment was last updated
          nullable: true
        logonID:
          type: string
          description: Logon identifier of the user who authored the comment
          nullable: true
        statusAtStep:
          type: string
          description: Status code of the transaction at the step the comment was added
          nullable: true
        statusDisplayName:
          type: string
          description: Display name for the status at the step the comment was added
          nullable: true
        stepTitle:
          type: string
          description: Title of the wizard step the comment was added on
          nullable: true
        userName:
          type: string
          description: Name of the user who authored the comment
          nullable: true
      additionalProperties: false
  securitySchemes:
    openIdConnect:
      type: openIdConnect
      description: "OpenID Connect via Auth0. Clients present a JWT bearer token
        issued by the tenant in the `Authorization: Bearer <token>` header."
      openIdConnectUrl: https://login.qa.zinnia.com/.well-known/openid-configuration
      x-kong-security-openid-connect:
        config:
          auth_methods:
            - bearer
          verify_signature: true
          ignore_signature: []
          consumer_claim:
            - sub
          consumer_optional: true
````