Skip to main content
WooCommerce integration

Enabling the API access for your WooCommerce shop

Monica avatar
Written by Monica
Updated over a month ago

To connect your Inventory Planner account to your WooCommerce shop, you'll need the following information available:

  • Shop URL

  • WooCommerce Key

  • WooCommerce Secret

You will also need to make some changes to your configuration in WooCommerce.

WooCommerce configuration

Enabling the REST API

To enable the REST API within WooCommerce, visit WooCommerce > Settings, click into the API tab and tick the Enable REST API checkbox.

API version

WooCommerce 9.0 and later uses a new version of their API, deprecating the API Inventory Planner historically used for its connector (the "Legacy API"). The connector has been updated to support the new API.

However, the new API is slower to sync than the Legacy API. Therefore the Inventory Planner connector will also continue to support the Legacy API.

If you are on WooCommerce 9.0 or later and wish to use the Legacy API, you can use an extension in WooCommerce to continue using the Legacy API. Click here to learn more about the extension and how to enable it.

High Performance Order Storage (HPOS) and the Legacy API

If you are using the Legacy API (either with the extension on version 9.0 or later, or just using version 8.9 or earlier), High Performance Order Storage does not reliably sync orders. We recommend enabling compatibility mode for order storage data in WooCommerce to avoid issues with missed orders. Learn more about enabling compatibility mode here.

Permalinks

You must enable WordPress permalinks in Settings > Permalinks.

Shop URL

We recommend specifying the full URL of your WooCommerce installation. Always use https:// to make sure your data is transferred over a secure connection (though you can use http:// for development/test stores).

Generating API keys

The WooCommerce REST API uses a key system to control access. These keys are linked to WordPress users on your website.

To create or manage keys for a specific WordPress user, go to WooCommerce > Settings > API > Keys/Apps.

To get started, click Add key:

Choose the User you would like to generate a key for in the User field, and add a Description. Choose the level of access for this API key, which can be Read access, Write access or Read/Write access. Then click the Generate API Key button to prompt WooCommerce to generate API keys for that user.

Now that keys have been generated, you should see two new keys, a QRCode, and a Revoke API Key button. The two keys are your Consumer Key and Consumer Secret. Make a note of them.

Connecting WooCommerce and Inventory Planner

Once you've generated your keys, log into Inventory Planner. Go to Account > Settings > Connections & warehouses, then click "+ New Connection" at the bottom of the page.

Choose the WooCommerce connector, then fill in the Shop URL, Consumer Key and Consumer Secret you saved earlier.

If you are using WooCommerce 8.9 or earlier, or using WooCommerce 9.0 with the Legacy API extension enabled, you must also check the box that says "Use the WooCommerce legacy API". Misconfiguring this setting will prevent your data from syncing to Inventory Planner.

Once you're happy with your settings, click "Connect" to initiate the connection.

Did this answer your question?