Advanced data synchronization features
Learn about additional data sync options available with Sync for Commerce
Data synchronization is an automated daily process. A merchant can view the status of the recent syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. operations in the SyncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. configuration UI, and your support team can check it on the SyncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. Health page of our Portal.
However, it is possible to get syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. status information and even initiate syncsSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. outside of the daily schedule using the Codat APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms..
Get syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. status
You may want your system to be aware of the latest syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. status for a merchant. You can get a list of syncsSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. and their status by making an APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. call to the Get sync status endpoint:
GET /meta/companies/{companyId}/sync/commerce/status
The response provides a list of syncsSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. and their status information:
{
"companyId": "0498e921-9b53-4396-a412-5g3g6094c1b3",
"commerceSyncId": "af888de-4d1b-44e8-8b4q-717463af00c5",
"syncId": "afe076de-4d2c-44d9-7e3a-717463af11c5",
"syncStatusCode": 2000,
"syncStatus": "Success",
"syncUtc": "2023-04-12T10:52:54.5359678Z",
"dataPushed": true
"dataConnections":
[...]
...
}
Initiating a syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule.
You may need to perform a manual syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. for a merchant from the date of their last successful syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. to a specified date. You can do this by calling the Initiate new sync endpoint:
POST /companies/{companyId}/sync/commerce/latest
The start of the syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. date range is determined as the date of the last successful syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule.. If there were no previous successful syncsSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule., the date configured in the synchronization schedule is used.
You can set the end of the syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. date range by including a syncTo date in the request body. If no date is provided, the current time UtcNow is used. For example:
{
"syncTo": "2022-01-01T12:00:00.000Z"
}
You can also initiate a syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. for a specified date range by making an APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. call to the Initiate sync for specific range endpoint:
POST /meta/companies/{companyId}/sync/commerce/historic
You will need to specify the syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. range start and end dates in the request body, for example:
{
"start": "2022-01-01T12:00:00.000Z",
"end": "2022-01-02T12:00:00.000Z"
}