complex-orders

Edit Complex Order

Changed on

Edit the total quantity of an ACTIVE peg order.

total_qty is the new total, not the remaining. The new total is recorded immediately and the peg consumer resizes the resting child in place (queue position is kept on venues that support in-place decreases). A total at or below the quantity already filled closes the peg as EXECUTED. Returns 202; the outcome is recorded on the returned amendment.

patch/v1/complex-orders/{complex_order_id}

Request

  • Base URL
    https://api.rivermarkets.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.rivermarkets.com/v1/complex-orders/{complex_order_id}
  • Auth
    none declared

Path parameters

complex_order_idstring uuid required

Request body

total_qtynumber required

New total quantity (not remaining)

Response

Successful Response

complex_order_idstring uuid required

Unique complex order identifier

total_qtynumber required

Total quantity now recorded on the order

amendment_idstring uuid required

Audit row tracking the edit outcome

Changes