Search Results :

×

Sync Products into WooCommerce from external supplier APIs


The miniOrange WooCommerce Product Sync plugin is a powerful plugin designed to streamline the process of importing products into WooCommerce stores. By leveraging JSON or XML APIs, this plugin seamlessly synchronizes product data from external sources, such as inventory management systems or supplier databases, directly into the WooCommerce platform.

This comprehensive guide will walk you through the process of seamlessly integrating external product data into your WooCommerce store using JSON or XML APIs.

By following these step-by-step instructions, you'll be able to effortlessly synchronize product information, automate updates, and streamline your WooCommerce store management workflow.


WooCommerce Product Sync
By miniOrange

Import Products from External APIs / Supplier Inventory automatically. Automate syncing products, items and listings and create/ update WooCommerce products from these items for your WooCommerce store.

Know More

Steps to configure WooCommerce Product sync plugin

1. Installation and Activation

  • Enter your account credentials which you used to purchase the license and click the Login button.
  • Configure WooCommerce Product Sync - Entering credentials to login
  • After successful login, you need to enter your license key to activate your license. You can find the license key by going to miniOrange Console → Manage License → License key.
  • Configure WooCommerce Product Sync - Activating license
  • Once the license is activated, you can connect to the API/supplier from which you want to import the products.

2. Connecting JSON/ Supplier API

  • In this step, we will see how to connect to the API.
    • Click on External Supplier → Add Connection.
    • Configure WooCommerce Product Sync - Adding connection
    • Select a supplier from the preconfigured connections. If your supplier isn’t listed, select Others to configure your supplier.
    • Configure WooCommerce Product Sync - Pre-configured vendors
    • Select the connection type between API and FTP. We have selected API here for this guide.
    • Fill in the Supplier Name, Product URL endpoint, and Authorization Headers as required by the supplier.
    • Configure WooCommerce Product Sync - Header data and API endpoint
    • After filling in the required details, click on Save Connection. To test if the API is configured correctly, you can click the Send button to receive the response from the API.
    • Configure WooCommerce Product Sync - API results JSON file
    • We have successfully connected to the API.

      If your product API needs a token from an authentication API endpoint then you can follow these steps:

      Connecting authentication API:

      • Click on External Supplier → Add Connection.
      • Configure WooCommerce Product Sync - Adding connection
      • Select Others to configure the Authentication API.
      • Configure WooCommerce Product Sync - Pre-configured vendors
      • Select the API connection type between API and FTP.
      • Fill in the Name, Authentication URL endpoint, and required Headers or Body.
      • Configure WooCommerce Product Sync - External supplier API endpoint
      • Click on the Send button to test the Authentication URL.
      • Configure WooCommerce Product Sync - Identity token JSON file
      • As we can see here, the token is contained in token key and the connection name is userAuthentication. This will be needed in the next step.

      Connecting Product API:

      • Click on External SupplierAdd Connection.
      • Configure WooCommerce Product Sync - Adding connection
      • Select Others to configure the Authentication API.
      • Configure WooCommerce Product Sync - Pre-configured vendors
      • Select the API connection type between API and FTP.
      • Fill in the Supplier Name, Authentication URL endpoint, and required Headers or Body.
      • Configure WooCommerce Product Sync - Header data and API endpoint
      • The dynamic authentication header is to be passed in this format: #connection_name , variable_name#
      • Configure WooCommerce Product Sync - Request body data
      • You can test the configuration by clicking the Send button.
      • Configure WooCommerce Product Sync - API test results
      • You have successfully connected to the API which is dependent on the Authentication API.

3. Setting up sync application

Simple Product Attribute Mapping

If your API/ supplier doesn’t have variable products then you can follow these steps to configure the Sync Application:

Sync Application:

  • Click on the Sync Tab and click on Add Connection.
  • Configure WooCommerce Product Sync - Successful external supplier connection
  • Select the connection that we configured in step 2 from the dropdown and choose the operation type. You can choose Add if you want to only import the products from the API into your store. You need to select the Update option if you want to update the products in the future or update the already existing products in your WooCommerce store.
  • Configure WooCommerce Product Sync - Sync settings operation type
  • Now go to the Field Mapping Tab and map the simple product attributes with the keys from the API response in API Test Results.
  • Configure WooCommerce Product Sync - Attribute table result API test result
  • As we can see we have the id, name, brand_name, description, and other attributes in the API response, we can map the same in the Sync settings.
  • Note: If your API is providing nested data and your product data looks like this:
  • Configure WooCommerce Product Sync - Attribute name from API test results
  • You will need to put the word before the first arrow (productos in our case) in the Main Response Attribute field of the sync settings.
  • To map other attributes, you can pass the last word which is producto_id in our case. You can similarly add other attributes without arrows.
  • Configure WooCommerce Product Sync - Field mapping
  • You can also configure the Custom attributes by scrolling down. You can add multiple custom attributes by clicking the + button. If you haven’t created a custom field, you can use the Advanced Custom Field plugin to do the same. This will store the data in post_meta.
  • Configure WooCommerce Product Sync - Custom field mapping
  • Once the attribute mapping is done, you can Save the Connection and Click on the Start button.
  • Configure WooCommerce Product Sync - Sync settings operation type
  • Once the sync starts, you will see Sync Analytics where you can see the current status of the sync along with the number of products synced.
  • Configure WooCommerce Product Sync - Sync analytics
  • Congratulations! You have successfully configured the miniOrange WooCommerce Product Sync Plugin. You can import products from external suppliers into WooCommerce automatically.

