Sync

Get sync status

Get the sync status for a specified sync

get/companies/{companyId}/sync/commerce/syncs/{syncId}/status

Request

Base URL
https://api.codat.io
URL
https://api.codat.io/companies/{companyId}/sync/commerce/syncs/{syncId}/status
Auth
API key in header Authorization

companyIdstring uuid required

Unique identifier for your SMB in Codat.

Example:8a210b68-6988-11ed-a1eb-0242ac120002

Unique identifier for a company.

syncIdstring uuid required

Example:6fb40d5e-b13e-11ed-afa1-0242ac120002

Unique identifier for a sync.

Success

companyIdstring nullable

Unique identifier for your SMB in Codat.

syncIdstring nullable

Unique identifier of the sync.

syncStatusCodeinteger

Status code of the sync.

syncStatusstring nullable

Text status of the sync.

errorMessagestring nullable

Error message of the sync.

syncExceptionMessagestring nullable

Exception message of the sync.

syncUtcCreated (unresolved $ref)

dataPushedboolean

Boolean of whether the sync resulted in data being pushed.