API Reference

Update an Omnibus order. Not implemented in the first Omnibus slice.

put
https://sandbox-api.monark-markets.com/primary/v2/omnibus/order/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Internal Monark order identifier.

Body Params

Updated order details.

Request model for updating an Omnibus order once update behavior is implemented.

string
required
length between 1 and 100

Custodian account identifier for the order.

uuid | null

Optional financial advisor associated with the investor's financial institution.

uuid
required
length ≥ 1

Registered fund being traded.

uuid
required
length ≥ 1

Share class being traded. Must belong to the registered fund.

string
enum
required

Order side: buy or sell.

Allowed:
double | null

Share quantity. Required for sell orders and omitted for buy orders.

double | null

Dollar notional amount. Required for buy orders and omitted for sell orders.

string | null

Order currency. Only USD is supported for the first version.

string
enum
required

Distribution election used as part of the position identity.

Allowed:
string
enum
required

Tax lot election for sell order handling.

Allowed:
string
enum
required

Routing instruction for OMS intake.

Allowed:
string | null

Optional client model or rebalance identifier.

string
enum

Time-in-force assigned to the order. Defaults to Day.

Allowed:
date-time | null

Good-through timestamp for GTD orders.

Responses

Updated about 3 hours ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago