PHPackages                             woocommerce/woocommerce-rest-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. woocommerce/woocommerce-rest-api

AbandonedArchivedWordpress-plugin

woocommerce/woocommerce-rest-api
================================

The WooCommerce core REST API.

1.0.15(5y ago)73133.8k—0%47[28 issues](https://github.com/woocommerce/woocommerce-rest-api/issues)[3 PRs](https://github.com/woocommerce/woocommerce-rest-api/pulls)GPL-3.0-or-laterPHP

Since Jul 8Pushed 4y ago78 watchersCompare

[ Source](https://github.com/woocommerce/woocommerce-rest-api)[ Packagist](https://packagist.org/packages/woocommerce/woocommerce-rest-api)[ Docs](https://github.com/woocommerce/woocommerce-rest-api)[ RSS](/packages/woocommerce-woocommerce-rest-api/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (3)Versions (30)Used By (0)

(Deprecated) WooCommerce REST API
=================================

[](#deprecated-woocommerce-rest-api)

##### Notice: This plugin is now merged into WooCommerce core, all open issues and PRs will be eventually transfered to [WooCommerce core](https://github.com/woocommerce/woocommerce) Repo. Please submit all new issues or PRs directly to the core repo.

[](#notice-this-plugin-is-now-merged-into-woocommerce--core-all-open-issues-and-prs-will-be-eventually-transfered-to-woocommerce-core-repo-please-submit-all-new-issues-or-prs-directly-to-the-core-repo)

[![license](https://camo.githubusercontent.com/5ee4224794a1d78fa1e72139e8a5f833c56aafea91adb9a5a815328c54d2a113/68747470733a2f2f706f7365722e707567782e6f72672f776f6f636f6d6d657263652f776f6f636f6d6d657263652d726573742d6170692f6c6963656e7365)](https://packagist.org/packages/woocommerce/woocommerce-rest-api)[![Latest Stable Version](https://camo.githubusercontent.com/291e94cf8b02a58c6ceee9ac102b326a874ddda6ca1b25ad0e9554443dd4d045/68747470733a2f2f706f7365722e707567782e6f72672f776f6f636f6d6d657263652f776f6f636f6d6d657263652d726573742d6170692f762f737461626c65)](https://packagist.org/packages/woocommerce/woocommerce-rest-api)[![Build Status](https://camo.githubusercontent.com/2a0cbcd6143760c3f738550832d37f1cbc0e12c013b7315980ec172aa8a12692/68747470733a2f2f7472617669732d63692e6f72672f776f6f636f6d6d657263652f776f6f636f6d6d657263652d726573742d6170692e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/woocommerce/woocommerce-rest-api/)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/80257480ce0d17a66cede6866866eb0f9eaa727b8d862993f10bd9affdc4a4a3/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f776f6f636f6d6d657263652f776f6f636f6d6d657263652d726573742d6170692f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/woocommerce/woocommerce-rest-api/?branch=master)

This repository is home to the WooCommerce REST API package.

The stable version of this package is bundled with [WooCommerce core](https://github.com/woocommerce/woocommerce) 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. We do not recommend using this repo as a standalone plugin in production.

Using this package as a plugin
------------------------------

[](#using-this-package-as-a-plugin)

After checking out the code to your `wp-content/plugins` directory, you'll need to run `composer install` in the plugin directory (`wp-content/plugins/woocommerce-rest-api`) to install dependencies and to enable the autoloader. Without performing this step, if you activate the plugin it will simply show an admin notice.

API documentation
-----------------

[](#api-documentation)

- [Usage documentation for the REST API can be found here](https://github.com/woocommerce/woocommerce/wiki/Getting-started-with-the-REST-API).
- [Contribution documentation can be found here.](https://github.com/woocommerce/woocommerce/wiki/Contributing-to-the-WooCommerce-REST-API)

### Versions

[](#versions)

NamespaceStatusDocs`wc/v4`Development[Link](https://woocommerce.github.io/woocommerce-rest-api-docs/)`wc/v3`Stable[Link](https://woocommerce.github.io/woocommerce-rest-api-docs/)`wc/v2`Deprecated - October 2020[Link](https://woocommerce.github.io/woocommerce-rest-api-docs/wp-api-v2.html)`wc/v1`Deprecated - April 2019[Link](https://woocommerce.github.io/woocommerce-rest-api-docs/wp-api-v1.html)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.

Using this package in other projects
------------------------------------

[](#using-this-package-in-other-projects)

This package is [hosted on Packagist](https://packagist.org/packages/woocommerce/woocommerce-rest-api) 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, it includes a special package-version autoloader. This dependency is also on Packagist:

```
  "automattic/jetpack-autoloader": "^1"
```

And using this autoloader requires the following include in your codebase:

```
$autoloader = __DIR__ . '/vendor/autoload_packages.php';

```

If you choose to use your own autoloader, please note you won't be able to determine which version of the package is running since it could use the version in WooCommerce core or your version. The namespaces would conflict. All of our feature plugins and packages use the package autoloader.

Contributing
------------

[](#contributing)

Please read the [WooCommerce contributor guidelines](https://github.com/woocommerce/woocommerce/blob/master/.github/CONTRIBUTING.md) for more information how you can contribute to WooCommerce, and [the REST API contribution documentation here](https://github.com/woocommerce/woocommerce/wiki/Contributing-to-the-WooCommerce-REST-API).

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

[](#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.

###  Health Score

43

—

FairBetter than 91% of packages

Maintenance12

Infrequent updates — may be unmaintained

Popularity47

Moderate usage in the ecosystem

Community31

Small or concentrated contributor base

Maturity70

Established project with proven stability

 Bus Factor1

Top contributor holds 57.4% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~21 days

Recently: every ~3 days

Total

20

Last Release

2093d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/d1f9b32f9677791fbef38b00c9225e05800f525b3b13872b118fd344a58350a0?d=identicon)[woocommerce](/maintainers/woocommerce)

![](https://www.gravatar.com/avatar/8295774fc174b6a5b9bd960709949f4de88cd0b8708d711dc5b6676693d41432?d=identicon)[mikejolley](/maintainers/mikejolley)

---

Top Contributors

[![mikejolley](https://avatars.githubusercontent.com/u/90977?v=4)](https://github.com/mikejolley "mikejolley (187 commits)")[![claudiosanches](https://avatars.githubusercontent.com/u/1264099?v=4)](https://github.com/claudiosanches "claudiosanches (59 commits)")[![vedanshujain](https://avatars.githubusercontent.com/u/7571618?v=4)](https://github.com/vedanshujain "vedanshujain (45 commits)")[![rodrigoprimo](https://avatars.githubusercontent.com/u/77215?v=4)](https://github.com/rodrigoprimo "rodrigoprimo (10 commits)")[![ObliviousHarmony](https://avatars.githubusercontent.com/u/6451942?v=4)](https://github.com/ObliviousHarmony "ObliviousHarmony (10 commits)")[![rrennick](https://avatars.githubusercontent.com/u/343847?v=4)](https://github.com/rrennick "rrennick (4 commits)")[![the-csaba](https://avatars.githubusercontent.com/u/45931795?v=4)](https://github.com/the-csaba "the-csaba (2 commits)")[![peterfabian](https://avatars.githubusercontent.com/u/2207451?v=4)](https://github.com/peterfabian "peterfabian (1 commits)")[![szamanis](https://avatars.githubusercontent.com/u/23402062?v=4)](https://github.com/szamanis "szamanis (1 commits)")[![noomz](https://avatars.githubusercontent.com/u/24957?v=4)](https://github.com/noomz "noomz (1 commits)")[![dhruvins](https://avatars.githubusercontent.com/u/11559294?v=4)](https://github.com/dhruvins "dhruvins (1 commits)")[![jeffstieler](https://avatars.githubusercontent.com/u/63922?v=4)](https://github.com/jeffstieler "jeffstieler (1 commits)")[![kloon](https://avatars.githubusercontent.com/u/271630?v=4)](https://github.com/kloon "kloon (1 commits)")[![mindaugasbudreika](https://avatars.githubusercontent.com/u/1477518?v=4)](https://github.com/mindaugasbudreika "mindaugasbudreika (1 commits)")[![nikhil-webkul](https://avatars.githubusercontent.com/u/54429476?v=4)](https://github.com/nikhil-webkul "nikhil-webkul (1 commits)")[![andrewminion-luminfire](https://avatars.githubusercontent.com/u/47227887?v=4)](https://github.com/andrewminion-luminfire "andrewminion-luminfire (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/woocommerce-woocommerce-rest-api/health.svg)

```
[![Health](https://phpackages.com/badges/woocommerce-woocommerce-rest-api/health.svg)](https://phpackages.com/packages/woocommerce-woocommerce-rest-api)
```

###  Alternatives

[tailpress/tailpress

The Tailwind CSS powered WordPress boilerplate theme.

1.4k2.9k](/packages/tailpress-tailpress)[wp-pay/core

Core components for the WordPress payment processing library.

29119.8k97](/packages/wp-pay-core)[automattic/jetpack

Jetpack supercharges your self‑hosted WordPress site with the awesome cloud power of WordPress.com

3621.9k](/packages/automattic-jetpack)[wp-pay-extensions/gravityforms

Gravity Forms driver for the WordPress payment processing library.

1133.3k2](/packages/wp-pay-extensions-gravityforms)[bitpoke/stack-mu-plugin

WordPress must-use plugin for Stack

1219.5k](/packages/bitpoke-stack-mu-plugin)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)