> For the complete documentation index, see [llms.txt](https://rymera.gitbook.io/wholesale-suite-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rymera.gitbook.io/wholesale-suite-api/master.md).

# REST API

### Requirements <a href="#requirements" id="requirements"></a>

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](https://github.com/woocommerce/woocommerce/issues/9838) for details.

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

### Official libraries&#x20;

* [JavaScript](https://www.npmjs.com/package/@woocommerce/woocommerce-rest-api) Library
* [PHP](https://packagist.org/packages/automattic/woocommerce) Library
* [Python](https://pypi.python.org/pypi/WooCommerce) Library
* [Ruby](https://rubygems.org/gems/woocommerce_api) Library

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:

{% embed url="<https://woocommerce.github.io/woocommerce-rest-api-docs/#authentication>" %}

### 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`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://rymera.gitbook.io/wholesale-suite-api/master.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.