Skip to content
Internal/development version of the next WooCommerce REST API release.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
api
assets
tests
.gitignore Add .gitignore May 29, 2017
README.md
composer.json
phpunit.xml
readme.txt Actually bump the version in all the right places, and a README note. ( Mar 21, 2019
wc-api-dev-class.php
wc-api-dev.php

README.md

WooCommerce API Dev

This is a repository for the development version of the WooCommerce REST API. This feature plugin provides a place where the next version of the WooCommerce REST API can be worked on, independent of the current WooCommerce release cycle. These changes are brought over to WooCommerce core when they are ready for release.

  • Current stable API version: v2.
  • Current development version: v3.

Contributing

Please read the WooCommerce contributor guidelines for more information how you can contribute.

Endpoints are located in the api/ folder. Endpoints inherit from the stable version of the endpoint. If you need to change the behavior of an endpoint, you can do so in these classes. You can also introduce new endpoints by adding them to the root plugin file wc-api-dev.php (mirrors core's class-wc-api.php).

phpunit tests for the API are located in the tests/unit-tests/ folder and are also merged and shipped with WooCommerce core. You can use the same helpers/framework files that core uses, or introduce new ones.

Run tests using phpunit in the root of this folder. Code coverage reports can be ran with phpunit --coverage-html /tmp/coverage.

Translation

For strings located in API endpoints, use woocommerce as your text-domain. These endpoints will at some point be merged back into WooCommerce Core.

You can’t perform that action at this time.