Update Equity Order

Update a Single Non-Discretionary, Single CAT, Block, or Equity Allocation Order.

POST

/trading-api/v1/equityorder/update-equity-order

Request

A request to this endpoint includes a required JSON body and optional url query parameters.

Query Parameters

Name	Data Type	Description
verifyOnly	Boolean	Allows users to review the response of an order without creating the order

Request Body

The Request to update an Equity Order includes several required fields. This ensures that the created order has all necessary parameters for the order to return with no errors. All fields in the request, other than the orderId field, can be updated. If the field is not being updated, the Update field must reflect that of the inputted field from the original orderId .

This request must consist of the below Stonex identifiers:

Schema

Attribute	Data Type	Description
orderId	String	Assigned Order identifier
quantity	Number	New quantity amount
stopPrice	Number	Price assigned to trigger a Stop Order
limitPrice	Number	Price assigned to a Limit order
timeInForce	String	Day, GoodTillCancel, FillorKill, GTXPre, NTE

Example

{
  "orderId": "00000000-0000-0000-0000-000000000000",
  "quantity": 0,
  "stopPrice": 0,
  "limitPrice": 0,
  "timeInForce": "Day"
}

Response

The endpoint will return a JSON body.

Successful Response

The response for a Successful request will look like:

Schema

Attributes	Data Type	Description
statusCode	Integer	Code identifies success of request
message	String	Outcome of request
data	Data Block	Main field containing information of request
errors	Errors	API errors
traceId	String	Unique identifier
hasErrors	Boolean	True or False

Example

{
  "statusCode": 200,
  "message": "string",
  "data": {
    "orderId": "00000000-0000-0000-0000-000000000000",
    "orderNumber": "00000000",
    "orderType": "Single",
    "action": "Buy",
    "timeInForce": "Day",
    "orderStatus": "Verification",
    "securityIdentifier": {
      "securityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "securityNumber": "string",
      "sourceSystem": "string",
      "symbol": "string",
      "underlyingSymbol": "string",
      "isin": "string",
      "sedol": "string",
      "cusip": "string",
      "description": "string",
      "strikePrice": 0,
      "expirationDate": "2024-05-10T19:29:23.792Z",
      "displaySymbol": "string"
    },
    "quantity": 0,
    "filledQuantity": 0,
    "stopPrice": 0,
    "limitPrice": 0,
    "onClose": false,
    "solicited": false,
    "notHeld": false,
    "tradeInfo": {
      "buyingPower": 0,
      "estimatedSettlementDate": "2024-05-10T19:29:23.792Z",
      "estimatedPrincipal": 0,
      "estimatedNetTotal": 0,
      "estimatedCommission": 0,
      "estimatedHandlingFee": 0,
      "estimatedPostageFee": 0,
      "estimatedSecFee": 0,
      "estimatedFirmFee": 0,
      "estimatedPrice": 0,
      "actualPrincipal": 0,
      "actualNetTotal": 0,
      "actualCommission": 0,
      "actualHandlingFee": 0,
      "actualPostageFee": 0,
      "actualSecFee": 0,
      "actualPrice": 0
    },
    "averageTradePriceAmount": 0,
    "orderWarnings": [
      "string"
    ],
    "orderError": {
      "code": "string",
      "target": "string",
      "message": "string",
      "details": [
        "string"
      ]
    },
    "enteredDate": "2024-05-10T19:29:23.792Z",
    "completedDate": "2024-05-10T19:29:23.792Z"
  },
  "errors": [
    {
      "code": "string",
      "field": "string",
      "reason": "string"
    }
  ],
  "traceId": "string",
  "hasErrors": true
}