Woocommerce

Sync Data

Learn how to sync and customise data from your WooCommerce store.

Data sync #

To import data from your WooCommerce store to Clerk.io, follow these steps:

  1. Create a Store in my.clerk.io.
  2. Install the Clerk.io Plugin in WooCommerce.
  3. Configure the Plugin.
  4. Finally, sync your Store by following these steps:
    • Log in to my.clerk.io.
    • Go to System Status > Data Sync.
    • Enter your Import URL, which is your webshop domain URL. You can also find this in the General section of the Clerk.io Plugin in WooCommerce.
    • Click Save.
    • Click Start new data sync.

Clerk will now import your products, categories and orders.

Customizing product data #

In WooCommerce, you can add Custom product attributes through the WooCommerce backend or through the Clerk.io plugin in code, if needed.

Add Simple Attributes #

If the attributes you want to send are already available as simple attributes in your WooCommerce admin, they can easily be added on the Plugin page.

  1. Go to your WooCommerce backend.
  2. Navigate to Products > Attributes.
  3. Find the slug of the attribute you want to add.

  1. Click on the Clerk.io Plugin in the left sidebar menu.

  2. In the Data Sync section, add the attribute slug in the Additional Fields. You can also add several different ones, separated by commas.

  3. Click Save Settings.

  4. Go to my.clerk.io > System Status > Data Sync and click Start New Data Sync.

Add attributes manually #

Attributes in WooCommerce can also be added through code in two files. These files are used to sync products both manually and automatically when changes are made in the webshop. These are the files:

  1. wp-content > plugins > clerkio > includes > class-clerk-realtime-updates.php in the function add_product:
  1. wp-content > plugins > clerkio > includes > class-clerk-rest-api-php in the function product_endpoint_callback in $product_array:

Each attribute is structured like this:

$product_array['sku'] = $product->get_sku();

Where ['sku'] defines the name you want the attribute to have in Clerk.io, and = $product->get_sku() is the WooCommerce logic for retrieving the attribute.

Functions.php Attributes #

You can also add new attributes to Clerk.io by modifying the functions.php file. These changes will persist even when the plugin is updated. Follow these steps:

  1. Add the following code to Appearance > Theme Editor > functions.php:
// Alters clerk parameters
add_filter( 'clerk_product_sync_array', 'clerk_change_params', 10, 2 );
add_filter( 'clerk_product_array', 'clerk_change_params', 10, 2 );

function clerk_change_params( $params, $product ) {

// Used to hide hidden products from search
   $params['catalog_visibility'] = $product->get_catalog_visibility();

// We only use short_description
   $params['description'] = $product->get_short_description();

    return $params;
}
  1. (Optional) If you want to include custom attributes (such as brand, color, or material) in Clerk.io, modify the function like this:
add_filter('clerk_product_sync_array', 'clerk_change_params', 10, 2);
add_filter('clerk_product_array', 'clerk_change_params', 10, 2);

function clerk_change_params($params, $product) {

    $params['catalog_visibility'] = $product->get_catalog_visibility();
    $params['description'] = $product->get_short_description();

    // Add custom attributes
    $params['brand'] = $product->get_attribute('brand');
    $params['color'] = $product->get_attribute('color');
    $params['material'] = $product->get_attribute('material');

    return $params;
}
  1. Replace “brand”, “color”, and “material” with any WooCommerce attributes you want to sync. If the attributes do not appear, ensure they are defined under Products > Attributes in your WooCommerce backend.
  2. Finally, go to my.clerk.io > System Status > Data Sync and click Start New Data Sync to import your new attributes.

Import Product Settings #

By default, Clerk.io’s WooCommerce plugin only imports Published products. This can be changed if needed. The following file controls which products are imported to Clerk.io: wp-content > plugins > clerkio > includes > class-clerk-rest-api.php

  1. In the file, locate the function called product_endpoint_callback.

  2. In the $products list, under 'status', add any Status that you want to include, separated by commas:

  1. When importing non-published products, add an is_saleable attribute that returns true or false to track availability. This allows you to show availability status in your Designs like this:
{% if product.is_saleable %}
   <div class="in-stock">In Stock</div>
{% else %}
  <div class="not-in-stock">Not In Stock</div>
{% endif %}
  1. Go to my.clerk.io > Data and click Start New Sync to import the new products.

Disable Order sync #

After the first data sync has run successfully, order sync from WooCommerce can be deactivated as the sales tracking from the extension takes over. You have two options: From my.clerk.io or from the Plugin in WooCommerce.

My.clerk.io #

  1. Go to my.clerk.io > System Status > Data Sync.
  2. Scroll down and on the right, change the option under Import Orders from Yes to No, then click Save. Clerk will no longer import orders from WooCommerce.

Plugin #

  1. Go to the WooCommerce backend and click on Clerk in the left sidebar menu.
  2. In the Plugin settings, scroll down to the Data Sync: Orders section. Check the box labeled Disable Order Synchronization.
  3. To make the changes take effect, click Save Settings.

Syncing Pages #

Important: For this to work, you must have WooCommerce installed and activated in your WordPress setup. You don’t need to use or configure it, but the plugin has essential functionality that the Clerk.io Plugin needs.

Since a store in Clerk.io primarily connects to your e-commerce platform to sync catalogs, orders, and customers, keeping external blog content updated can be challenging.

To address this, we now provide a no-code solution for syncing blog content with any Clerk store regardless of primary platform, if you manage your blogs through WordPress/WooCommerce. To use this feature, follow these steps:

  1. Install our plugin on your WordPress backend.
  2. Once installed, click on Clerk in the left sidebar menu.
  3. Enter your API keys from Settings > API keys in my.clerk.io to configure the plugin.
  4. Since we only want to import written content in this case, you should only need to enable Use Real-time Updates in the Data Sync: Pages section.
  5. Click Save Settings.
  6. After saving the settings, you’ll find a Sync Pages button in the Data Sync: Pages section. Clicking this button will immediately synchronize all your pages with your my.clerk.io store.

The Plugin also allows you to customize which page attributes are synchronized. You can specify Additional Fields to retrieve for each page and include Page Additional Types created by third-party plugins.

You should only need to press the Sync Pages button once, as any change to a page, publication of a new page, archival, or deletion will be caught by our plugin and updated in the my.clerk.io store automatically.

Disable pages import #

To ensure pages are only synced from WordPress and not from other sources during the Data Sync, disable page imports in my.clerk.io:

  1. Go to System Status > Data Sync
  2. Find the Import Pages setting and set it to No
  3. Click Save