Skip to main content

Get Sales

GET /api/admin/sales?status=completed&limit=10&page=1
Retrieves a paginated list of orders (sales) with optional filtering by status. Authentication: Admin access required

Query Parameters

status
string
Filter orders by status (e.g., “completed”, “pending”, “refunded”)
limit
number
default:"10"
Number of orders to return per page
page
number
default:"1"
Page number for pagination

Response

success
boolean
Indicates if the request was successful
sales
array
Array of order objects with populated user information
pagination
object

Response Example

{
  "success": true,
  "sales": [
    {
      "orderId": "ORD-123456",
      "userId": {
        "username": "john_doe",
        "email": "[email protected]"
      },
      "total": 299.99,
      "status": "completed",
      "createdAt": "2026-03-04T10:30:00.000Z",
      "txHash": "0xabc123def456...",
      "products": [
        {
          "productId": "prod123",
          "name": "Premium Package",
          "price": 299.99,
          "quantity": 1
        }
      ],
      "walletAddress": "TXYZabc123..."
    }
  ],
  "pagination": {
    "total": 245,
    "page": 1,
    "pages": 25
  }
}

Error Response

{
  "error": "Error message"
}

Build docs developers (and LLMs) love