MarketConnect-OrderEntry

Market Connect Order Entry API

Saves a comment against the specified transaction.

Error Responses

  • 400 Bad Request

  • VALIDATION_ERROR - The request body failed validation or required fields are missing.

  • INVALID_TRANSACTION_ID - The supplied transaction ID is invalid (not a positive integer).

  • 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 transaction exists 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.
post

Body

application/json

The comment payload to save.

* Additional properties are NOT allowed.
appSubIndicatorstring | null

Indicator identifying whether the comment applies to the application or sub-application

commentSourcestring | null

Source system or user group that authored the comment

commentTextstringrequired

Free-form comment text

>= 1 characters

statusAtStepstring | null

Status code of the transaction at the step the comment was added

statusDisplayNamestring | null

Display name for the status at the step the comment was added

stepTitlestring | null

Title of the wizard step the comment was added on

transactionIdstringrequired

Unique identifier of the transaction the comment belongs to (positive integer encoded as a string)

Match pattern:^[1-9][0-9]*$

>= 1 characters

Response

application/json

Returns the save comment envelope

SaveCommentResponse

* Additional properties are NOT allowed.
caseIdstring | null

Case identifier associated with the transaction. Populated on successful saves.

isSuccessboolean

Indicates whether the operation was successful

messagestring | null

Human-readable message describing the result

statusstring | null

Status code of the operation (e.g., “Success”, “ValidationError”, “Failure”)

post/market-connect/order-entry/v1/comments

Body

{ "appSubIndicator": "App", "commentSource": "OrderEntryUI", "commentText": "Customer requested a follow-up call before submission.", "statusAtStep": "InProgress", "statusDisplayName": "In Progress", "stepTitle": "Owner Information", "transactionId": "1125715" }
 
application/json

Deletes a comment from a transaction.

Error Responses

  • 400 Bad Request

  • VALIDATION_ERROR - The request body failed validation, required fields are missing, or the comment ID is invalid.

  • INVALID_TRANSACTION_ID - The supplied transaction ID is invalid (not a positive integer).

  • 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 comment exists for the specified comment 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.
delete

Body

application/json

The comment and transaction identifiers for the comment to delete.

* Additional properties are NOT allowed.
commentIdstringrequired

Unique identifier of the comment to delete (positive integer encoded as a string)

Match pattern:^[1-9][0-9]*$

>= 1 characters

transactionIdstringrequired

Unique identifier of the transaction the comment belongs to (positive integer encoded as a string)

Match pattern:^[1-9][0-9]*$

>= 1 characters

Response

application/json

Returns the delete comment envelope

DeleteCommentResponse

* Additional properties are NOT allowed.
caseIdstring | null

Case identifier associated with the transaction. Populated on successful deletes.

isSuccessboolean

Indicates whether the operation was successful

messagestring | null

Human-readable message describing the result

statusstring | null

Status code of the operation (e.g., “Success”, “ValidationError”, “Failure”)

delete/market-connect/order-entry/v1/comments

Body

{ "commentId": "54321", "transactionId": "1125715" }
 
application/json

Retrieves the comments for a transaction.

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.
get

Query Parameters

pageinteger(int32)

1-based page number. Omit both page and pageSize to return all comments.

pageSizeinteger(int32)

Number of comments per page (1–100). Omit both page and pageSize to return all comments.

Path Parameters

transactionIdstringrequired

Unique identifier of the transaction (positive integer encoded as a string).

Response

application/json

Returns the comments envelope

GetCommentsResponse

* Additional properties are NOT allowed.
caseIdstring | null

Case identifier associated with the transaction

dataobject

Comments data payload

* Additional properties are NOT allowed.
Show Child Parameters
isSuccessboolean

Indicates whether the operation was successful

messagestring | null

Human-readable message describing the result

statusstring | null

Status code of the operation

get/market-connect/order-entry/v1/comments/{transactionId}
 
application/json

ReviewerAction

Reviewer workflow actions (Approved, Declined, Terminate) forwarded to the product order-entry service

Executes a reviewer action for the given transaction (forwards to the product order-entry service).

Error Responses

  • 400 Bad Request

  • VALIDATION_ERROR - The request failed input validation.

  • INVALID_TRANSACTION_ID - The supplied transaction ID is not a valid value.

  • 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

  • TRANSACTION_ID_NOT_FOUND - No transaction exists 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.
post

Body

application/json

Action and transaction identifier.

ReviewerActionRequest

* Additional properties are NOT allowed.
actionstringrequired

Review outcome: Approved, Declined, or Terminate.

>= 1 characters

transactionIdinteger(int32)required

Order-entry transaction (instance) identifier.

>= 1<= 2147483647

Response

application/json

Returns the reviewer action outcome

ReviewerActionResponse

* Additional properties are NOT allowed.
caseIdinteger | null(int64)

Case identifier returned by the upstream service when available.

isSuccessboolean

True when the reviewer action completed successfully.

messagestring | null

Human-readable outcome message.

statusstring | null

High-level status string returned to the client.

post/market-connect/order-entry/v1/revieweraction

Body

{ "action": "action", "transactionId": 0 }
 
application/json