Sync Status

Sync Status API

Get Sync Status

GET /api/v1/integration/sync-status

Query sync status across entity types or for specific external IDs.

Required scope: integration:sync:read

Query Parameters

Parameter	Type	Description
entityType	string	Filter by entity: SUPPLIER, PRODUCT, or BATCH
externalIds	string	Comma-separated list of external IDs to check
since	string	ISO date — only show records synced after this
page	number	Page number (default: 1)
limit	number	Items per page (default: 50, max: 100)

Summary Response (no entityType)

When entityType is omitted, returns a count summary:

GET /api/v1/integration/sync-status

{
  "suppliers": { "total": 42 },
  "products": { "total": 128 },
  "batches": { "total": 350 }
}

Detailed Response (with entityType)

GET /api/v1/integration/sync-status?entityType=SUPPLIER&since=2024-01-01

{
  "entities": [
    {
      "externalId": "VENDOR-001",
      "internalId": "clx...",
      "name": "Amazon Timber Co.",
      "syncStatus": "SYNCED",
      "lastSyncedAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "total": 5,
  "page": 1,
  "limit": 50
}

Sync Status Values

Status	Description
SYNCED	Successfully synced and up-to-date
PENDING	Queued for sync
ERROR	Last sync attempt failed
CONFLICT	Conflicting changes detected