How far the connection’s sync has come
GET
/api/v1/workspaces/{workspaceId}/channel-connections/{connectionId}/sync
const url = 'https://api.crossmart.io/api/v1/workspaces/example/channel-connections/example/sync';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.crossmart.io/api/v1/workspaces/example/channel-connections/example/sync \ --header 'x-api-key: <x-api-key>'Counts the listings a sync or retry queued whose job has not finished yet, and those in error. Poll it after POST …/sync: the sync is done when pending is 0.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”workspaceId
required
string
connectionId
required
string
Responses
Section titled “Responses”Media typeapplication/json
object
pending
required
Listings whose publish, update or delist a sync or retry queued and whose job has not finished yet (each shows syncRequestedAt, and displayState: publishing while selected)
number
failed
required
The store’s listings in error now, whatever queued them
number
done
required
True once nothing a sync or retry queued is still pending
boolean
Example generated
{ "pending": 1, "failed": 1, "done": true}