List Items (DataTable)

Retrieve a paginated list of items with extensive filtering.

GET /datatable-items
Query Parameters
Parameter Type Description Example
range integer Items per page ?range=50
page integer Page number ?page=0
sort string Sort field and direction ?sort=lot
filter[sale] string Sale ID ?filter[sale]=456
filter[consignment] string Consignment ID ?filter[consignment]=234
filter[category] string Category ID ?filter[category]=10
filter[status] string Item status (available, sold, unsold, passed, withdrawn) ?filter[status]=sold
filter[lot] string Lot number search ?filter[lot]=1234
filter[description] string Description search (regex) ?filter[description]=vase
filter[estimate_low][value][from] number Min low estimate ?filter[estimate_low][value][from]=100
filter[estimate_low][value][to] number Max low estimate ?filter[estimate_low][value][to]=200
filter[estimate_high][value][from] number Min high estimate ?filter[estimate_high][value][from]=200
filter[estimate_high][value][to] number Max high estimate ?filter[estimate_high][value][to]=300
filter[hammer_price][value][from] number Min hammer price ?filter[hammer_price][value][from]=100
filter[hammer_price][value][to] number Max hammer price ?filter[hammer_price][value][to]=1000
filter[consignor_symbol] string Consignment symbol search ?filter[consignor_symbol]=A
fields string Specific fields ?fields=id,lot,description
Example Requests
GET /api/v1.0/datatable-items?filter[sale]=456&filter[status]=available&range=50&sort=lot
GET /api/v1.0/datatable-items?filter[sale]=456&filter[status]=sold&filter[hammer_price][value][from]=100&filter[hammer_price][value][to]=1000&sort=-hammer_price
GET /api/v1.0/datatable-items?filter[sale]=456&filter[category]=10&range=100
Response
{
  "data": [
    {
      "id": "345",
      "label": "Item #1234",
      "lot": "1234",
      "description": "Beautiful antique vase from the Ming Dynasty",
      "sale": {
        "id": "456",
        "label": "Summer Auction 2025"
      },
      "consignment": {
        "id": "234",
        "symbol": "A",
        "sub_symbol": "1"
      },
      "category": {
        "id": "10",
        "label": "Ceramics"
      },
      "estimate_low": "100.00",
      "estimate_high": "200.00",
      "reserve_price": "80.00",
      "hammer_price": "250.00",
      "status": "sold",
      "winner": {
        "id": "123",
        "label": "John Doe",
        "bidder_number": "12345"
      },
      "images": [
        {
          "id": "1001",
          "url": "https://.../files/item-images/vase-1.jpg",
          "thumbnail": "https://.../files/item-images/vase-1-thumb.jpg"
        }
      ],
      "dimensions": {
        "height": "30cm",
        "width": "15cm",
        "depth": "15cm"
      },
      "created": "2025-09-01T10:00:00Z",
      "updated": "2025-10-15T14:30:00Z"
    }
  ],
  "count": 250
}
Back to API Home