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.

POST /bo_auth

Request:

{
  "username": "user@example.com",
  "password": "securePassword123"
}

Response:

{
  "data": {
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGc...",
    "user": { ... }
  }
}

Use the access_token in the Authorization header:

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGc...
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
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
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
Orders
7 endpoints
Items
4 endpoints
Sales
4 endpoints
Transactions
2 endpoints
Files
1 endpoint
Queue
1 endpoint
Bulk
1 endpoint
Last Updated: October 30, 2025 | API Version: 1.0