IMMIX · Schema

CancelOrdersResponse

CompanyFinTechStablecoinFXAI

Properties

Name Type Description
orderId string int64 as a decimal JSON string
version string Per-order, monotonic, bumped on every row; a restored snapshot restates the last version. int64 as a decimal JSON string
orgId integer Owner-stamped.
userId integer The submitting user; actors of later commands ride those commands and the envelope's causation, never restamped here. 0 = machine flow, algoInstanceId naming the instance.
accountId integer
credentialId integer The oe credential the owner RESOLVED at submit — the org's live canTrade credential for the account's venue, not the account's own read-only credential. The connector's fold filter is credentialId ∈ m
instrumentId string int64 as a decimal JSON string
bookId stringnull int64 as a decimal JSON string
side object UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKN
orderType object UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKN
timeInForce object UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKN
isPostOnly boolean a boolean; absent reads false
isReduceOnly boolean a boolean; absent reads false
price stringnull money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value's own scale — every fractional digit that scale states, trailing zeros included; neve
qty string money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value's own scale — every fractional digit that scale states, trailing zeros included; neve
status object UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKN
transition object UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKN
provenance object UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKN
reason object The transition's cause when one applies (UNKNOWN otherwise); the raw venue leg rides venueCode/venueText. UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNO
venueCode integernull
cumQty string Derived from the deduplicated execution set — never from the venue's cumulative; rounded by the owner. money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal st
leavesQty string qty - cumQty at a live status; 0 at any terminal. money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value's own scale — every fractional digi
avgPx stringnull Derived from the deduplicated execution set (half-even rounding); 0 = no fills. money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value's own
lastFillQty stringnull The most recent leg reported for this order, for a merged FIX-style rendering (LastQty/LastPx); 0 = none. On a bust or correction it describes the referenced trade, not the surviving fill, and a repor
lastFillPx stringnull money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value's own scale — every fractional digit that scale states, trailing zeros included; neve
venueCumQty stringnull The venue's claimed cumulative — the cross-check watermark behind isExecutionsComplete; -1 = never reported. money (a Decimal on the wire: a scaled integer with its own scale), served as an exact deci
isExecutionsComplete boolean Accounting closure: true if and only if the deduplicated execution set reconciles against the lifecycle (FILLED: the set equals qty; other terminals: the set equals venueCumQty where reported). False
acceptedAtNs string The accept's consensus time, stamped by the owner — the anchor instructFreshnessNs measures from; carried on the record so a restored snapshot keeps the window. int64 as a decimal JSON string
instructedAtNs stringnull First INSTRUCTED evidence time; 0 until instructed. int64 as a decimal JSON string
cancelRequestedAtNs stringnull The venue-async cancel window's base: set by CANCEL_REQUESTED, cleared (0) by CANCEL_REJECTED, mooted by terminals; feeds the pending-cancel backstop timer. Consumers answer 'is a cancel in flight' as
venueTsNs stringnull The per-order venue-time watermark; 0 = no venue evidence yet. int64 as a decimal JSON string
tradingPolicyId integer Which trading policy row — the organisation-wide default or a per-instrument one — the validation ran against.
tradingPolicyVersion string The attribution pin's version half. int64 as a decimal JSON string
reconcileRequestedAtNs stringnull The base of the venue-side reconcile window, the sibling of cancelRequestedAtNs: set by RECONCILE_REQUESTED, cleared (0) by the venue evidence that answers it. Stored rather than derived from the tran
algoInstanceId integernull The algo instance the order belongs to, on every row of a machine-flow order and never restamped; 0 = a human's order, userId naming the submitter.
clientOrderId string The edge key echoed; never the venue key.
externalRef string The venue order id once bound (ACKNOWLEDGED or first evidence carrying it); empty until then.
venueText string The last reason triple's text leg; empty when none.
globalSequence object
unscaled boolean Never present since 0.3.3: every money value on this API states its own scale on the wire — a policy amount or cap since 0.3.3, an order's and an execution's since 0.3.2, a balance's since 0.3.1 — so
View JSON Schema on GitHub

JSON Schema

