WooCommerce REST API

Technical documentation for the REST API can be found here

Requirements ↑ Back to top

WordPress permalinks must be enabled at: Settings > Permalinks.

Enable REST API ↑ Back to top

To enable the REST API within WooCommerce, go to WooCommerce > Settings > Advanced > Legacy API and tick the Enable REST API checkbox.
Note: REST API was found at WooCommerce > Settings > API prior to WooCommerce 3.4.

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 > Advanced > REST API.
    Note: Keys/Apps was found at WooCommerce > Settings > API > Key/Apps prior to WooCommerce 3.4.
  2. Select Add Key. You are taken to the Key Details screen.
  3. Add a Description.
  4. Select the User you would like to generate a key for in the dropdown.
  5. Select a level of access for this API key — Read access, Write access or Read/Write access.
  6. Select Generate API Key, and WooCommerce creates API keys for that user.

 

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

The Consumer Key and Consumer Secret may be entered in the application using the WooCommerce API, and the app should also request your URL.

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

Test if the API is working ↑ Back to top

Use this 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