Skip to main content
GET /api/v2/storefront/inventory-sources/{sourceId}/sync-history Returns the timeline of sync runs for an ad-server-backed source. Use this to drill into individual runs after reading the coarse sync blocks on the status snapshot.

​
Request

curl "https://api.interchange.io/api/v2/storefront/inventory-sources/retail-gam/sync-history?syncType=inventory&limit=50" \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

​
Parameters

FieldTypeRequiredNotes
sourceIdstring (path)YesStorefront-scoped inventory source ID
syncTypestring (query)NoFilter by sync type (e.g. inventory)
statusstring (query)NoFilter by run status
limitinteger (query)No1–500
cursorstring (query)NoPagination cursor from a prior nextCursor

​
Response

{
  "runs": [
    {
      "syncId": "sync_01J2",
      "syncType": "inventory",
      "startedAt": "2026-05-02T08:00:00Z",
      "completedAt": "2026-05-02T08:03:00Z",
      "status": "success",
      "durationSeconds": 180,
      "itemsProcessed": 1840,
      "itemsFailed": 0,
      "errorSummary": null,
      "errorCategory": null
    }
  ],
  "count": 1,
  "nextCursor": null
}
When nextCursor is non-null, pass it back as the cursor parameter to walk pages.

​
Errors

  • 401 UNAUTHORIZED — missing or invalid API key.
  • 404 NOT_FOUND — no ad-server-backed source with this sourceId.
See Errors for the full error contract.

Inventory source tasks

All operations

Get status

Coarse sync rollups

Refresh

Force a fresh sync snapshot

Get ad-server connection

Connection state