> ## Documentation Index
> Fetch the complete documentation index at: https://nango-wari-migrated-bigcommerce-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Woocommerce

## Overview

<CardGroup cols={3}>
  <Card title="Pre-built tooling" icon="screwdriver-wrench" href="#pre-built-tooling" />

  <Card title="Pre-built integrations" icon="square-check" href="#pre-built-integrations" />

  <Card title="Access requirements" icon="triangle-exclamation" href="#access-requirements" />

  <Card title="Setup guide" icon="rocket" href="#setup-guide" />

  <Card title="Useful links" icon="circle-info" href="#useful-links" />

  <Card title="API gotchas" icon="biohazard" href="#api-gotchas" />
</CardGroup>

## Pre-built tooling

<AccordionGroup>
  <Accordion title="✅ Authorization">
    | Tools                           | Status |
    | ------------------------------- | ------ |
    | Pre-built authorization (Basic) | ✅      |
    | Pre-built authorization UI      | ✅      |
    | Custom authorization UI         | ✅      |
    | End-user authorization guide    | ✅      |
    | Expired credentials detection   | ✅      |
  </Accordion>

  <Accordion title="✅ Read & write data">
    | Tools                                     | Status                         |
    | ----------------------------------------- | ------------------------------ |
    | Pre-built integrations                    | ✅                              |
    | API unification                           | ✅                              |
    | 2-way sync                                | ✅                              |
    | Webhooks from Nango on data modifications | ✅                              |
    | Real-time webhooks from 3rd-party API     | 🚫 (time to contribute: \<48h) |
    | Proxy requests                            | ✅                              |
  </Accordion>

  <Accordion title="✅ Observability & data quality">
    | Tools                   | Status |
    | ----------------------- | ------ |
    | HTTP request logging    | ✅      |
    | End-to-end type safety  | ✅      |
    | Data runtime validation | ✅      |
    | OpenTelemetry export    | ✅      |
    | Slack alerts on errors  | ✅      |
    | Integration status API  | ✅      |
  </Accordion>

  <Accordion title="✅ Customization">
    | Tools                              | Status                         |
    | ---------------------------------- | ------------------------------ |
    | Create or customize use-cases      | ✅                              |
    | Pre-configured pagination          | 🚫 (time to contribute: \<48h) |
    | Pre-configured rate-limit handling | 🚫 (time to contribute: \<48h) |
    | Per-customer configurations        | ✅                              |
  </Accordion>
</AccordionGroup>

### Others

