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 at: Settings > Permalinks.

Enable REST API ↑ Back to top

To enable the REST API within WooCommerce, go to WooCommerce > Settings > API 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:

1/ Go to: WooCommerce > Settings > API > Keys/Apps.

REST API breadcrumb

2/ Select Add Key.

Add Key

3/ Select the User you would like to generate a key for in the User field and add a Description.

4/ Choose the level of access for this API key, which can be Read access, Write access or Read/Write access.

5/ 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

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

Learn more about REST API at: WooCommerce REST API Client Library.

Test if the API is working ↑ Back to top

It’s fairly simple to test if your API is working as it should. You can find a step-by-step guide here on how to do that.

Developer documentation ↑ Back to top

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