4. How to initiate, stop and monitor synchronization?

  • In order to check the synchronization status, you can go to Sync Analytics and click on a connection to show the synchronization status.
  • Configure WooCommerce Product Sync - show the synchronization status

5. Do you want to create similar sync connections with the same attribute mapping?

If you are looking to create similar Sync Applications, you can easily duplicate the existing connection by following these steps:

  • Click on an existing Sync Application and choose the Edit option.
  • Configure WooCommerce Product Sync - choose the Edit option
  • Select the new external connection in the External Supplier dropdown and click on Save Connection button.
  • Configure WooCommerce Product Sync - Select the new external connection
  • This will create a duplicate connection with the same configuration as the previous one.

6. Setup for CSV/ZIP type file sync

If your supplier API is providing a CSV via the API, then you can use the below configuration to sync the products from the file.

Connecting the supplier API:

  • Click on External Supplier → Add Connection.
  • Configure WooCommerce Product Sync - Add Connection
  • Select Others to configure your supplier CSV.
  • Configure WooCommerce Product Sync - configure your supplier CSV
  • Select the API connection.
  • Fill in the Supplier Name, CSV file URL endpoint, and Authorization Headers as required by the supplier.
  • After filling in the required details, click on Save Connection. To test if the API is configured correctly, you can click the Send button to receive the response from the API.
  • Configure WooCommerce Product Sync - Fill in the Supplier Name, CSV file

Simple Product Attribute Mapping:

  • Click on the Sync Tab and click on Add Connection.
  • Configure WooCommerce Product Sync - Add Connection
  • Select the connection that we configured in previous step from the dropdown and choose the operation type.
  • You can choose Add if you want to only import the products from the API into your store. You need to select the Update option if you want to update the products in the future or update the already existing products in your WooCommerce store.
  • Configure WooCommerce Product Sync - choose the operation type
  • Now go to the Field Mapping Tab and put the column number of the field from CSV/XLSX file against the attribute of WooCommerce as shown below. Note: Column number starts from 0.
  • Configure WooCommerce Product Sync - Field Mapping
  • You can also configure the Custom attributes by scrolling down. You can add multiple custom attributes by clicking the + button.
  • Configure WooCommerce Product Sync - add multiple custom attributes
  • If you haven’t created a custom field, you can use the Advanced Custom Field plugin to do the same. This will store the data in post_meta.
  • Once the attribute mapping is done, you can go to Advance Settings and click File Sync option.
  • Configure WooCommerce Product Sync - click File Sync option
  • You need to enable the File Sync option and put a file name along the extension like .csv .xls. or .xlsx.
  • You can Save the Connection. Click on the Start button.
  • Configure WooCommerce Product Sync - run sync
  • Once the sync starts, you will see Sync Analytics where you can see the current status of the sync along with the number of products synced.
  • Configure WooCommerce Product Sync - Sync Analytics
  • Congratulations! You have successfully configured the miniOrange WooCommerce Product Sync Plugin. You can import products from external suppliers into WooCommerce automatically.

7. FTP file sync

If you want to sync products using FTP credentials which are provided by your supplier, then you can use the below configuration to sync the products from the file.

Connecting the supplier API

  • Click on External Supplier → Add Connection.
  • Configure WooCommerce Product Sync - Add Connection
  • Select Others to configure your supplier.
  • Configure WooCommerce Product Sync - configure your supplier CSV
  • Select the FTP connection.
  • Fill in the Hostname, Username, Password, and File Path as required by the supplier.
  • After filling in the required details, click on Save Connection.
  • Configure WooCommerce Product Sync - Select the FTP connection

Simple Product Attribute Mapping

  • Click on the Sync Tab and click on Add Connection.
  • Configure WooCommerce Product Sync - Add Connection
  • Select the connection that we configured in previous step from the dropdown and choose the operation type.
  • You can choose Add if you want to only import the products from the API into your store. You need to select the Update option if you want to update the products in the future or update the already existing products in your WooCommerce store.
  • Configure WooCommerce Product Sync - choose the operation type
  • Now go to the Field Mapping Tab and put the column number of the field from CSV/XLSX file against the attribute of WooCommerce as shown below. Note: Column number starts from 0.
  • Configure WooCommerce Product Sync - Field Mapping
  • You can also configure the Custom attributes by scrolling down. You can add multiple custom attributes by clicking the + button.
  • If you haven’t created a custom field, you can use the Advanced Custom Field plugin to do the same. This will store the data in post_meta.
  • Configure WooCommerce Product Sync - add multiple custom attributes
  • Once the attribute mapping is done, you can go to Advance Settings and click File Sync option.
  • You need to enable the File Sync option and put a file name along the extension like .csv .xls. or .xlsx.
  • Configure WooCommerce Product Sync - click File Sync option
  • You can Save the Connection. Click on the Start button.
  • Configure WooCommerce Product Sync - run sync
  • Once the sync starts, you will see Sync Analytics where you can see the current status of the sync along with the number of products synced.
  • Configure WooCommerce Product Sync - Sync Analytics
  • Congratulations! You have successfully configured the miniOrange WooCommerce Product Sync Plugin. You can import products from external suppliers into WooCommerce automatically.

miniorange img Additional Resources


Mail us on apisupport@xecurify.com for quick guidance(via email/meeting) on your requirement and our team will help you to select the best suitable solution/plan as per your requirement.

Hello there!

Need Help? We are right here!

support
Contact miniOrange Support
success

Thanks for your inquiry.

If you dont hear from us within 24 hours, please feel free to send a follow up email to info@xecurify.com