List Orders - Circuit Auction API

GET /orders

Query Parameters

Parameter	Type	Description	Example
`range`	integer	Items per page	`?range=25`
`page`	integer	Page number	`?page=1`
`sort`	string	Sort field and direction	`?sort=-order_id`
`filter[type]`	string	Order type (bidder, consignor, credit_note, transport_invoice)	`?filter[type]=bidder`
`filter[status]`	string	Order status (new, in_process, finished, locked, canceled)	`?filter[status]=new`
`filter[sale]`	string	Sale ID	`?filter[sale]=456`
`filter[owner]`	string	Client ID	`?filter[owner]=123`
`filter[order_id]`	string	Order/invoice number	`?filter[order_id]=12345`
`filter[customer_number]`	string	Customer number	`?filter[customer_number]=C12345`
`filter[total_invoice][value][from]`	number	Min amount	`?filter[total_invoice][value][from]=100`
`filter[total_invoice][value][to]`	number	Max amount	`?filter[total_invoice][value][to]=1000`
`filter[payment_received][value][from]`	number	Min paid amount	`?filter[payment_received][value][from]=0`
`filter[payment_received][value][to]`	number	Max paid amount	`?filter[payment_received][value][to]=500`
`filter[bidder_ids]`	string	Bidder number search	`?filter[bidder_ids]=12345`
`filter[payment_type_letter]`	string	Payment method	`?filter[payment_type_letter]=CC`
`filter[sale_name]`	string	Sale name search	`?filter[sale_name]=Summer`
`filter[shipping_weight][value][from]`	number	Min weight (in kg)	`?filter[shipping_weight][value][from]=1`
`filter[shipping_weight][value][to]`	number	Max weight (in kg)	`?filter[shipping_weight][value][to]=10`
`fields`	string	Specific fields to return	`?fields=id,label,status`

Example Requests

GET /api/v1.0/orders?filter[type]=bidder&filter[sale]=456&filter[status]=new&range=25&sort=-order_id

GET /api/v1.0/orders?filter[type]=bidder&filter[total_invoice][value][from]=100&filter[total_invoice][value][to]=1000

GET /api/v1.0/orders?filter[bidder_ids]=12345&range=50

Response

{
  "data": [
    {
      "id": "789",
      "label": "Order #12345",
      "order_id": "12345",
      "type": "bidder",
      "status": {
        "id": "new",
        "label": "New"
      },
      "sale": {
        "id": "456",
        "label": "Summer Auction 2025"
      },
      "owner": {
        "id": "123",
        "label": "John Doe",
        "email": "john@example.com"
      },
      "grand_total": "1250.00",
      "amount_due": "1250.00",
      "payment_received": "0.00",
      "customer_number": "C12345",
      "bidder_ids": ["12345", "12346"],
      "item_count": 5,
      "shipping_weight": 2.5,
      "payment_type_letter": "CC",
      "invoice_data": {
        "header_left": {...},
        "header_right": {...},
        "items": {...},
        "totals_for_display": [...]
      },
      "created": "2025-10-01T10:00:00Z",
      "changed": "2025-10-15T14:30:00Z"
    }
  ],
  "count": 42
}