Modify Order

v1.0.0

Allows the caller to modify the order with the referenced Customer Order ID specified in the URL. A separate Customer Order ID must be provided in the request body for the modification.

Input

{
  "type": "object",
  "properties": {
    "Aux Price": {
      "type": "number",
      "description": "Required Price to support Stop and Stop Limit orders"
    },
    "CustomerOrderId": {
      "type": "string",
      "description": "The new order ID assigned by the customer for the modification."
    },
    "GermanHftAlgo": {
      "type": "boolean",
      "description": "By setting this bool to false the customer attests that the order is not subject to German HFT Act, was not generated using any automated algorithm, and no algorithm determined or changed financial instrument, side, quantity, order type, limit or other price, trading venue or timing of this order. Currently we cannot accept orders where this flag is set to true. Such orders will be rejected."
    },
    "Mifid2Algo": {
      "type": "string",
      "description": "This field permits specification of the user's preregistered (via account management) MiFID II short code for algos that are responsible for investment decisions"
    },
    "Mifid2DecisionMaker": {
      "type": "string",
      "description": "This field permits specification of the user's preregistered (via account management) MiFID II short code for decision makers."
    },
    "Mifid2ExecutionAlgo": {
      "type": "string",
      "description": "This field permits specification of the user's preregistered (via account management) MiFID II short code for algos that are responsible for handling/routing of the order."
    },
    "Mifid2ExecutionTrader": {
      "type": "string",
      "description": "This field permits specification of the user's preregistered (via account management) MiFID II person responsible for handling/routing of the order"
    },
    "Order Type": {
      "type": "number",
      "description": "Market = '1'\nLimit = '2'\nStop = '3'\nStopLimit = '4'\n",
      "enum": [
        1,
        2,
        3,
        4
      ]
    },
    "OrigCustomerOrderId": {
      "type": "string",
      "description": "The order ID assigned by the customer"
    },
    "Outside RTH": {
      "type": "number",
      "description": "Indicates if order is active outside regular trading hours, where defined. 0 = no (default), 1 = yes"
    },
    "Price": {
      "type": "number",
      "description": "The order price"
    },
    "Quantity": {
      "type": "number",
      "description": "The number of units in the order; contracts or shares"
    },
    "Side": {
      "type": "number",
      "description": "Buy = '1', Sell = '2'",
      "enum": [
        1,
        2
      ]
    },
    "Time in Force": {
      "type": "number",
      "description": "Defines order's active lifetime.\nDay = '0'\nGTC (Good till Cancel) = '1'\nIOC (Immediate or Cancel) = '3'\nOpen = '2'\nClose = '7'\n",
      "enum": [
        0,
        1,
        2,
        3,
        7
      ]
    }
  }
}

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "CustomerOrderId": {
        "type": "string"
      },
      "OrderQty": {
        "type": "number"
      },
      "OrderType": {
        "type": "number",
        "description": "Market = '1'\nLimit = '2'\nStop = '3'\nStopLimit = '4'\n",
        "enum": [
          1,
          2,
          3,
          4
        ]
      },
      "Price": {
        "type": "string"
      },
      "Side": {
        "type": "number",
        "enum": [
          1,
          2
        ]
      },
      "Status": {
        "type": "string",
        "description": "Status of the order\nInvalidOrderStatus = '-1'\nNew = '0'\nPartiallyFilled = '1'\nFilled = '2'\nDoneForTheDay = '3'\nCanceled = '4'\nReplaced = '5'\nPendingCancelReplace = '6'\nStopped = '7'\nRejected = '8'\nSuspended = '9'\nPendingNew = 'A'\nCalculated = 'B'\nExpired = 'C'\nAcceptedForBidding = 'D'\nPendingReplace = 'E'\n",
        "enum": [
          "-1",
          "0",
          "1",
          "2",
          "3",
          "4",
          "5",
          "6",
          "7",
          "8",
          "9",
          "A",
          "B",
          "C",
          "D",
          "E"
        ]
      },
      "Symbol": {
        "type": "number"
      },
      "Warning": {
        "type": "string"
      }
    }
  }
}