# On-sale products in a WooCommerce store, every variant

**Use case:** 

Reads a WooCommerce store's public Store API and returns only products currently on sale, cheapest first, with one extra row per variation carrying its own price, sale price, stock and attributes — so you see which sizes and colours are actually discounted and in stock. Point it at any WooCommerce store, remove the sale filter for the full catalogue, or add a search term.

## Input

```json
{
  "stores": [
    "https://woocommerce.com"
  ],
  "search": "",
  "categories": [],
  "onSaleOnly": true,
  "onlyAvailable": false,
  "orderBy": "price",
  "rowPerVariant": true,
  "includeCategories": false,
  "includeDescriptionHtml": false,
  "includeImages": true,
  "maxProductsPerStore": 200,
  "maxConcurrency": 3,
  "maxRunSecs": 240,
  "proxyConfiguration": {
    "useApifyProxy": true
  }
}
```

## Output

```json
{
  "name": {
    "label": "Name",
    "format": "string"
  },
  "sku": {
    "label": "SKU",
    "format": "string"
  },
  "price": {
    "label": "Price",
    "format": "number"
  },
  "regularPrice": {
    "label": "Regular price",
    "format": "number"
  },
  "currency": {
    "label": "Currency",
    "format": "string"
  },
  "onSale": {
    "label": "On sale",
    "format": "boolean"
  },
  "stockStatus": {
    "label": "Stock status",
    "format": "string"
  },
  "stockQuantity": {
    "label": "Stock quantity",
    "format": "integer"
  },
  "categories": {
    "label": "Categories",
    "format": "array"
  },
  "url": {
    "label": "Page",
    "format": "string"
  }
}
```

## How it works

### 1. Sign up on Apify or log in

The WooCommerce Products API — Prices, Variants & Stock Actor is ready to run with the inputs already set for "On-sale products in a WooCommerce store, every variant". [Sign up or log in](https://console.apify.com/create-task-from-example/bc8BeIRn0MeKK2ych) and you'll land in Apify Console with a copy of this exact task.

### 2. Start the "On-sale products in a WooCommerce store, every variant" task

The WooCommerce Products API — Prices, Variants & Stock Actor will start running based on the input automatically. You can also change all the input fields, like woocommerce stores, categories, and more, to match your specific use case.

### 3. Receive the "On-sale products in a WooCommerce store, every variant" output

Monitor the progress in real time. You will be notified as soon as your dataset is complete and ready for review. Each result includes data such as name, SKU, price, and more.

### 4. Integrate into your workflow

The final output is delivered in JSON, CSV, or Excel format, ready to be plugged into your workflow. You can also [run the "On-sale products in a WooCommerce store, every variant" task via API](https://apify.com/insight.solutions/woocommerce-products-api.md).

## About this Actor

This example demonstrates how to use [WooCommerce Products API — Prices, Variants & Stock](https://apify.com/insight.solutions/woocommerce-products-api.md) with a specific input configuration. Visit the [Actor detail page](https://apify.com/insight.solutions/woocommerce-products-api.md) to learn more, explore other use cases, and run it yourself.


## How to integrate an Actor?

This Task's input is already configured above. Use it as-is rather than inventing a new one.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For full API examples (JavaScript, Python, CLI, MCP, OpenAPI), see this Task's Actor page: https://apify.com/insight.solutions/woocommerce-products-api.md

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).