COcodatio
Sync

Get sync status

Changed on

Gets a list of sync statuses.

get/meta/companies/{companyId}/sync/commerce/status

Request

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

Path parameters

companyIdstring uuid required

Unique identifier for your SMB in Codat.

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

Unique identifier for a company.

Response

Success

companyIdSchema (unresolved $ref)
commerceSyncIdstring guid

Unique identifier for the sync in Codat.

syncIdstring uuid

Unique identifier for the sync in Codat.

syncStatusCodeinteger

Numerical status code sync of the company data.

syncStatusstring nullable

Status of the sync of the company data. This is linked to status code.

errorMessagestring nullable

Friendly error message for the sync operation.

syncExceptionMessagestring nullable

Exception message for the sync operation.

syncUtcCreated (unresolved $ref)
dataPushedboolean

Boolean indicator for data being pushed during a sync operation.

Changes

  • 7d9157f49229Revision changes
    • breaking

      the response property // became optional for the status

  • c5556c94892fRevision changes
    • breaking

      the response property // became nullable for the status