API Documentation

Integrate with SyncFlow using our REST API

Authentication

All API requests require a bearer token in the Authorization header.

Authorization: Bearer YOUR_API_TOKEN

GET /api/v1/warehouses List all warehouses

Response Example

{
  "data": [
    {
      "id": "WH-EU-001",
      "name": "EU-Central Distribution Center",
      "region": "eu-central-1",
      "city": "Frankfurt",
      "capacity": 50000,
      "status": "active"
    }
  ],
  "pagination": { "page": 1, "limit": 20, "total": 5, "totalPages": 1 }
}

GET /api/v1/inventory List inventory items

Query Parameters

page Page number

limit Items per page

warehouse Filter by warehouse ID

GET /api/v1/sync/jobs List sync jobs

GET /api/v1/metrics Get service metrics

POST /api/v1/sync/trigger Trigger a sync job

Need help?

Check out our full API reference or contact support for integration assistance.