| Function name                 | Description                                                 | Type                                           | Source code                                                                                                                             |
| ----------------------------- | ----------------------------------------------------------- | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `batch-update-orders`         | Create, update, and delete WooCommerce orders in a batch.   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/batch-update-orders.ts)         |
| `batch-update-products`       | Create, update, and delete WooCommerce products in a batch. | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/batch-update-products.ts)       |
| `create-order-note`           | Create a note on a WooCommerce order.                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/create-order-note.ts)           |
| `create-order`                | Create a order in WooCommerce.                              | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/create-order.ts)                |
| `create-product-category`     | Create a product category in WooCommerce.                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/create-product-category.ts)     |
| `create-product-review`       | Create a product review in WooCommerce.                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/create-product-review.ts)       |
| `create-product-tag`          | Create a product tag in WooCommerce.                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/create-product-tag.ts)          |
| `create-product-variation`    | Create a product variation in WooCommerce.                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/create-product-variation.ts)    |
| `create-product`              | Create a product in WooCommerce.                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/create-product.ts)              |
| `create-refund`               | Create a refund in WooCommerce.                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/create-refund.ts)               |
| `create-webhook`              | Create a webhook in WooCommerce.                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/create-webhook.ts)              |
| `delete-coupon`               | Delete or archive a coupon in WooCommerce.                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/delete-coupon.ts)               |
| `delete-customer`             | Delete or archive a customer in WooCommerce.                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/delete-customer.ts)             |
| `delete-order-note`           | Delete a note from a WooCommerce order.                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/delete-order-note.ts)           |
| `delete-order`                | Delete or archive a order in WooCommerce.                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/delete-order.ts)                |
| `delete-product-category`     | Delete or archive a product category in WooCommerce.        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/delete-product-category.ts)     |
| `delete-product-review`       | Delete or archive a product review in WooCommerce.          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/delete-product-review.ts)       |
| `delete-product-variation`    | Delete or archive a product variation in WooCommerce.       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/delete-product-variation.ts)    |
| `delete-product`              | Delete or archive a product in WooCommerce                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/delete-product.ts)              |
| `delete-refund`               | Delete or archive a refund in WooCommerce.                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/delete-refund.ts)               |
| `delete-webhook`              | Delete or archive a webhook in WooCommerce.                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/delete-webhook.ts)              |
| `get-coupon`                  | Retrieve a single coupon from WooCommerce                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/get-coupon.ts)                  |
| `get-coupons-totals-report`   | Retrieve the coupons totals report from WooCommerce.        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/get-coupons-totals-report.ts)   |
| `get-customer`                | Retrieve a single customer from WooCommerce.                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/get-customer.ts)                |
| `get-customers-totals-report` | Retrieve the customers totals report from WooCommerce.      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/get-customers-totals-report.ts) |
| `get-order-note`              | Retrieve a single order note from WooCommerce.              | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/get-order-note.ts)              |
| `get-order`                   | Retrieve a single order from WooCommerce.                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/get-order.ts)                   |
| `get-orders-totals-report`    | Retrieve the orders totals report from WooCommerce.         | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/get-orders-totals-report.ts)    |
| `get-product-category`        | Retrieve a single product category from WooCommerce.        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/get-product-category.ts)        |
| `get-product-review`          | Retrieve a single product review from WooCommerce.          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/get-product-review.ts)          |
| `get-product-tag`             | Retrieve a single product tag from WooCommerce.             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/get-product-tag.ts)             |
| `get-product-variation`       | Retrieve a single product variation from WooCommerce        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/get-product-variation.ts)       |
| `get-product`                 | Retrieve a single product from WooCommerce                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/get-product.ts)                 |
| `get-products-totals-report`  | Retrieve the products totals report from WooCommerce.       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/get-products-totals-report.ts)  |
| `get-sales-report`            | Retrieve the sales report from WooCommerce.                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/get-sales-report.ts)            |
| `get-top-sellers-report`      | Retrieve the top sellers report from WooCommerce.           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/get-top-sellers-report.ts)      |
| `list-coupons`                | List coupons from WooCommerce.                              | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/list-coupons.ts)                |
| `list-customers`              | List customers from WooCommerce.                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/list-customers.ts)              |
| `list-order-notes`            | List notes for a WooCommerce order.                         | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/list-order-notes.ts)            |
| `list-orders`                 | List orders from WooCommerce                                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/list-orders.ts)                 |
| `list-product-categories`     | List product categories from WooCommerce.                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/list-product-categories.ts)     |
| `list-product-reviews`        | List product reviews from WooCommerce.                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/list-product-reviews.ts)        |
| `list-product-variations`     | List product variations from WooCommerce.                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/list-product-variations.ts)     |
| `list-products`               | List products from WooCommerce.                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/list-products.ts)               |
| `list-refunds`                | List refunds from WooCommerce                               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/list-refunds.ts)                |
| `list-reports`                | List available WooCommerce reports.                         | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/list-reports.ts)                |
| `list-webhooks`               | List webhooks from WooCommerce.                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/list-webhooks.ts)               |
| `update-customer`             | Update a customer in WooCommerce.                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/update-customer.ts)             |
| `update-product-category`     | Update a product category in WooCommerce.                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/update-product-category.ts)     |
| `update-product-review`       | Update a product review in WooCommerce                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/update-product-review.ts)       |
| `update-product-tag`          | Update a product tag in WooCommerce.                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/update-product-tag.ts)          |
| `update-product-variation`    | Update a product variation in WooCommerce.                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/update-product-variation.ts)    |
| `update-product`              | Update a product in WooCommerce.                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/update-product.ts)              |
| `update-webhook`              | Update a webhook in WooCommerce.                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/actions/update-webhook.ts)              |
| `coupons`                     | Sync coupons from WooCommerce.                              | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/syncs/coupons.ts)                       |
| `customers`                   | Sync customers from WooCommerce.                            | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/syncs/customers.ts)                     |
| `orders`                      | Sync orders from WooCommerce.                               | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/syncs/orders.ts)                        |
| `product-categories`          | Sync product categories from WooCommerce.                   | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/syncs/product-categories.ts)            |
| `product-reviews`             | Sync product reviews from WooCommerce.                      | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/syncs/product-reviews.ts)               |
| `product-tags`                | Sync product tags from WooCommerce.                         | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/syncs/product-tags.ts)                  |
| `product-variations`          | Sync product variations from WooCommerce.                   | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/syncs/product-variations.ts)            |
| `refunds`                     | Sync refunds from WooCommerce.                              | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/woocommerce/syncs/refunds.ts)                       |

## Access requirements

| Pre-Requisites    | Status | Comment |
| ----------------- | ------ | ------- |
| Paid dev account  | ❓      |         |
| Paid test account | ❓      |         |
| Partnership       | ❓      |         |
| App review        | ❓      |         |
| Security audit    | ❓      |         |

## Setup guide

*No setup guide yet.*

<Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip>

<Note>Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/woocommerce.mdx)</Note>

## Useful links

* [Generate Woocommerce API credentials](https://woocommerce.github.io/woocommerce-rest-api-docs/#rest-api-keys)
* [Woocommerce basic auth related docs](https://woocommerce.github.io/woocommerce-rest-api-docs/#authentication-over-https)
* [Woocommerce API docs](https://woocommerce.github.io/woocommerce-rest-api-docs)

<Note>Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/woocommerce.mdx)</Note>

## API gotchas

* Woocommerce uses `Basic` auth mode to access different endpoints. Provide your `consumer key` as the Username value and `consumer secret` as the Password value.
* When creating a new connection, please add your `storeURL`.

<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/woocommerce.mdx)</Note>

<Card title="Connect to Woocommerce" icon="link" href="/integrations/all/woocommerce/connect" horizontal>
  Guide to connect to Woocommerce using Nango Connect.
</Card>