API Documentation

Get Order Status

Retrieve the current status and details of an order by its ID or token. Use this to poll for fulfillment progress after placing an order via the API or MCP.

Request

GET /api/v1/orders/:id

The :id parameter accepts either the order ID (MongoDB ObjectId) or the order token (UUID).

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY

Required Scope

  • vps:provision for VPS orders
  • domains:provision for domain orders

Response

{
  "data": {
    "id": "507f1f77bcf86cd799439011",
    "token": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "status": "COMPLETED",
    "type": "DOMAIN",
    "channel": "api",
    "totalNet": 0.00,
    "totalGross": 0.00,
    "currency": "EUR",
    "interval": "12 months",
    "provisionedResourceId": "507f1f77bcf86cd799439022",
    "provisionedAt": "2026-03-29T12:00:00.000Z",
    "createdAt": "2026-03-29T11:59:00.000Z",
    "updatedAt": "2026-03-29T12:00:00.000Z"
  }
}

Response Fields

Field Type Description
id string Order ID
token string Order token (UUID)
status string Current status (see below)
type string Order type: VM or DOMAIN
channel string Origin channel: shop, api, or mcp
totalNet number Net price (excluding VAT)
totalGross number Gross price (including VAT)
currency string Currency code (EUR)
interval string Billing interval (e.g. 1 month, 12 months)
provisionedResourceId string|null ID of the provisioned VPS or domain (set after fulfillment)
provisionedAt string|null ISO 8601 timestamp of when provisioning completed
createdAt string ISO 8601 timestamp of order creation
updatedAt string ISO 8601 timestamp of last update

Order Statuses

Status Description
PENDING Payment initiated, awaiting confirmation
PROCESSING Payment confirmed, provisioning in progress
COMPLETED Fully provisioned and active
FAILED Payment failed
CANCELED Order was canceled
PROVISION_FAILED Payment succeeded but provisioning failed (refund issued)
EXPIRED Order expired before payment

Error Responses

Status Code Description
404 NOT_FOUND Order not found or does not belong to the authenticated user
403 INSUFFICIENT_SCOPE API key lacks the required vps:provision or domains:provision scope

Example

# Get order by ID
curl https://hosting.site.quest/api/v1/orders/507f1f77bcf86cd799439011 \
  -H "Authorization: Bearer sq_live_a94ecfca096d..."

# Get order by token
curl https://hosting.site.quest/api/v1/orders/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer sq_live_a94ecfca096d..."

MCP

This data is also available via the get_order_status MCP tool.