Commerce sync settings

Update your sync settings to automatically retrieve commerce data from linked companies.

Update commerce sync settings in the Codat Portal

  1. In the Codat Portal, go to Account > Sync Settings.
  2. Find the following data types and set the Fetch on first link toggle to On:
  • Commerce - Company Info
  • Commerce - Orders
  • Commerce - Products
  • Commerce - Disputes
  • Commerce - Transactions
  • Commerce - Customers
  • Commerce - Payments

You can update the other sync settings when you've decided how frequently you want to sync commerce data.

  1. Select Save Changes to update your configuration.

Update commerce sync settings via the API

  1. Open the POST /profile/syncSettings endpoint.
  2. In the request body set:
  • fetchOnFirstLink to true for every commerce data type that you want to retrieve.
{
    "clientId":"{{clientId}}",
    "overridesDefaults":true,
    "settings":[
        {
            "dataType": "commerce-orders",
            "fetchOnFirstLink": true,
            "syncSchedule": 0,
            "syncOrder": 23
        },
        {
            "dataType": "commerce-products",
            "fetchOnFirstLink": true,
            "syncSchedule": 0,
            "syncOrder": 24
        },
        {
            "dataType": "commerce-disputes",
            "fetchOnFirstLink": true,
            "syncSchedule": 0,
            "syncOrder": 25
        },
        {
            "dataType": "commerce-transactions",
            "fetchOnFirstLink": true,
            "syncSchedule": 0,
            "syncOrder": 26
        },
        {
            "dataType": "commerce-customers",
            "fetchOnFirstLink": true,
            "syncSchedule": 0,
            "syncOrder": 27
        },
        {
            "dataType": "commerce-payments",
            "fetchOnFirstLink": true,
            "syncSchedule": 0,
            "syncOrder": 28
        },
        {
            "dataType": "commerce-companyInfo",
            "fetchOnFirstLink": true,
            "syncSchedule": 0,
            "syncOrder": 29
        }
    ]
}
  1. Submit your request.

Did this page help you?