Circuit Auction Backoffice API Documentation

Comprehensive REST API for managing auction operations including clients, orders, items, sales, and more.

Base URL

https://backoffice.ddev.site/api/v1.0/

Authentication

All endpoints require a Bearer token obtained via the authentication endpoint.

GET /api/login-token

Authenticate using HTTP Basic Authentication to obtain an access token.

Request Headers:
GET /api/login-token HTTP/1.1
Host: backoffice.ddev.site
Authorization: Basic base64(email:password)
Example using JavaScript:
const email = 'user@example.com';
const password = 'securePassword123';
const credentials = btoa(`${email}:${password}`);

const response = await fetch('https://backoffice.ddev.site/api/login-token', {
  method: 'GET',
  headers: {
    'Authorization': `Basic ${credentials}`
  }
});
Example using cURL:
curl -X GET "https://backoffice.ddev.site/api/login-token" \
  -H "Authorization: Basic $(echo -n 'user@example.com:securePassword123' | base64)"
Response:
{
  "data": [{
    "id": "123",
    "token": "abc123def456ghi789jkl012mno345pqr678stu901vwx234yz",
    "type": "access_token",
    "uid": "456",
    "expire": 1735689600
  }]
}
Using the Token:

Use the token value in the Authorization header for all subsequent API requests:

GET /api/v1.0/datatable-clients HTTP/1.1
Host: backoffice.ddev.site
Authorization: Bearer abc123def456ghi789jkl012mno345pqr678stu901vwx234yz
Token Behavior
  • Tokens are reused if a valid unexpired token exists for the user
  • A new token is created only if no valid token exists or if the existing token has expired
  • Check the expire field (Unix timestamp) to know when the token will expire
  • Expired tokens are automatically deleted when attempting to use them
Clients

Manage client records, connections, and merging.

View Clients API
Client Addresses

Manage client addresses, set default addresses, and handle address types.

View Addresses API
Consignments

Manage consignor inventory, commissions, shipping methods, and workflow tracking.

View Consignments API
Orders

Create and manage bidder orders, invoices, credit notes, and payments.

View Orders API
Items

Handle auction items, lots, images, dimensions, and bulk operations.

View Items API
Sales

Manage auctions, sessions, statistics, and catalog parts.

View Sales API
Transactions

Record and manage payment transactions, cheques, and wire transfers.

View Transactions API
Notes

Manage notes and comments attached to items, sales, orders, and clients with document support.

View Notes API
Files & Queue

Handle file uploads, queue monitoring, and bulk operations.

View Files API

Documentation

Common Parameters

Pagination, sorting, filtering, and field selection.

Learn More
Error Handling

Error responses, status codes, and troubleshooting.

Learn More
Data Types

Dates, currency, booleans, and data formats.

Learn More

Key Features

  • Advanced filtering, sorting, and pagination
  • Bulk operations for efficiency
  • File and image uploads
  • Activity logging and audit trails
  • Comprehensive error handling
  • RESTful API design
  • JWT authentication
  • JSON request/response format
  • Queue-based background jobs
  • Rate limiting protection

Available Endpoints

Clients
6 endpoints
Addresses
5 endpoints
Consignments
1 endpoint
Orders
7 endpoints
Items
4 endpoints
Sales
4 endpoints
Transactions
2 endpoints
Notes
1 endpoint
Files
1 endpoint
Queue
1 endpoint
Bulk
1 endpoint
Last Updated: October 30, 2025 | API Version: 1.0