Here are the instructions to integrate WooCommerce version 2.1 or greater (from now on WooCommerce):
​

Permalinks are an important part of your site as both search engines and visitors use these URLs to index and visit your site. Shipedge requires you to use a pretty permalink to be able to connect with your store, specifically the "Post name" permalink.

To learn more about WooCommerce permalinks, you can visit their documentation: Link

1. Log in to your WordPress account. Once logged in, go to your WooCommerce site -> Dashboard -> Settings -> Permalinks

2. Configure the Post Name permalink: Ensure you configure the permalink structure to "Post Name." Using other types of permalinks might cause connection issues with Shipedge, so it's strongly recommended to stick with this format for a reliable integration.

3. Save Changes. No other steps are required in this section. Make sure to save your changes.

1. You will need to create API KEYs on WooCommerce, as these will be later used to connect to Shipedge. First Create API keys for a specific WordPress user.

To achieve this, go to: WooCommerce site -> Dashboard- > WooCommerce button -> Settings -> Advanced, REST API:

2.** Create a new API KEY using the"Add Key"** option:

3. The Key Details screen will now be available. Please complete the required fields:

Once the fields are completed, click on Generate API Key, and WooCommerce will generate REST API keys for the selected user.

4. Once the keys are generated, you'll see two new keys, a QR code, and a "Revoke API Key" button. The keys you need are the Consumer Key and Consumer Secret. Be sure to save them securely for future use.

1. Now you are ready to integrate Woocommerce with Shipedge, simply go to Shipedge OMS > My Account > Preferences > Channel Automation and look for WooCommerce.

2. Click on WooCommerce, name your WooCommerce Store, and click on Add New Store:

Please be aware that special characters are not allowed in this field. If you include any, the system will display a message to inform you so you can change the name accordingly. _ _

3. New options will be available. The API parameters section is the first one you'll need to fill in. This section is divided into two parts. Let's begin filling in the first one:

1. To synchronize orders, you need to fill out the Orders fields available in the API parameters section. This is also explained in the above steps.

2. Now go to the Orders section and check the Orders box

There is an option called "Get Orders!" Please note that this option is highly helpful when first configuring your store, as it helps you start the order syncing process. However, once your connection is established and orders are syncing smoothly, it is not recommended to use this button regularly. Use it only if necessary, as the order syncing process is automated.

You must check the Update Tracking Number option to sync the assigned tracking number back to your WooCommerce site.

** Note: A WooCommerce Tracking Extension is required to enable tracking number synchronization. If this tracking plugin is not used, the tracking WILL NOT BE SYNCED.

You can find the WooCommerce Shipment Tracking extension here. This is a paid extension that allows you to add tracking information to your orders. Once added, the tracking details will appear in emails, on the order tracking page, and on the order view page.

Alternatively, you can add the tracking information manually in WooCommerce once the order is shipped.

For inventory syncing, you have two options: you can sync your SKUs and/or your Synsets, depending on how your inventory is organized within your OMS. Check these options in the Update Inventory section.

_ Important: We highly suggest you do NOT check these two boxes in the Update Inventory section ** until your SKUs have been received into the Warehouse Management System**. This will prevent any discrepancies in your inventory quantities on the WIX Store._

Similar to order management, there is an " Update" option available. This option is particularly useful when initially configuring your store, as it starts the inventory synchronization process. However, once the connection is established and inventory syncing is functioning smoothly, it is not recommended to use this button regularly. Use it only when necessary, as the inventory syncing process is automated.

Save your Configuration.

Although integrations offer different features, there are some key ones we recommend configuring to ensure the best and smoothest workflow possible. To learn more about address verification and residential check and their functions, please click here.

To configure address verification and residential check, hover over the " Orders" section and select " Integrations."

Then, look up the Wix private integration name you set up before. Once found, click on the tool icon and check the Address Verification & Residential Check

To ensure all orders are processed with the correct information, Shipedge uses "API Errors" to prevent orders with incomplete or incorrect information from entering the system. One common cause of API errors is unrecognized shipping methods. When setting up a new integration, you must map the shipping methods for each channel in Shipedge. Since each store may use different names for shipping methods, a shipping method translator is required to match these names accurately.

For detailed instructions on configuring the shipping method translator, please refer to this article

You are now set!

Even after configuring a successful WooCommerce connection and seeing orders come in the system, clients occasionally report later issues with the previous functioning integration, such as tracking not being sent back to WooCommerce, for example. This can happen for a variety of reasons, but the most common is a conflict with a theme or plug-in. Simply put, more extensions bring with them more code, code that even WooCommerce cannot necessarily guarantee.

Switching to the default "Twenty Nineteen" theme is suggested to check if the problem lies with the current theme. The "Health Check" plug-in lets you do this without affecting how the site looks to visitors, allowing you to troubleshoot privately. If changing the theme resolves the issue, re-enable each plug-in one by one to identify which one caused the conflict.

Security plug-ins are a common cause of issues. Security plugins often restrict the accessibility of endpoints/URLs on a WordPress store. They may allow orders to export but prevent another system from posting information to the server.

Begin by disabling the security plug-in. If this resolves the issue, you may need to whitelist specific endpoints to avoid restrictions. Continue disabling them until you find the one causing the issue.

Some plug-ins allow you to whitelist endpoints to bypass restrictions on certain operations. If available, whitelist Shipedge's IP to ensure smooth communication. To obtain the IP, please contact support.

Many times, with a new integration, the orders will enter an API Error status. API errors can occur for a variety of reasons. Below are several articles that will help you resolve these API errors: