HeldSway

Conversions (Orders & Commissions)

Dashboard (UI)

Navigate to Sidebar → Orders & Commissions (/orders).

Metric Meaning
Total Orders Number of tracked conversions
Total Revenue Gross revenue attributed to affiliates
Total Commission Total commissions owed
Pending Commissions awaiting approval
Approved Commissions approved for payout

Conversion Status Workflow:

Pending ──► Approved
Pending ──► Rejected
Pending ──► Cancelled

Once Approved, Rejected, or Cancelled — status is terminal.

Click “Export CSV” to download all orders as a spreadsheet.

Orders & Commissions REST API

Endpoints:

Method Path Scope Description
GET /v1/orders orders:read List orders (paginated)
GET /v1/orders/stats orders:read Aggregated statistics
GET /v1/orders/export orders:read CSV export
GET /v1/orders/{id} orders:read Single order detail
POST /v1/orders/{id}/approve orders:write Approve a pending order
POST /v1/orders/{id}/reject orders:write Reject a pending order
POST /v1/orders/bulk-approve orders:write Bulk approve up to 100 orders
POST /v1/orders/bulk-reject orders:write Bulk reject up to 100 orders

List Orders:

curl "https://api.heldsway.com/api//v1/orders?status=pending&sort=order_total&direction=desc&per_page=10" \
  -H "Authorization: Bearer <access_token>"

Get Stats:

curl "https://api.heldsway.com/api//v1/orders/stats?from=2026-04-01&to=2026-04-30" \
  -H "Authorization: Bearer <access_token>"

{
  "data": {
    "total_orders": 2,
    "total_revenue": 210.00,
    "total_commission": 14.00,
    "pending_commission": 0.00,
    "approved_commission": 14.00
  }
}

Approve an Order:

curl -X POST "https://api.heldsway.com/api//v1/orders/42/approve" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{ "notes": "Verified payment received" }'

Bulk Approve:

curl -X POST "https://api.heldsway.com/api//v1/orders/bulk-approve" \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{ "ids": [42, 43, 44] }'
← Analytics & ReportsReferral Links →