ADDO Product Sync – Wholesaler Guide

Welcome! This guide explains how to use the ADDO Product Sync plugin to easily synchronise the ADDO product catalogue with your own WooCommerce store.

Purpose

This plugin connects your website to the main ADDO product database via a secure API. It allows you to:

• Import new products from ADDO.
• Update existing products in your store with the latest information (descriptions, pricing, stock levels, images) from ADDO.
• Keep your product catalogue aligned with ADDO’s offerings with minimal manual effort.
• Clean up products in your store that are no longer available from ADDO.

Setup: Getting Started

Before you can sync products, you need to obtain the plugin file and connect it to the ADDO API using unique credentials.

Step 1: Obtain and Install the Plugin

• First, you need the plugin file itself. Please email ADDO sales at sales@addoauto.com to request the latest version of the ADDO Product Sync plugin `.zip` file.
• Once you have received the `.zip` file, log in to the WordPress admin area of your website.
• Navigate to: Plugins -> Add New Plugin (or Add New).
• Click the “Upload Plugin” button near the top of the page.
• Click the “Choose File” button and select the plugin `.zip` file you received from ADDO.
• Click “Install Now”.
• After installation is complete, click “Activate Plugin”.

Step 2: Request API Keys

• Once the plugin is active, you need a unique API Consumer Key and API Consumer Secret to connect to the data feed.
• Please email ADDO sales at sales@addoauto.com again (or in your initial request) to ask for your API credentials. Mention that you need API keys for the ADDO Product Sync plugin you just installed.

Step 3: Receive Your Keys

• The ADDO team will generate standard WooCommerce REST API keys specifically for your wholesale account.
• These keys (Consumer Key and Consumer Secret) will be sent to you securely via Email or WhatsApp.
• Important: Treat these keys like passwords – keep them confidential and secure.

Step 4: Enter Keys in Plugin Settings

• In your WordPress admin area, navigate to: Products -> ADDO Product Sync.
• You will see fields labelled “API Consumer Key” and “API Consumer Secret”.
• Carefully copy the Consumer Key provided by ADDO and paste it into the “API Consumer Key” field.
• Copy the Consumer Secret provided by ADDO and paste it into the “API Consumer Secret” field.
• Click the “Save API Credentials” button.

Once saved, the synchronisation action buttons will become available on the same page.

Usage: Synchronisation Actions

On the “Products -> ADDO Product Sync” page, you will find several buttons to manage the synchronisation process.

Here are the available actions:

1. Sync Specific Categories

• What it does: Imports new products and updates existing ones (matched by SKU), but only for the specific category IDs you enter.
• Use this for: Targeted updates, importing specific product lines, or performing smaller initial imports.
• How to use:
  • Enter one or more Category IDs (separated by commas) into the “Category IDs” input field. You can find a list of available IDs in the API Documentation.
  • Click the “Run Category Sync” button.
• Note: Importing multiple categories or categories containing many products may take some time to complete.

2. Sync New Products

• What it does: This is the most efficient way to get new products. It checks the date and time of your last successful sync and asks the ADDO server to send only the products that have been created since that time.
• Use this for: Quickly adding the latest products to your store without needing to check all existing ones. This should be your go-to button for regular updates.
• How to use: Click the “Sync New Products” button.
• Note: The very first time this button is used, it will run a full sync to establish a starting timestamp. Every subsequent run will be much faster.

3. Update Existing Products

• What it does: Checks all products available via the ADDO API. If a product with a matching SKU is found already existing in your store, its data (details, price, stock, images, etc.) will be updated with the latest information from ADDO.
• Important: This action will not create any new products in your store. It only updates products that you already have based on their SKU.
• Use this for: Regularly refreshing information for your current product catalogue without adding new items.
• How to use: Click the “Run Product Update” button.

4. Run Full Sync

• What it does: Performs a comprehensive synchronisation. It fetches all products from the ADDO API.
  • If a product from ADDO doesn’t exist in your store (based on SKU), it will be created.
  • If a product from ADDO does exist in your store (based on SKU), it will be updated.
• Use this for: Initial setup to import the entire catalogue, or for performing a complete refresh to ensure your store matches the ADDO catalogue.
• How to use: Click the “Run Full Sync” button.
• Warning: This process checks and potentially imports/updates all products. For large catalogues, this can take a significant amount of time. Please be patient.

5. Remove Deleted Products (Orphan Cleanup)

• What it does: Compares the products marked as managed by this plugin on your site against the current list of products available from ADDO. If any products exist on your site but are no longer in the ADDO feed (based on SKU), they are considered “orphans”. This action will move these orphan products to your WooCommerce **Trash**.
• Use this for: Periodically cleaning up products that have been discontinued or removed from the ADDO catalogue.
• How to use:
  • Click the “Find & Trash Removed Products” button.
  • The system will first check for orphans and report how many were found.
  • A confirmation pop-up box will appear asking: “Found X orphan products. Move them to trash?”.
  • Click “OK” to proceed with moving the identified products to the trash, or “Cancel” to abort.
• Warning: Use this tool carefully. Ensure your product SKUs accurately match ADDO’s SKUs. Products moved to the trash can be restored from the WooCommerce Products -> Trash screen if needed.

Understanding the Import/Cleanup Process

When you click one of the action buttons:

1. Processing Starts: The process begins running in batches (for sync/update) or performs checks (for cleanup).
2. Progress Display: A progress area will appear below the buttons.
   • Warning Notice: A message will remind you to keep this page open in your browser until the process completes. Navigating away will interrupt the process.
   • Progress Bar: Shows the approximate percentage completion based on the number of batches processed.
   • Status Text: Displays the current status (e.g., “Processing (50%)”, “Checking for orphans…”) and shows animated dots while waiting for the current step to finish.
   • Results Log: This box shows live updates for each step, including counts of items processed and any specific errors encountered.
3. Completion: When the process finishes, the status text will update to “Operation Complete!”, the progress bar will reach 100%, and the busy indicator dots will disappear. The buttons will become active again.
4. Final Summary Notice: After the operation is complete, reload the page. A summary notice should appear at the top of the WordPress admin screen detailing the overall results (Total Processed, Created, Updated, Skipped, Errors) and listing any specific errors encountered during the entire run. This notice appears only once.

Troubleshooting

• Errors in Results Log: Pay attention to messages logged in the results area during the import/cleanup. Errors like “Failed to upload image…”, “Failed to save variation…”, or “Failed to trash product…” indicate issues with specific products or data.
• Final Summary Errors: Review the summary notice after reloading the page post-operation for a list of errors (e.g., SKU issues, trashing errors).
• SKU Mismatches & Product Type Conflicts: Double-check SKUs on your site if updates or cleanups aren’t behaving as expected. If an existing product on your site has a different type (e.g., simple vs. variable) than the incoming product from ADDO, it will be skipped to prevent errors.
• Incorrect API Keys: Ensure the keys saved in the settings exactly match those provided by ADDO. Authentication errors often appear in the Results Log.
• Check addo-import.log: For more detailed technical information or persistent errors, you can check the log file located at wp-content/addo-import.log on your website’s server (accessible via FTP or your hosting file manager).

ADDO Product Category IDs

Use the following IDs in the “Sync Specific Categories” input field (comma-separate multiple IDs):