REST API

Requirements

To use the latest version of the REST API you must be using:

  • WooCommerce 3.5+.

  • WordPress 4.4+.

  • Pretty permalinks in Settings > Permalinks so that the custom endpoints are supported. Default permalinks will not work.

  • You may access the API over either HTTP or HTTPS, but HTTPS is recommended where possible.

If you use ModSecurity and see 501 Method Not Implemented errors, see this issue for details.

source: https://woocommerce.github.io/woocommerce-rest-api-docs/#requirements

Official libraries

source: https://woocommerce.github.io/woocommerce-rest-api-docs/#libraries-and-tools

Authentication

This API follows WC Authentication. See WC doc on how to set-up consumer key/secret:

Permission:

If your only using the api to view data, just set the user permission to read.

If your only using it for manipulating data then use write.

If you want both then set permission to read/write.

Last updated