> For the complete documentation index, see [llms.txt](https://docs.perkville.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.perkville.com/integrations/integration-reference/woocommerce.md).

# WooCommerce

Use WooCommerce sales data for purchase-based earning.

## Integration at a glance <a href="#capabilities-and-use-cases" id="capabilities-and-use-cases"></a>

* **Purchases** — Filter earning by product or product category; refund handling is supported.
* **Access** — The documented connection uses read permission. It does not automatically fulfill rewards in WooCommerce.

Your configured rules determine which eligible activities award points and which workflows are enabled.

## Integration Steps

1. Log into a WordPress account with admin privileges
2. Click on the WooCommerce app in the left-hand menu in WordPress and then Settings
3. Click Advanced in the Settings menu and then REST API
4. Click Add Key to create the API Key. Select your admin user account. In the permissions field select Read.
5. Click to Generate API Key
6. Further details in this process can be [found here](http://woocommerce.github.io/woocommerce-rest-api-docs/#rest-api-keys)
7. Securely transfer the Customer Key and Secret along with your website URL to your Perkville representative by using [OneTimeSecret](https://onetimesecret.com/). (Save a copy of the customer key and secret for your reference).

<br>

## FAQ

### Can this connection write rewards back to WooCommerce?

The documented credentials use Read permission, and automatic redemptions are not included. Discuss any custom fulfillment workflow separately.

See the [WooCommerce partner profile](https://partners.perkville.com/partners/woocommerce) for additional integration information.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.perkville.com/integrations/integration-reference/woocommerce.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
