CorefinityCorefinityDocs
Open the Control PanelControl Panel
Orders · 2 of 2

List your orders

Answers your company's orders for new sites and CoreClusters, newest first, 25 a page, with how many there are in each state; the company's owner and its billing contacts see every order with who placed it. kind, user_id and search narrow the rows and the counts alike, and total counts every order whatever the filters. Paged by cursor: send next_cursor back as cursor; null means the last page.

GET/api/corestack/orders

Query parameters

statestring

Only orders in this state. open is in progress or being built; ended is cancelled or expired. Defaults to all.

allopencompletedfailedended
kindstring

Only orders for a site, or only orders for a CoreCluster.

sitecluster
user_idinteger

Only orders placed by this person, an id from placers. At least 1.

searchstring

An order number, a domain or a CoreCluster's name. Up to 100 characters.

cursorstring

The next_cursor of the previous answer. Anything that is not a whole number is refused 422 on cursor.

Returns

200 A page of orders.

Fields of the 200 answer
next_cursorstring or nullRequired

Send as cursor to read the next page. Null on the last page.

companyobjectRequired
Fields
namestringRequired
countsobjectRequired

How many orders are in each state, after kind, user_id and search.

Fields
allintegerRequired
completedintegerRequired
endedintegerRequired
failedintegerRequired
openintegerRequired
dataarray of objectsRequired
Fields of each item
continue_hrefstring or nullRequired

For your own order in progress, where to carry on.

created_atstring or nullRequired

Format: date-time.

ended_atstring or nullRequired

When the order completed, failed, was cancelled or expired. Format: date-time.

idintegerRequired

The order number. At least 1.

labelstringRequired
in_progressbuildingcompletedfailedcancelledexpired
linestring or nullRequired
csccnull
line_labelstring or nullRequired
minebooleanRequired

Whether you placed it. Only the person who placed an order can continue it.

namestring or nullRequired

The site's domain or the CoreCluster's name.

packagestring or nullRequired
phasestring or nullRequired

For an order being built, how far it is.

requestingretryingno_roomnull
placed_atstring or nullRequired

When the order was placed. null for one that was not. Format: date-time.

placed_byobject or any or nullRequired
platformstring or nullRequired

The platform of a CoreStack site, by its name.

reasonstringRequired

Where the order stands, in a sentence.

regionobject or any or nullRequired
restart_hrefstring or nullRequired

For an order that was cancelled, expired or failed, the order page with the same choices made.

status_hrefstringRequired

The order's status page, as a path.

stepstring or nullRequired

For an order in progress, the step it stopped at.

packageupgradesaccountverifybillingreviewnull
step_labelstring or nullRequired
targetobject or any or nullRequired

For a completed order, the site or CoreCluster it made, with its page in the Control Panel.

trial_ends_atstring or nullRequired

Format: date-time.

vatobjectRequired
Fields
check_openbooleanRequired

Whether Corefinity still has to check the order's VAT.

kindstring or nullRequired
statusstring or nullRequired
placersarray of objectsRequired

The people who placed one of the orders.

Fields of each item
idintegerRequired

At least 1.

namestringRequired
start_hrefstringRequired

Where a new order starts, as a path.

totalintegerRequired

How many orders there are, whatever the filters.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403orders_forbiddenOrders are for the organisation's owner and people with a billing role. Ask one of them.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404feature_offThis feature is not on for your organisation yet.
422invalidFix the field named in field; errors says why.
429rate_limitedWait for the seconds in Retry-After.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl https://manage.corefinity.com/api/corestack/orders \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "company": {
    "name": "Northwind Digital"
  },
  "counts": {
    "all": 3,
    "completed": 1,
    "ended": 1,
    "failed": 0,
    "open": 1
  },
  "data": [
    {
      "continue_href": null,
      "created_at": "2027-01-18T09:31:00Z",
      "ended_at": null,
      "id": 4227,
      "label": "building",
      "line": "cs",
      "line_label": "CoreStack",
      "mine": true,
      "name": "journal.harbourandfinch.example.com",
      "package": "CS2",
      "phase": "requesting",
      "placed_at": "2027-01-18T09:40:00Z",
      "placed_by": {
        "name": "Maya Okafor"
      },
      "platform": "WordPress",
      "reason": "Placed · your site is being requested",
      "region": {
        "key": "uk",
        "label": "United Kingdom"
      },
      "restart_href": null,
      "status_href": "/order/status/4227",
      "step": null,
      "step_label": null,
      "target": null,
      "trial_ends_at": null,
      "vat": {
        "check_open": false,
        "kind": null,
        "status": null
      }
    },
    {
      "continue_href": null,
      "created_at": "2027-01-10T10:48:00Z",
      "ended_at": "2027-01-10T11:20:00Z",
      "id": 4218,
      "label": "completed",
      "line": "cc",
      "line_label": "CoreCluster",
      "mine": true,
      "name": "Northwind UK 1",
      "package": "CC8",
      "phase": null,
      "placed_at": "2027-01-10T11:02:00Z",
      "placed_by": {
        "name": "Maya Okafor"
      },
      "platform": null,
      "reason": "Completed on 10 Jan 2027",
      "region": {
        "key": "uk",
        "label": "United Kingdom"
      },
      "restart_href": null,
      "status_href": "/order/status/4218",
      "step": null,
      "step_label": null,
      "target": {
        "href": "/managed-clusters/clusters/1017",
        "kind": "cluster",
        "name": "Northwind UK 1"
      },
      "trial_ends_at": null,
      "vat": {
        "check_open": false,
        "kind": null,
        "status": null
      }
    },
    {
      "continue_href": null,
      "created_at": "2027-01-04T08:00:00Z",
      "ended_at": "2027-01-05T08:00:00Z",
      "id": 4209,
      "label": "expired",
      "line": "cs",
      "line_label": "CoreStack",
      "mine": true,
      "name": "harbourandfinch.example.com",
      "package": "CS2",
      "phase": null,
      "placed_at": null,
      "placed_by": {
        "name": "Maya Okafor"
      },
      "platform": "WordPress",
      "reason": "Not placed before it expired",
      "region": {
        "key": "uk",
        "label": "United Kingdom"
      },
      "restart_href": "/order?package=CS2&platform=wordpress&region=uk&currency=GBP&new=1",
      "status_href": "/order/status/4209",
      "step": null,
      "step_label": null,
      "target": null,
      "trial_ends_at": null,
      "vat": {
        "check_open": false,
        "kind": null,
        "status": null
      }
    }
  ],
  "next_cursor": null,
  "placers": [
    {
      "id": 2051,
      "name": "Maya Okafor"
    }
  ],
  "start_href": "/order?new=1",
  "total": 3
}
Try it
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT