# WooCommerce Scraper ⭐5.0 (`jupri/woocommerce`)

💫 Scrape  WooCommerce and WordPress websites

- **URL**: https://beta-securitybyobscurity.apify.com/jupri/woocommerce.md
- **Developed by:** [cat](https://beta-securitybyobscurity.apify.com/jupri) (community)
- **Categories:** E-commerce
- **Stats:** 2,151 total users, 61 monthly users, 67.3% runs succeeded, 23 bookmarks
- **User rating**: 2.18 out of 5 stars

## Pricing

$3.00 / 1,000 results

This Actor is paid per result. You are not charged for the Apify platform usage, but only a fixed price for dataset items the Actor outputs.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-result

# README

## 💫 Welcome to WooCommerce Scraper

<img height="32" src="https://apify.com/actor-badge?actor=jupri~woocommerce" align="right">

![dont be sad readme is here](https://raw.githubusercontent.com/JupriGH/resources/main/cats/catframe.png)

### 🛒 About WooCommerce

<img src="https://upload.wikimedia.org/wikipedia/commons/d/d8/WooCommerce2025_logo.svg" height="128">

<img src="https://upload.wikimedia.org/wikipedia/commons/2/2a/WooCommerce_logo.svg" height="128" align="right">

**WooCommerce** is an [open-source](https://en.wikipedia.org/wiki/Open-source_software "Open-source software")  [e-commerce](https://en.wikipedia.org/wiki/E-commerce "E-commerce")  [plugin](https://en.wikipedia.org/wiki/Plug-in_\(computing\) "Plug-in (computing)") for [WordPress](https://en.wikipedia.org/wiki/WordPress "WordPress"). It is designed for small to large-sized online [merchants](https://en.wikipedia.org/wiki/Merchants "Merchants") using WordPress. Launched on September 27, 2011,[\[3\]](https://en.wikipedia.org/wiki/WooCommerce#cite_note-3) the plugin quickly became popular for its simplicity to install and customize and for the market position of the base product as freeware (even though many of its optional extensions are paid and proprietary). WooCommerce is developed and supported by Woo and includes contributions from a global community of developers.[\[4\]](https://en.wikipedia.org/wiki/WooCommerce#cite_note-4)

### 🛒 About This Actor

💫 Scrape WordPress or WooCommerce Websites

### 🛒 Tutorial

#### Input Parameters

| Name | Type | Description |
|-|-|-|
| `url` | ***array*** | List of `URL` |
| `resource` | ***string*** | Resource type to scrape |
| `limit` | ***integer*** | Number of results |
| `filters` | ***object*** | Search filters |

#### Supported URL

| Type | Examples |
|-|-|
| Homepage URL | `https://www.woocommerce.com`
| Category URL | `https://woocommerce.com/product-category/themes/arts-and-crafts/`
| Brands URL |  `https://woocommerce.com/brands/apify/`
| Product URL | `https://woocommerce.com/products/woopayments/`
| *etc.*

### 🛒 Input Examples

**Scrape product list**

```yaml
{ "url": ["https://www.woocommerce.com"], "limit": 100, "resource": "products" }
```

**Scrape specific products info**

```yaml
{ "url": ["https://woocommerce.com/products/woopayments/"] }
```

**Scrape category list**

```yaml
{ "url": ["https://www.woocommerce.com"], "limit": 20, "resource": "categories" }
```

### 🛒 Support

<img src="https://apify-uploads-prod.s3.us-east-1.amazonaws.com/5SxZhwYwpknFk8ek9-cat.gif" width="240">

Feel free to [reach out](https://console.apify.com/actors/XX8HRK0M62EEfpwNe/issues) to the developer for any issues or suggestions for improvement.

# Actor input Schema

## `url` (type: `array`):

💡 Where do you want to Shop ?

## `limit` (type: `integer`):

Number of results (per-query)

## `resource` (type: `string`):

No description

## `format` (type: `string`):

💡 Output format for Descriptions. <code>(default: Markdown)</code>

## `sort` (type: `string`):

Sort results by attribute

## `order` (type: `string`):

Order sort direction

## `search` (type: `string`):

💡 Limit results to those matching a string.

## `sku` (type: `string`):

💡 Limit result set to products with specific SKU(s). Use commas to separate.

## `rating` (type: `array`):

No description

## `min_price` (type: `integer`):

Limit result set to products based on a price.

## `max_price` (type: `integer`):

No description

## `tax_class` (type: `string`):

Limit result set to products with a specific tax class.

## `category` (type: `string`):

Product Category ID(s) separated by comma

## `tag` (type: `string`):

Product Tag ID(s) separated by comma

## `product_type` (type: `string`):

Products assigned a specific type

## `status` (type: `string`):

No description

## `stock` (type: `string`):

No description

## `featured` (type: `boolean`):

Featured products

## `sale` (type: `boolean`):

Products on sale

## `dev_proxy_config` (type: `object`):

💡 <b>Supported protocol:</b><br><br><b>HTTP(S), SOCKS5</b><br><code>{http|socks5}://{user:pass}@{hostname|ip-address}:port</code><br><br><b>Example</b>: <code>socks5://example.com:9000</code>

## `dev_custom_headers` (type: `array`):

💡 Additional HTTP Headers

## `dev_custom_cookies` (type: `array`):

💡 Additional HTTP Cookies

## `dev_transform_fields` (type: `array`):

💡 <b>Transform the resulting output. Select only needed fields.</b><br><br>For nested object use <b>DOT</b>. For example: <pre>address.streetAddress</pre><br>For nested array use <b>NUMBER</b> <i>(index of array element starting from index=0)</i>. For example: <pre>images.0.url</pre>

## `dev_dataset_name` (type: `string`):

💡 <b>Save results into custom named Dataset, use mask to customize dataset name</b><br><br><code>{ACTOR} = actor name<br>{DATE} = date (YYYYMMDD)<br>{TIME} = time (HHMMSS)</code><br><br>This masks can be used to autogenerate Dataset Name.<br><br>example: <i><code>data-{DATE}</code></i><br>Depending on today date the dataset name will be: <code>data-20230603</code><i><br><br>default: <code>data-{ACTOR}-{DATE}-{TIME}</code></i>

## `dev_dataset_clear` (type: `boolean`):

Clear Dataset before insert/update.

## `dev_no_strip` (type: `boolean`):

💡 Keep/Save empty values <i><code>(NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)</code></i>

## Actor input object example

```json
{
  "url": [
    "https://woocommerce.com"
  ],
  "limit": 5
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "url": [
        "https://woocommerce.com"
    ],
    "limit": 5
};

// Run the Actor and wait for it to finish
const run = await client.actor("jupri/woocommerce").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "url": ["https://woocommerce.com"],
    "limit": 5,
}

# Run the Actor and wait for it to finish
run = client.actor("jupri/woocommerce").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "url": [
    "https://woocommerce.com"
  ],
  "limit": 5
}' |
apify call jupri/woocommerce --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=jupri/woocommerce",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "WooCommerce Scraper ⭐5.0",
        "description": "💫 Scrape  WooCommerce and WordPress websites",
        "version": "0.3",
        "x-build-id": "dv89xAtzn6btH6hhL"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/jupri~woocommerce/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-jupri-woocommerce",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/jupri~woocommerce/runs": {
            "post": {
                "operationId": "runs-sync-jupri-woocommerce",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/jupri~woocommerce/run-sync": {
            "post": {
                "operationId": "run-sync-jupri-woocommerce",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "properties": {
                    "url": {
                        "title": "❓ URL",
                        "type": "array",
                        "description": "💡 Where do you want to Shop ?",
                        "items": {
                            "type": "string"
                        }
                    },
                    "limit": {
                        "title": "♾️ Limit",
                        "type": "integer",
                        "description": "Number of results (per-query)"
                    },
                    "resource": {
                        "title": "📁 Resource",
                        "enum": [
                            "products",
                            "categories",
                            "brands",
                            "tags",
                            "attributes",
                            "reviews",
                            "pages",
                            "posts",
                            "comments",
                            "post-categories",
                            "post-tags",
                            "users"
                        ],
                        "type": "string",
                        "description": ""
                    },
                    "format": {
                        "title": "Format",
                        "enum": [
                            "md",
                            "text",
                            "html"
                        ],
                        "type": "string",
                        "description": "💡 Output format for Descriptions. <code>(default: Markdown)</code>"
                    },
                    "sort": {
                        "title": "Sorting",
                        "enum": [
                            "date",
                            "modified",
                            "id",
                            "include",
                            "title",
                            "slug",
                            "price",
                            "popularity",
                            "rating",
                            "menu_order",
                            "comment_count"
                        ],
                        "type": "string",
                        "description": "Sort results by attribute"
                    },
                    "order": {
                        "title": "",
                        "enum": [
                            "",
                            "asc",
                            "desc"
                        ],
                        "type": "string",
                        "description": "Order sort direction"
                    },
                    "search": {
                        "title": "Search",
                        "type": "string",
                        "description": "💡 Limit results to those matching a string."
                    },
                    "sku": {
                        "title": "SKU",
                        "type": "string",
                        "description": "💡 Limit result set to products with specific SKU(s). Use commas to separate."
                    },
                    "rating": {
                        "title": "Product Ratings",
                        "type": "array",
                        "description": "",
                        "items": {
                            "type": "string",
                            "enum": [
                                "5",
                                "4",
                                "3",
                                "2",
                                "1"
                            ],
                            "enumTitles": [
                                "5 stars",
                                "4 stars",
                                "3 stars",
                                "2 stars",
                                "1 star"
                            ]
                        }
                    },
                    "min_price": {
                        "title": "Price Range",
                        "type": "integer",
                        "description": "Limit result set to products based on a price."
                    },
                    "max_price": {
                        "title": "",
                        "type": "integer",
                        "description": ""
                    },
                    "tax_class": {
                        "title": "Tax Class",
                        "enum": [
                            "",
                            "standard",
                            "reduced-rate",
                            "zero-rate"
                        ],
                        "type": "string",
                        "description": "Limit result set to products with a specific tax class."
                    },
                    "category": {
                        "title": "Category",
                        "type": "string",
                        "description": "Product Category ID(s) separated by comma"
                    },
                    "tag": {
                        "title": "Tag",
                        "type": "string",
                        "description": "Product Tag ID(s) separated by comma"
                    },
                    "product_type": {
                        "title": "Product Type",
                        "enum": [
                            "",
                            "simple",
                            "grouped",
                            "external",
                            "variable",
                            "wbs_bundle",
                            "variation"
                        ],
                        "type": "string",
                        "description": "Products assigned a specific type"
                    },
                    "status": {
                        "title": "Product Status",
                        "enum": [
                            "",
                            "future",
                            "trash",
                            "draft",
                            "pending",
                            "private",
                            "publish"
                        ],
                        "type": "string",
                        "description": ""
                    },
                    "stock": {
                        "title": "Stock Status",
                        "enum": [
                            "",
                            "instock",
                            "outofstock",
                            "onbackorder"
                        ],
                        "type": "string",
                        "description": ""
                    },
                    "featured": {
                        "title": "Featured",
                        "type": "boolean",
                        "description": "Featured products"
                    },
                    "sale": {
                        "title": "On Sale",
                        "type": "boolean",
                        "description": "Products on sale"
                    },
                    "dev_proxy_config": {
                        "title": "🌐 PROXY NETWORKING",
                        "type": "object",
                        "description": "💡 <b>Supported protocol:</b><br><br><b>HTTP(S), SOCKS5</b><br><code>{http|socks5}://{user:pass}@{hostname|ip-address}:port</code><br><br><b>Example</b>: <code>socks5://example.com:9000</code>"
                    },
                    "dev_custom_headers": {
                        "title": "📜 HTTP HEADERS",
                        "type": "array",
                        "description": "💡 Additional HTTP Headers",
                        "items": {
                            "type": "object",
                            "required": [
                                "key",
                                "value"
                            ],
                            "properties": {
                                "key": {
                                    "type": "string",
                                    "title": "Key"
                                },
                                "value": {
                                    "type": "string",
                                    "title": "Value"
                                }
                            }
                        }
                    },
                    "dev_custom_cookies": {
                        "title": "🍰 HTTP COOKIES",
                        "type": "array",
                        "description": "💡 Additional HTTP Cookies",
                        "items": {
                            "type": "object",
                            "required": [
                                "key",
                                "value"
                            ],
                            "properties": {
                                "key": {
                                    "type": "string",
                                    "title": "Key"
                                },
                                "value": {
                                    "type": "string",
                                    "title": "Value"
                                }
                            }
                        }
                    },
                    "dev_transform_fields": {
                        "title": "♻️ CUSTOM FIELD",
                        "type": "array",
                        "description": "💡 <b>Transform the resulting output. Select only needed fields.</b><br><br>For nested object use <b>DOT</b>. For example: <pre>address.streetAddress</pre><br>For nested array use <b>NUMBER</b> <i>(index of array element starting from index=0)</i>. For example: <pre>images.0.url</pre>",
                        "items": {
                            "type": "object",
                            "required": [
                                "key",
                                "value"
                            ],
                            "properties": {
                                "key": {
                                    "type": "string",
                                    "title": "Key"
                                },
                                "value": {
                                    "type": "string",
                                    "title": "Value"
                                }
                            }
                        }
                    },
                    "dev_dataset_name": {
                        "title": "📁 CUSTOM STORAGE",
                        "type": "string",
                        "description": "💡 <b>Save results into custom named Dataset, use mask to customize dataset name</b><br><br><code>{ACTOR} = actor name<br>{DATE} = date (YYYYMMDD)<br>{TIME} = time (HHMMSS)</code><br><br>This masks can be used to autogenerate Dataset Name.<br><br>example: <i><code>data-{DATE}</code></i><br>Depending on today date the dataset name will be: <code>data-20230603</code><i><br><br>default: <code>data-{ACTOR}-{DATE}-{TIME}</code></i>"
                    },
                    "dev_dataset_clear": {
                        "title": "Clear Storage",
                        "type": "boolean",
                        "description": "Clear Dataset before insert/update."
                    },
                    "dev_no_strip": {
                        "title": "Disable data cleansing",
                        "type": "boolean",
                        "description": "💡 Keep/Save empty values <i><code>(NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)</code></i>"
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
