List orders
⚠️ This endpoint is in public preview.
List all orders.
Query parameters
Filter by order ID (repeatable).
[ "ordr_k3R-nX9vLm7Qp2Yw5Jd8F" ]
A resource path like 'sfc:capacity:acme:prod:my-capacity' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.
Filter by capacity.
Filter by status (repeatable).
Unix timestamp.
Unix timestamp.
A resource path like 'sfc:procurement:acme:prod:my-procurement' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.
Filter to one procurement's orders (ID or resource path). Without it, the list omits procurement orders.
Prefix with - for descending.
Set to the response's cursor to fetch the next page.
Set to the response's cursor to fetch the previous page.
Response
Paginated list of orders.
Example response
{
"object": "list",
"cursor": "ordrc_gqXR7s0Kj5mHvE2wNpLc4Q",
"data": [
{
"object": "order",
"id": "ordr_k3R-nX9vLm7Qp2Yw5Jd8F",
"capacity": {
"id": "cap_k3R-nX9vLm7Qp2Yw5Jd8F",
"name": "my-resource-name"
},
"instance_sku": {
"id": "isku_k3R-nX9vLm7Qp2Yw5Jd8F",
"name": "my-resource-name"
},
"allocation_schedule_delta": [
{
"start_at": 1738972800,
"end_at": 1738972800
}
],
"limit_price_dollars_per_node_hour": "2.500000",
"created_at": 1738972800,
"filled_at": 1738972800,
"filled_average_price_dollars_per_node_hour": "2.500000",
"fills": [
{
"contract": "cont_k3R-nX9vLm7Qp2Yw5Jd8F",
"filled_at": 1738972800,
"allocation_schedule_delta": [
{
"start_at": 1738972800,
"end_at": 1738972800
}
],
"price_dollars_per_node_hour": "2.500000"
}
],
"cancelled_at": 1738972800
}
]
}Changes
Changed in 2 of the 44 revisions of this API.14
- ●
removed the optional property
data/items/filled_price_dollars_per_node_hourfrom the response with the200statusresponse-optional-property-removed
- ○
added the optional property
data/items/filled_average_price_dollars_per_node_hourto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/items/filled_quantityto the response with the200statusresponse-optional-property-added
- ○
added the optional property
data/items/fillsto the response with the200statusresponse-optional-property-added
- ●
- ○
endpoint added
endpoint-added
This revision also has 20 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○