WooCommerce

The WooCommerce plugin provides the ability to pull all WooCommerce products into the CRM.

Step 1 - Create API Keys in your Wordpress Admin site

1. When logged into the Admin site, click on “WooCommerce” then click “Settings” then click the “Advanced” tab to expose the “REST API” option. Click “REST API” to create your WooCommerce API Keys.

2. Click “Add Key” to create your WooCommerce API Key.

3. In the “Key Details” Screen make sure to enter a Description, choose a user, and ensure you select “Read/Write” for the permissions selection. Then click “Generate API Key” to finish the API key creation process.

4. WooCommerce will display the API keys upon successful API Key creation. Please save these as they are required for the plugin setup in the CRM.

These API Keys become inaccessible as soon as you leave this page.

1. WooCommerce calculates taxes on all imported orders by default. If you are planning to send orders back to WooCommerce then it is recommended to complete this step to ensure no tax is calculated by WooCommerce.

Go to Settings > Tax. Create an Additional tax class zero-tax-rate. Press Save Changes. There is a now a zero-tax-rate rates link under the Tax tab. Click that link. On the subsequent page insert a row, set the rate to 0, uncheck the Compound and Shipping boxes, and press Save. Check the sendTaxRate box in Step 2 below.

Step 2 - Setup the CRM Plugin

Navigate to Admin → Plugins → Data Sources and click on the green “+ Activate” button on the WooCommerce tile.

storeURL = your WooCommerce store url (minus the https://)

ConsumerKey= your WooCommerce Consumer Key (required)

ConsumerSecret= your WooCommerce Consumer Secret (required)

campaignId = Optional. Assign your WooCommerce products to a specific campaign. If blank, a new campaign will be created when the products are pulled from Woocommerce.

gatewayId = Optional. The gateway to assign to the CRM campaign products that will be created from the WooCommerce products. Entering a value here will save the effort of manually editing the campaign products to assign a merchant account. gatewayId can be found on the MID List (Merchants → MID List).

sendInitialOrders = Optional. Use this to automatically send successful new orders back to WooCommerce. This will send all successful new orders on the campaign. It is advised to use the campaign for Woocommerce orders only, if sending orders back to Woocommerce.

sendRebillOrders = Optional. Use this to automatically send successful rebill orders back to WooCommerce. This will send all successful rebill orders on the campaign.

sendTaxClass = Optional. Use this to send “zero-tax-rate” tax class to WooCommerce on every order. This prevents double taxation.

sendShipMethod = Optional. If checked the shipping method will be included on order exported to WooCommerce

syncCoupons = Optional. If checked this will sync coupons from WooCommerce every hour.

syncTaxes = Optional. If checked this will sync taxes from WooCommerce every hour.

sendOrderStatus = Choose to send the orders back to WooCommerce as Completed or Processing.

autoSync = Optional. Specify an interval in minutes to autosynchronize products. Minimum is 60 minutes. Set to 0 to clear.

Step 3 - Synchronize Products

This process will pull your WooCommerce products into the CRM and generate a campaign with the prices applied to the offers.

Edit the WooCommerce plugin, verify the information entered, and press the blue “Sync Products” button

When the sync is finished, navigate to CRM → Products to view or edit your WooCommerce base products. You can also navigate to CRM -> Campaigns to view or edit your WooCommerce campaign and offer settings.

Variant detail information will be synced from WooCommerce. Variants can be custom attributes or global attributes.

For more information about Product Variations please view this article.

Once your products are syned you can create a funnel to sell those products. If you would like to redirect customers customers from your WooCommerce storefront to your CheckoutChamp funnel, follow this article.

If you will be redirecting customers to a custom PHP checkout page that sends the order data to CheckoutChamp's Import Order API, follow this article.

Troubleshooting Product Sync Errors

It has been discovered that most Wordpress servers are configured differently which could cause issue when syncing products. The most common error one might face when using this plugin is "sorry you cannot list resource". To troubleshoot this issue please follow the steps below.

1. Confirm API credentials are correct.

2. Confirm pretty permalinks are enabled in your WP settings. If not please follow this guide to ensure you’re permalinks are configured correctly.

If updating your credentials and/or updating your store’s permalinks did not resolve this issue then it is safe to say that this issue might be caused by the way your Wordpress server is configured more specifically your server is not passing authorization headers to Wordpress.

Make sure your server is passing the authorization headers to wordpress.

Test by passing in key and secret via url rather than headers to confirm the issue eg: https://your-store-url.com/wp-json/wc/v3/products?consumer_key=XXXX&consumer_secret=XXXX

If pasting this URL into your browsers yields a proper result then it confirms that there is an issue with your wordpress server configuration.

Before Adjusting your Server Configuration please ensure you take proper back-ups of your server configuration so you can easily roll back changes if they are no longer needed.

Apache Server

If your Wordpress site is running on an Apache web server follow these steps to resolve this issue For eg if you have .htaccess add these lines, if you do not have an .htaccess file create one like so.

<IfModule mod_rewrite.c>
RewriteEngine On
RewriteBase /
RewriteRule ^index\.php$ - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule . /index.php [L]
</IfModule>
# END WordPress

Supporting Links: https://wordpress.org/support/topic/woocommerce-rest-api-error-401/ https://github.com/woocommerce/woocommerce/issues/19649/

Nginx Server

If your Wordpress site is running on an Nginx web server you will not have an .htaccess file and will not be able to edit it like mentioned above. Please follow the below steps to resolve this issue.

Navigate to your Nginx conf file and make the necessary changes.

server {
server_name localhost;
listen 80;
root /var/www;

location /wpbop {

    index index.php;

    access_log /var/log/nginx/blog.access.log;
    error_log /var/log/nginx/blog.error.log;

    try_files $uri $uri/ /index.php$is_args$args;

        add_header 'Access-Control-Allow-Origin' '*';
        add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';

    location ~ \.php$ {
        try_files $uri =404;
        fastcgi_index index.php;
        fastcgi_pass 127.0.0.1:7000;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        include /etc/nginx/fastcgi_params;
    }
}

If that does not work, navigate to /etc/nginx/sites-available/YOUR_DOMAIN on your Nginx server and add the following route.

location / {
#try_files $uri $uri/ =404;
try_files $uri $uri/ /index.php$is_args$args;
}

Supporting Link: https://stackoverflow.com/questions/54794782/woocommerce-rest-api-nginx-error-404-not-found