MarketConnect-OrderEntry

Market Connect Order Entry API

Submits the Order Entry case for e-signature with the configured signer roster.

Error Responses

  • 400 Bad Request

  • VALIDATION_ERROR - The request failed input validation.

  • 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

Case submission payload: transaction to submit and the final DocuSign signer roster (selected auth method per signer).

* Additional properties are NOT allowed.
transactionIdinteger(int64)

Transaction (case) identifier to submit for e-signature.

>= 1

signersarray[object]required

Final signer roster with selected auth method and contact details.

>= 1 items

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Returns the case submission result envelope

SaveEsignatureResponse

* Additional properties are NOT allowed.
successboolean

True when the case was submitted to DocuSign for e-signature.

messagestring | null

User-safe confirmation or failure text from the submission result.

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

Body

{ "transactionId": 1131068, "signers": [ { "recipientId": "11306862", "signerAccessCode": "", "signerAuthMethod": "Phone", "signerCountryCode": "1", "signerEmail": "anannya.gupta@everglades.com", "signerEntityRole": "PrimaryOwner", "signerName": "EE EE1", "signerPhoneNo": "8650827071", "signerSequence": "1" }, { "recipientId": "11306935", "signerAccessCode": "", "signerAuthMethod": "Phone", "signerCountryCode": "1", "signerEmail": "", "signerEntityRole": "AgentOfRecord", "signerName": "RR RR", "signerPhoneNo": "8650827071", "signerSequence": "2" } ] }
 
application/json

Cancels the e-signature ceremony for a case (voids the DocuSign envelope and returns the case to Pending upstream).

Error Responses

  • 400 Bad Request

  • VALIDATION_ERROR - The request failed input validation.

  • 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

Identifies the case whose e-signature ceremony should be canceled (void DocuSign; case returns to Pending).

* Additional properties are NOT allowed.
transactionIdstringrequired

String form of the transaction (case) id to cancel; must be a positive integer.

>= 1 characters

Response

application/json

Returns the cancel result envelope

CancelEsignatureCeremonyResponse

* Additional properties are NOT allowed.
successboolean

True when the DocuSign ceremony was voided and the case returned to Pending upstream.

messagestring | null

User-safe message when success is false; may also confirm the outcome when true.

post/market-connect/order-entry/v1/esignature/cancel-ceremony

Body

{ "transactionId": "1131068" }
 
application/json

Retriggers the DocuSign e-signature email notification for a case (only when e-signature is in progress upstream).

Error Responses

  • 400 Bad Request

  • VALIDATION_ERROR - The request failed input validation.

  • 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

Identifies the case whose DocuSign signing notification should be resent (in-progress e-sign only).

* Additional properties are NOT allowed.
transactionIdstringrequired

String form of the transaction (case) id; must be a positive integer.

>= 1 characters

Response

application/json

Returns the retrigger result envelope

RetriggerEsignatureEmailNotificationResponse

* Additional properties are NOT allowed.
successboolean

True when the signing notification was retriggered (e-sign in progress upstream).

messagestring | null

User-safe message; e.g. notification successfully triggered when success is true.

post/market-connect/order-entry/v1/esignature/retrigger-email-notification

Body

{ "transactionId": "1131068" }
 
application/json

Updates signer email or phone for a case while e-signature is pending upstream.

Error Responses

  • 400 Bad Request

  • VALIDATION_ERROR - The request failed input validation.

  • 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

Transaction ID and signer rows with corrected email and/or phone while e-signature is pending upstream.

* Additional properties are NOT allowed.
transactionIdinteger(int64)

Transaction (case) identifier whose signer contact details should be updated.

>= 1

signersarray[object]required

Signer rows with corrected email and/or phone while e-sign is pending.

>= 1 items

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Returns the update result envelope

UpdateEsignSignerDetailsResponse

* Additional properties are NOT allowed.
successboolean

True when signer contact details were updated (e-sign must be pending upstream).

messagestring | null

User-safe message confirming the update or describing a failure.

post/market-connect/order-entry/v1/esignature/update-signer

Body

{ "transactionId": 1131068, "signers": [ { "recipientId": "11306862", "signerEmail": "corrected.email@everglades.com", "signerSequence": "1", "signerAuthMethod": "Phone", "signerCountryCode": "1", "signerPhoneNo": "8650827071" } ] }
 
application/json

Health

Health check operations