WooCommerce REST API

This repository is home to the WooCommerce REST API package.

The stable version of this package is bundled with WooCommerce core releases, but it can also be used as a standalone plugin so bleeding-edge API features can be tested or used by other feature plugins.

Using this repo

After checking out the code, you'll need to run composer install in it's root directory to install dependencies and to enable the autoloader.

Using this package

This package is hosted on Packagist and can be included using composer.json:

"require": {
    "woocommerce/woocommerce-rest-api": "1.0.0"
},

Since multiple versions of this package may be included at the same time, WooCommerce handles loading only the latest version by using a special loader.

After including the package and installing dependencies, include the main woocommerce-rest-api.php file in your code:

include 'vendor/woocommerce-rest-api/woocommerce-rest-api.php';

This will register the version of the package with WooCommerce and make it available after the woocommerce_loaded hook is fired.

API documentation

• Usage documentation for the REST API can be found here.
• Contribution documentation can be found here.

Versions

Namespace	Status	Docs
wc/v4	Development	Link
wc/v3	Stable	Link
wc/v2	Deprecated - October 2020	Link
wc/v1	Deprecated - April 2019	Link

Note: API Versions are kept around for 2 years after being replaced, and may be removed in the next major version after that date passes.

Contributing

Please read the WooCommerce contributor guidelines for more information how you can contribute to WooCommerce, and the REST API contribution documentation here.

Within this package, namespaces and endpoint classes are located within the src/RestAPI/ directory. If you need to change the behavior of an endpoint, you can do so in these classes.

Run tests using phpunit in the root of the package. All pull-requests must pass unit tests in order to be accepted.

Translation

For strings located in API endpoints, use woocommerce as your text-domain. These endpoints will be translated in the WooCommerce Core PO/MO files.