immix-orders-cancel-orders-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/immix/json-schema/immix-orders-cancel-orders-response-schema.json",
  "title": "CancelOrdersResponse",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/immix-rest-openapi.json#/components/schemas/orders_CancelOrdersResponse",
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "pattern": "^-?[0-9]+$",
      "description": "int64 as a decimal JSON string"
    },
    "version": {
      "type": "string",
      "pattern": "^-?[0-9]+$",
      "description": "Per-order, monotonic, bumped on every row; a restored snapshot restates the last version. int64 as a decimal JSON string"
    },
    "orgId": {
      "type": "integer",
      "description": "Owner-stamped."
    },
    "userId": {
      "type": "integer",
      "description": "The submitting user; actors of later commands ride those commands and the envelope's causation, never restamped here. 0 = machine flow, algoInstanceId naming the instance."
    },
    "accountId": {
      "type": "integer"
    },
    "credentialId": {
      "type": "integer",
      "description": "The oe credential the owner RESOLVED at submit — the org's live canTrade credential for the account's venue, not the account's own read-only credential. The connector's fold filter is credentialId ∈ mine."
    },
    "instrumentId": {
      "type": "string",
      "pattern": "^-?[0-9]+$",
      "description": "int64 as a decimal JSON string"
    },
    "bookId": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^-?[0-9]+$",
      "description": "int64 as a decimal JSON string"
    },
    "side": {
      "$ref": "#/$defs/OrderUpdatedSide",
      "description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict"
    },
    "orderType": {
      "$ref": "#/$defs/OrderUpdatedOrderType",
      "description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict"
    },
    "timeInForce": {
      "$ref": "#/$defs/OrderUpdatedTimeInForce",
      "description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict"
    },
    "isPostOnly": {
      "type": "boolean",
      "description": "a boolean; absent reads false"
    },
    "isReduceOnly": {
      "type": "boolean",
      "description": "a boolean; absent reads false"
    },
    "price": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^-?[0-9]+(\\.[0-9]+)?$",
      "maxLength": 64,
      "description": "money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value's own scale — every fractional digit that scale states, trailing zeros included; never raw; null when the 0 sentinel means unset"
    },
    "qty": {
      "type": "string",
      "pattern": "^-?[0-9]+(\\.[0-9]+)?$",
      "maxLength": 64,
      "description": "money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value's own scale — every fractional digit that scale states, trailing zeros included; never raw"
    },
    "status": {
      "$ref": "#/$defs/OrderUpdatedStatus",
      "description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict"
    },
    "transition": {
      "$ref": "#/$defs/OrderUpdatedTransition",
      "description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict"
    },
    "provenance": {
      "$ref": "#/$defs/OrderUpdatedProvenance",
      "description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict"
    },
    "reason": {
      "$ref": "#/$defs/OrderUpdatedReason",
      "description": "The transition's cause when one applies (UNKNOWN otherwise); the raw venue leg rides venueCode/venueText. UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict"
    },
    "venueCode": {
      "type": [
        "integer",
        "null"
      ]
    },
    "cumQty": {
      "type": "string",
      "pattern": "^-?[0-9]+(\\.[0-9]+)?$",
      "maxLength": 64,
      "description": "Derived from the deduplicated execution set — never from the venue's cumulative; rounded by the owner. money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value's own scale — every fractional digit that scale states, trailing zeros included; never raw"
    },
    "leavesQty": {
      "type": "string",
      "pattern": "^-?[0-9]+(\\.[0-9]+)?$",
      "maxLength": 64,
      "description": "qty - cumQty at a live status; 0 at any terminal. money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value's own scale — every fractional digit that scale states, trailing zeros included; never raw"
    },
    "avgPx": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^-?[0-9]+(\\.[0-9]+)?$",
      "maxLength": 64,
      "description": "Derived from the deduplicated execution set (half-even rounding); 0 = no fills. money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value's own scale — every fractional digit that scale states, trailing zeros included; never raw; null when the 0 sentinel means unset"
    },
    "lastFillQty": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^-?[0-9]+(\\.[0-9]+)?$",
      "maxLength": 64,
      "description": "The most recent leg reported for this order, for a merged FIX-style rendering (LastQty/LastPx); 0 = none. On a bust or correction it describes the referenced trade, not the surviving fill, and a report about no leg carries the previous value forward — read cumQty/avgPx, never this pair, for what the set currently stands behind. money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value's own scale — every fractional digit that scale states, trailing zeros included; never raw; null when the 0 sentinel means unset"
    },
    "lastFillPx": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^-?[0-9]+(\\.[0-9]+)?$",
      "maxLength": 64,
      "description": "money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value's own scale — every fractional digit that scale states, trailing zeros included; never raw; null when the 0 sentinel means unset"
    },
    "venueCumQty": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^-?[0-9]+(\\.[0-9]+)?$",
      "maxLength": 64,
      "description": "The venue's claimed cumulative — the cross-check watermark behind isExecutionsComplete; -1 = never reported. money (a Decimal on the wire: a scaled integer with its own scale), served as an exact decimal string at the value's own scale — every fractional digit that scale states, trailing zeros included; never raw; null when the -1 sentinel means unset"
    },
    "isExecutionsComplete": {
      "type": "boolean",
      "description": "Accounting closure: true if and only if the deduplicated execution set reconciles against the lifecycle (FILLED: the set equals qty; other terminals: the set equals venueCumQty where reported). False keeps the reconcile lane chasing fills — a venue's terminal status stands while this is false. a boolean; absent reads false"
    },
    "acceptedAtNs": {
      "type": "string",
      "pattern": "^-?[0-9]+$",
      "description": "The accept's consensus time, stamped by the owner — the anchor instructFreshnessNs measures from; carried on the record so a restored snapshot keeps the window. int64 as a decimal JSON string"
    },
    "instructedAtNs": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^-?[0-9]+$",
      "description": "First INSTRUCTED evidence time; 0 until instructed. int64 as a decimal JSON string"
    },
    "cancelRequestedAtNs": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^-?[0-9]+$",
      "description": "The venue-async cancel window's base: set by CANCEL_REQUESTED, cleared (0) by CANCEL_REJECTED, mooted by terminals; feeds the pending-cancel backstop timer. Consumers answer 'is a cancel in flight' as live status AND nonzero here — there is no PENDING_CANCEL status to watch for. int64 as a decimal JSON string"
    },
    "venueTsNs": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^-?[0-9]+$",
      "description": "The per-order venue-time watermark; 0 = no venue evidence yet. int64 as a decimal JSON string"
    },
    "tradingPolicyId": {
      "type": "integer",
      "description": "Which trading policy row — the organisation-wide default or a per-instrument one — the validation ran against."
    },
    "tradingPolicyVersion": {
      "type": "string",
      "pattern": "^-?[0-9]+$",
      "description": "The attribution pin's version half. int64 as a decimal JSON string"
    },
    "reconcileRequestedAtNs": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^-?[0-9]+$",
      "description": "The base of the venue-side reconcile window, the sibling of cancelRequestedAtNs: set by RECONCILE_REQUESTED, cleared (0) by the venue evidence that answers it. Stored rather than derived from the transition, because a restored snapshot restates every row as SNAPSHOT and a derived window would differ on a warm-started member. Consumers answer 'is a reconcile outstanding' as non-zero here — never by watching for a transition. int64 as a decimal JSON string"
    },
    "algoInstanceId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The algo instance the order belongs to, on every row of a machine-flow order and never restamped; 0 = a human's order, userId naming the submitter."
    },
    "clientOrderId": {
      "type": "string",
      "description": "The edge key echoed; never the venue key."
    },
    "externalRef": {
      "type": "string",
      "description": "The venue order id once bound (ACKNOWLEDGED or first evidence carrying it); empty until then."
    },
    "venueText": {
      "type": "string",
      "description": "The last reason triple's text leg; empty when none."
    },
    "globalSequence": {
      "$ref": "#/$defs/GlobalSequenceValue"
    },
    "unscaled": {
      "type": "boolean",
      "description": "Never present since 0.3.3: every money value on this API states its own scale on the wire — a policy amount or cap since 0.3.3, an order's and an execution's since 0.3.2, a balance's since 0.3.1 — so a row is never served raw, whether or not this member holds the asset or instrument it references. Kept, deprecated, so a client generated from 0.3.2 still compiles; it goes at the next major.",
      "deprecated": true
    }
  },
  "required": [
    "orderId",
    "version",
    "orgId",
    "userId",
    "accountId",
    "credentialId",
    "instrumentId",
    "side",
    "orderType",
    "timeInForce",
    "qty",
    "status",
    "transition",
    "provenance",
    "reason",
    "cumQty",
    "leavesQty",
    "acceptedAtNs",
    "tradingPolicyId",
    "tradingPolicyVersion",
    "clientOrderId",
    "externalRef",
    "venueText",
    "globalSequence"
  ],
  "$defs": {
    "GlobalSequenceValue": {
      "type": "string",
      "pattern": "^[0-9]+$",
      "description": "The position as a decimal string — the last change this member had applied, orders, balance readings and algo instances included.",
      "title": "GlobalSequenceValue"
    },
    "OrderUpdatedOrderType": {
      "type": "string",
      "enum": [
        "UNKNOWN",
        "LIMIT",
        "MARKET"
      ],
      "description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict",
      "title": "OrderUpdatedOrderType"
    },
    "OrderUpdatedProvenance": {
      "type": "string",
      "enum": [
        "UNKNOWN",
        "OWNER",
        "CONNECTOR",
        "ACK",
        "PUSH",
        "QUERY",
        "SWEEP"
      ],
      "description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict",
      "title": "OrderUpdatedProvenance"
    },
    "OrderUpdatedReason": {
      "type": "string",
      "enum": [
        "UNKNOWN",
        "USER_REQUESTED",
        "VENUE_INITIATED",
        "POST_ONLY_WOULD_CROSS",
        "MMP",
        "SELF_TRADE_PREVENTED",
        "IOC_REMAINDER",
        "FOK_UNFILLED",
        "UNSUPPORTED_AT_VENUE",
        "VENUE_REJECTED",
        "INSTRUCTION_FRESHNESS_EXPIRED",
        "RECONCILE_PROOF",
        "OWNER_TIMEOUT",
        "VENUE_REFERENCE_MISSING"
      ],
      "description": "The transition's cause when one applies (UNKNOWN otherwise); the raw venue leg rides venueCode/venueText. UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict",
      "title": "OrderUpdatedReason"
    },
    "OrderUpdatedSide": {
      "type": "string",
      "enum": [
        "UNKNOWN",
        "BUY",
        "SELL"
      ],
      "description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict",
      "title": "OrderUpdatedSide"
    },
    "OrderUpdatedStatus": {
      "type": "string",
      "enum": [
        "UNKNOWN",
        "QUEUED",
        "INSTRUCTED",
        "OPEN",
        "PARTIALLY_FILLED",
        "FILLED",
        "CANCELED",
        "REJECTED",
        "EXPIRED",
        "INSTRUCTION_EXPIRED",
        "EXPIRED_UNCONFIRMED",
        "NOT_FOUND_AT_VENUE"
      ],
      "description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict",
      "title": "OrderUpdatedStatus"
    },
    "OrderUpdatedTimeInForce": {
      "type": "string",
      "enum": [
        "UNKNOWN",
        "GTC",
        "IOC",
        "FOK",
        "GTD"
      ],
      "description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict",
      "title": "OrderUpdatedTimeInForce"
    },
    "OrderUpdatedTransition": {
      "type": "string",
      "enum": [
        "UNKNOWN",
        "SUBMITTED",
        "INSTRUCTED",
        "ACKNOWLEDGED",
        "OPENED",
        "TRADE",
        "CANCEL_REQUESTED",
        "CANCEL_REJECTED",
        "CANCELED",
        "REJECTED",
        "EXPIRED",
        "INSTRUCTION_EXPIRED",
        "EXPIRED_UNCONFIRMED",
        "NOT_FOUND_AT_VENUE",
        "RECONCILE_REQUESTED",
        "RESTATED",
        "SNAPSHOT"
      ],
      "description": "UNKNOWN is the unset sentinel: outputs only — as input, omit the field instead; explicit UNKNOWN refuses 400. The value set is append-only: a consumer READING this field treats an unknown name as UNKNOWN, never as an error; as input an unknown name refuses 400 — the parse is strict",
      "title": "OrderUpdatedTransition"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema 
curl "https://apis.io/api/v1/json-schemas/immix-orders-cancel-orders-response"
All schemas 
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.