v1

latestOpenAPI 3.1.02026-07-22802,2441.7 MB

Auth

Sync Connection

Manually trigger a sync for the connection associated with your access token.

Note - this does not sync historical data. Rather, it syncs data from the last sync time to the current time. To sync historical data, use the on-demand syncs endpoint.

post/connections/sync

Headers

x-trackstar-api-keystring required

Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

x-trackstar-access-tokenstring required

Example:<x-trackstar-access-token>

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Request body

functions_to_syncstring[]

The specific functions to force sync. Make sure to use one compatible with the connection's type.

Example request

{
  "functions_to_sync": [
    "get_inventory",
    "get_orders"
  ]
}

Response

Successful response

idstring required

The id of the connection synced.

syncingboolean required

Whether or not the connection is syncing.

functions_to_syncstring[] required

The functions that are being synced. Returns empty if all are being synced.

Example response

{
  "id": "07b344db-0304-4866-9ae1-ac8af5292a28",
  "syncing": true,
  "functions_to_sync": [
    "get_inventory",
    "get_orders"
  ]
}