COcodatio
Sync

List sync statuses

Changed on

Gets a list of sync statuses

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

Request

  • Base URL
    https://api.codat.io
  • URL
    https://api.codat.io/companies/{companyId}/sync/commerce/syncs/list/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

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.

Changes

  • 9bd87def9914Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 83c1801e91f7Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status