WooCommerce REST API

Technical documentation for the REST API can be found here

Requirements ↑ Back to top

It’s required turn on the WordPress permalinks on Settings > Permalinks.

Enable REST API ↑ Back to top

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

Generate API keys ↑ Back to top

The WooCommerce REST API works on 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.

REST API breadcrumb

To get started, select Add Key:

Add Key

Select 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 select the Generate API Key button and WooCommerce will generate API keys for that user.

Generate Key

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

API keys

Place your consumer key and consumer secret in the application that uses the WooCommerce API (the application should request your URL as well).

If you would like to learn more about REST API, check Gerhard’s informative blog post, WooCommerce REST API Client Library.

Developer documentation ↑ Back to top

You can find the REST API documentation at: WooCommerce REST API Docs.

Libraries ↑ Back to top

WooCommerce - the most customizable eCommerce platform for building your online business.

Back to the top