Full REST API access for custom integrations. Manage products, trigger syncs, handle orders, and more programmatically.
{
"data": [
{
"id": "prod_abc123",
"title": "1921 Morgan Dollar MS65",
"price": 430.50,
"ha_lot": "123456"
}
]
}
Everything you need to integrate with SyncAuction
API key authentication with optional OAuth 2.0 for advanced integrations.
Standard REST conventions with JSON request/response format.
Real-time event notifications for syncs, orders, and inventory changes.
Core API resources
API rate limits by plan
Subscribe to real-time events
| Event | Description |
|---|---|
| sync.started | A sync job has started |
| sync.completed | A sync job has completed |
| sync.failed | A sync job has failed |
| product.created | A new product was synced |
| product.updated | A product was updated |
| product.deleted | A product was removed |
| order.received | A new order was received |
| order.forwarded | An order was forwarded to HA.com |
Get started with code samples in your language
curl -X GET "https://api.syncauction.com/v1/products" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-H "Accept: application/json"$client = new GuzzleHttp\Client();
$response = $client->get('https://api.syncauction.com/v1/products', [
'headers' => [
'Authorization' => 'Bearer ' . $apiKey,
'Accept' => 'application/json',
]
]);
$products = json_decode($response->getBody(), true);import requests
headers = {
'Authorization': f'Bearer {api_key}',
'Accept': 'application/json'
}
response = requests.get(
'https://api.syncauction.com/v1/products',
headers=headers
)
products = response.json()const response = await fetch(
'https://api.syncauction.com/v1/products',
{
headers: {
'Authorization': `Bearer ${apiKey}`,
'Accept': 'application/json'
}
}
);
const products = await response.json();Sample payloads for each event type
{
"event": "order.received",
"timestamp": "2024-01-15T10:30:00Z",
"data": {
"order_id": "ord_abc123",
"store_id": "store_xyz",
"store_name": "My WooCommerce Store",
"external_order_id": "WC-1234",
"total": 430.50,
"currency": "USD",
"items": [
{
"product_id": "prod_def456",
"sku": "HA-123456",
"title": "1921 Morgan Dollar MS65",
"quantity": 1,
"price": 430.50
}
],
"customer": {
"name": "John Smith",
"email": "john@example.com"
}
}
}{
"event": "sync.completed",
"timestamp": "2024-01-15T10:30:00Z",
"data": {
"sync_id": "sync_ghi789",
"type": "delta",
"duration_seconds": 45,
"stats": {
"products_added": 12,
"products_updated": 87,
"products_removed": 3,
"errors": 0
},
"stores_updated": [
"store_xyz",
"store_abc"
]
}
}{
"event": "product.created",
"timestamp": "2024-01-15T10:30:00Z",
"data": {
"product_id": "prod_jkl012",
"sku": "HA-789012",
"ha_lot": "789012",
"title": "1893-S Morgan Dollar VF35",
"price": 1250.00,
"cost": 1087.00,
"margin": 163.00,
"metal": "Silver",
"grade": "VF35",
"service": "PCGS",
"images": [
"https://cdn.syncauction.com/prod_jkl012/obverse.jpg",
"https://cdn.syncauction.com/prod_jkl012/reverse.jpg"
]
}
}{
"event": "order.forwarded",
"timestamp": "2024-01-15T10:30:05Z",
"data": {
"order_id": "ord_abc123",
"ha_order_id": "HA-ORD-567890",
"status": "confirmed",
"forwarded_at": "2024-01-15T10:30:05Z",
"estimated_ship_date": "2024-01-17",
"tracking": null
}
}More API resources for advanced integrations
Authorization: Bearer YOUR_API_KEY. API keys are available in your SyncAuction dashboard under Settings > API. Keys are scoped to your account and have read/write permissions based on your plan.X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset.sandbox-api.syncauction.com for testing integrations without affecting production data. Sandbox data resets daily and includes test product data.