AmendOrderRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/btse/main/json-schema/btse-amend-order-request-schema.json",
  "title": "AmendOrderRequest",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/btse-spot-legacy-openapi.yml#/components/schemas/AmendOrderRequest",
  "type": "object",
  "required": [
    "symbol",
    "type"
  ],
  "properties": {
    "symbol": {
      "type": "string",
      "description": "Market symbol"
    },
    "orderID": {
      "type": "string",
      "description": "Internal order ID. Required if `clOrderID` is not provided. Takes precedence over `clOrderID` if both are provided"
    },
    "clOrderID": {
      "type": "string",
      "description": "Custom order ID. Required if `orderID` is not provided"
    },
    "type": {
      "type": "string",
      "enum": [
        "PRICE",
        "SIZE",
        "TRIGGERPRICE",
        "ALL"
      ],
      "description": "Amendment type: `PRICE` (amend price, use `value`) · `SIZE` (amend size, use `value`) · `TRIGGERPRICE` (amend trigger price, use `value`) · `ALL` (amend multiple fields, use `orderPrice`/`orderSize`/`triggerPrice`)"
    },
    "value": {
      "type": "number",
      "description": "New value. Required for `PRICE`, `SIZE`, or `TRIGGERPRICE` amendment types"
    },
    "orderPrice": {
      "type": "number",
      "description": "New order price. Used when `type` is `ALL`"
    },
    "orderSize": {
      "type": "number",
      "description": "New order size. Used when `type` is `ALL`"
    },
    "triggerPrice": {
      "type": "number",
      "description": "New trigger price (trigger orders only). Used when `type` is `ALL`"
    }
  }
}