Developers › API reference › Orders

POST /api/v1/orders/{id}/amend

Amend quantity or limit (compliance re-checked; If-Match).

• Scope orders:write
• Idempotency-Key
• If-Match
• operationId ordersAmend

The token needs the scope orders:write, and the person or service account behind it needs the matching privileges and account permissions, exactly as on the screens. See Scopes.

Request

POST /api/v1/orders/{id}/amend

Path parameters

Headers

Body: OrderAmend

Decimals (money, prices, quantities, percentages) are sent as strings, ids as strings, times as ISO 8601 UTC.

Examples

Keep the token in an environment variable (VESTORIS_TOKEN), never in the script.

curl -X POST "https://vestoris.com/api/v1/orders/5301/amend" \
  -H "Authorization: Bearer $VESTORIS_TOKEN" \
  -H 'Idempotency-Key: 7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11' \
  -H 'If-Match: "3f1a9c0e5b7d2a4c8e6f0b1d3a5c7e9f"' \
  -H "Content-Type: application/json" \
  -d '{"quantity":"1500","limit_price":"231.50","reason":"Client reduced size"}'

import os, requests

r = requests.post(
    "https://vestoris.com/api/v1/orders/5301/amend",
    headers={
        "Authorization": f"Bearer {os.environ['VESTORIS_TOKEN']}",
        "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
        "If-Match": "\"3f1a9c0e5b7d2a4c8e6f0b1d3a5c7e9f\"",
    },
    json={
        "quantity": "1500",
        "limit_price": "231.50",
        "reason": "Client reduced size"
    },
    timeout=30,
)
r.raise_for_status()  # errors are application/problem+json with a stable "code"
print(r.json())

const res = await fetch("https://vestoris.com/api/v1/orders/5301/amend", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.VESTORIS_TOKEN}`,
    "Idempotency-Key": "7f9c2b1e-4d0a-4a7e-9a51-3c2f0b8d6e11",
    "If-Match": "\"3f1a9c0e5b7d2a4c8e6f0b1d3a5c7e9f\"",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
      "quantity": "1500",
      "limit_price": "231.50",
      "reason": "Client reduced size"
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.code}: ${data.detail}`); // problem+json
console.log(data);

Response

200 OK, application/json: Order. With an ETag header. Rate-limit headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Example response

HTTP/1.1 200 OK
Content-Type: application/json
ETag: "3f1a9c0e5b7d2a4c8e6f0b1d3a5c7e9f"

{
    "id": "1042",
    "security_id": "3",
    "symbol": "AAPL",
    "side": "buy",
    "order_type": "limit",
    "limit_price": "232.00",
    "quantity": "1800",
    "filled_quantity": "0",
    "avg_fill_price": "231.52",
    "state": "pending_approval",
    "compliance_state": "pass",
    "is_block": false,
    "algo": "vwap",
    "slices": 4,
    "arrival_price": "231.45",
    "approval_required": true,
    "approval_reason": "Order value $1.25M is above the firm threshold of $1M",
    "status_reason": "Order value above the approval threshold",
    "notes": "Rebalance, Growth accounts",
    "venue": "SIM",
    "created_by": "7",
    "approved_by": null,
    "trader_id": null,
    "pipeline_run_id": null,
    "proposal_id": null,
    "allocations": [
        {
            "account_id": "12",
            "quantity": "1200",
            "filled_quantity": "0"
        }
    ],
    "hidden_allocations": 0,
    "allocated_at": null,
    "created_at": "2026-10-27T14:30:00Z",
    "submitted_at": "2026-10-27T14:30:00Z",
    "approved_at": null,
    "working_at": null,
    "done_at": null,
    "simulated": true,
    "result": {
        "state": "pending_approval",
        "compliance": [],
        "approvals_needed": [
            "portfolio_manager"
        ],
        "needs_override": false,
        "override": null
    },
    "history": [
        {
            "from": "pending_compliance",
            "to": "pending_approval",
            "by": "7",
            "reason": "Above the firm approval threshold",
            "at": "2026-10-27T14:30:00Z"
        }
    ]
}

Example values. Your values depend on your firm's data; prices, orders and fills are simulated.

Status codes and errors

Errors are application/problem+json (RFC 9457) with a stable code to program against; the detail says what to fix. See Errors.

{
    "type": "https://vestoris.com/developers/errors#validation_failed",
    "title": "Validation failed",
    "status": 422,
    "detail": "Quantity must be greater than zero.",
    "code": "validation_failed",
    "instance": "/api/v1/orders/5301/amend"
}

On the screens

The same thing in the app is explained in:

• Orders and the order list
• The trade blotter