{
  "opencollection": "1.0.0",
  "info": {
    "name": "sfc-api Account Orders API",
    "version": "0.1.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Orders",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Estimate an order",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sfcompute.com/preview/v2/order_preview",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "> ⚠️ This endpoint is in [public preview](/preview/roadmap).\n\nEstimate a buy or sell order before placing it."
        },
        {
          "info": {
            "name": "List orders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sfcompute.com/preview/v2/orders",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Filter by order ID (repeatable)."
              },
              {
                "name": "pool",
                "value": "",
                "type": "query",
                "description": "Filter by pool."
              },
              {
                "name": "workspace",
                "value": "",
                "type": "query",
                "description": "Scope the listing to a single workspace (ID, resource path, or name). Ignored when `pool` is given (the pool already names its workspace). Without either, the list spans the whole organization and requires an org-level `Order:List` grant."
              },
              {
                "name": "side",
                "value": "",
                "type": "query"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter by status (repeatable)."
              },
              {
                "name": "created_after",
                "value": "",
                "type": "query"
              },
              {
                "name": "created_before",
                "value": "",
                "type": "query"
              },
              {
                "name": "procurement",
                "value": "",
                "type": "query",
                "description": "Filter to one procurement's orders (ID or resource path). Without it, the list omits procurement orders."
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "Prefix with `-` for descending."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "starting_after",
                "value": "",
                "type": "query",
                "description": "Set to the response's `cursor` to fetch the next page."
              },
              {
                "name": "ending_before",
                "value": "",
                "type": "query",
                "description": "Set to the response's `cursor` to fetch the previous page."
              }
            ]
          },
          "docs": "> ⚠️ This endpoint is in [public preview](/preview/roadmap).\n\nList all orders."
        },
        {
          "info": {
            "name": "Create order",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sfcompute.com/preview/v2/orders",
            "headers": [
              {
                "name": "Idempotency-Key",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "> ⚠️ This endpoint is in [public preview](/preview/roadmap).\n\nPlace a buy or sell order. Orders fill on a single instance SKU matching the order's `requirements`. By default orders fill completely or not at all; set `allow_partial` to permit a partial fill. Order filling is asynchronous; poll `GET /v2/orders/{id}` to check status."
        },
        {
          "info": {
            "name": "Get order",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sfcompute.com/preview/v2/orders/:id",
            "params": [
              {
                "name": "id",
                "value": "ordr_xyz789",
                "type": "path",
                "description": "Order ID"
              }
            ]
          },
          "docs": "> ⚠️ This endpoint is in [public preview](/preview/roadmap).\n\nRetrieve an order by ID."
        },
        {
          "info": {
            "name": "Cancel order",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.sfcompute.com/preview/v2/orders/:id",
            "params": [
              {
                "name": "id",
                "value": "ordr_xyz789",
                "type": "path",
                "description": "Order ID"
              }
            ]
          },
          "docs": "> ⚠️ This endpoint is in [public preview](/preview/roadmap).\n\nRequest cancellation of an order. This is asynchronous — poll `GET /v2/orders/{id}` to confirm the status has changed to cancelled."
        }
      ]
    }
  ],
  "bundled": true
}