# BigCommerce Extractor (`jupri/bigcommerce`) Actor
💫 Scrape BigCommerce Websites
- **URL**: https://apify.com/jupri/bigcommerce.md
- **Developed by:** [cat](https://apify.com/jupri) (community)
- **Categories:** E-commerce
- **Stats:** 97 total users, 0 monthly users, 85.3% runs succeeded, 2 bookmarks
- **User rating**: No ratings yet
## Pricing
$5.00 / 1,000 results
This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event
## What's an Apify Actor?
Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".
## How to integrate an Actor?
If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.
- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).
For usage examples, see the [API](#api) section below.
For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).
# README
## Welcome To BigCommerce Scraper
### 🛒 About BigCommerce.com
**BigCommerce Inc.** is a [NASDAQ](https://en.wikipedia.org/wiki/NASDAQ "NASDAQ")-listed [ecommerce platform](https://en.wikipedia.org/wiki/Ecommerce_platform "Ecommerce platform") that provides [software as a service](https://en.wikipedia.org/wiki/Software_as_a_service "Software as a service") services to retailers.[\[2\]](https://en.wikipedia.org/wiki/BigCommerce#cite_note-TechCrunch1-2) The company's platform includes online store creation, [search engine optimization](https://en.wikipedia.org/wiki/Search_engine_optimization "Search engine optimization"), hosting, and marketing and security from small to Enterprise sized businesses.[\[3\]](https://en.wikipedia.org/wiki/BigCommerce#cite_note-3)[\[4\]](https://en.wikipedia.org/wiki/BigCommerce#cite_note-kia-4)
### 🛒 About This Actor
#### Features :
- 💫 Extract Products info from **BigCommerce** [powered websites](https://trends.builtwith.com/websitelist/BigCommerce)
- 💫 Extract Multiple `URL` on single request
#### **Disclaimer:**
- 💫 *This Actor may not work on all websites due to differences in site structure, frequent updates, or specific technical limitations.*
### 🛒 Tutorial
#### Input Parameters
| Name | Type | Description |
|-|-|-|
| `query` | ***array*** | List of `URL` |
| `limit` | ***integer*** | Number of results `(per-query / URL)` |
| `filters` | ***object*** | Various filters |
#### Supported URL
- Store Homepage `URL`
- Category `URL`
- Brand `URL`
- Product `URL`
### 🛒 Output Samples
#### Product Detail
```yaml
{
"addToCartUrl": "https://store.almanac.com/cart.php?action=add&product_id=1241",
"availability": {
"description": "",
"status": "Available"
},
"brand": {
"defaultImage": {
"caption": "",
"isDefault": true,
"url": "https://cdn11.bigcommerce.com/s-s8dcj5rpmy/images/stencil/original/p/ofa_1651498655__71520.original.jpg"
},
"id": 46,
"name": "The Old Farmer's Almanac",
"products": {
"collectionInfo": {
"totalItems": 66
}
},
"searchKeywords": [],
"seo": {
"metaDescription": "",
"pageTitle": ""
},
"url": "https://store.almanac.com/brands/The-Old-Farmer%27s-Almanac.html"
},
"categories": [
{
"breadcrumbs": [
{
"id": 26,
"name": "Digital",
"url": "https://store.almanac.com/digital"
},
{
"id": 223,
"name": "Cooking Guides",
"url": "https://store.almanac.com/digital/cooking-guides/"
}
],
"defaultImage": null,
"defaultProductSort": "FEATURED",
"description": "",
"id": 223,
"name": "Cooking Guides",
"url": "https://store.almanac.com/digital/cooking-guides/"
},
{
"breadcrumbs": [
{
"id": 38,
"name": "Home",
"url": "https://store.almanac.com/home/"
},
{
"id": 55,
"name": "Kitchen",
"url": "https://store.almanac.com/home/kitchen/"
},
{
"id": 54,
"name": "Cookbooks",
"url": "https://store.almanac.com/kitchen/cookbooks/"
}
],
"defaultImage": null,
"defaultProductSort": "FEATURED",
"description": "There's always something cooking at _The Old Farmer's Almanac._ Shop here for\nAlmanac cookbooks that are loaded with award-winning recipes from our food\neditors, celebrity chefs, and even our readers!",
"id": 54,
"name": "Cookbooks",
"url": "https://store.almanac.com/kitchen/cookbooks/"
}
],
"condition": "NEW",
"customFields": [],
"defaultImage": {
"caption": "",
"isDefault": true,
"url": "https://cdn11.bigcommerce.com/s-s8dcj5rpmy/images/stencil/original/products/1241/14156/Spices_herbs_hero_image_2550px__83446.1694805655.jpg"
},
"depth": null,
"description": "_Guide to Spices & Herbs in the Kitchen_, from _The Old Farmer's Almanac's_\neditors, takes the guesswork out of creating flavorful meals, making cooking\neven more enjoyable.\n\nThis 16-page guide that is **delivered as a printable PDF file** that you can\nsave on your computer or tablet. It contains 34 easy recipes teaching you how\nand why to use 25 common spices and herbs in delicious family meals. Prepare\ntastier dishes and make more appetizing meals by using the reliable recipes\nand quick-reference charts, while the herbs are alphabetized for your\nconvenience.\n\n\"I just downloaded the _Guide to Spices & Herbs in the Kitchen_. I love it!!!\nI was actually looking for a book that had all the basics -- what spices and\nherbs to use with what, what kind of flavor each has, etc. This has it all.\nThe pictures are gorgeous, love the recipes, the lore about each. It's\nbeautifully done. I printed it out and put it in a nice plastic cover and now\nI keep it in my kitchen where it's in easy reach. Thank you, thank you!!\" \n--Adelaide P.",
"description_snippet": "Guide to Spices & Herbs in the Kitchen, from The Old Farmer's Almanac's editors, takes the guesswork out of...",
"giftWrappingOptions": [],
"gtin": null,
"height": null,
"id": 1241,
"images": [
{
"caption": "",
"isDefault": true,
"url": "https://cdn11.bigcommerce.com/s-s8dcj5rpmy/images/stencil/original/products/1241/14156/Spices_herbs_hero_image_2550px__83446.1694805655.jpg"
},
{
"caption": "",
"isDefault": false,
"url": "https://cdn11.bigcommerce.com/s-s8dcj5rpmy/images/stencil/original/products/1241/14153/tofa-spices-herbs-booklet-samp-9__59541.1694805706.jpg"
},
{
"caption": "",
"isDefault": false,
"url": "https://cdn11.bigcommerce.com/s-s8dcj5rpmy/images/stencil/original/products/1241/14155/tofa-spices-herbs-booklet-samp-17__14386.1694805765.jpg"
},
{
"caption": "",
"isDefault": false,
"url": "https://cdn11.bigcommerce.com/s-s8dcj5rpmy/images/stencil/original/products/1241/14154/tofa-spices-herbs-booklet-samp-2__76001.1694805765.jpg"
},
{
"caption": "",
"isDefault": false,
"url": "https://cdn11.bigcommerce.com/s-s8dcj5rpmy/images/stencil/original/products/1241/1488/spices_herbs_book-3__26978.1694805765.jpg"
},
{
"caption": "",
"isDefault": false,
"url": "https://cdn11.bigcommerce.com/s-s8dcj5rpmy/images/stencil/original/products/1241/1490/spices_herbs_book-15__99785.1694805765.jpg"
},
{
"caption": "",
"isDefault": false,
"url": "https://cdn11.bigcommerce.com/s-s8dcj5rpmy/images/stencil/original/products/1241/1489/spices_herbs_book-10__98879.1694805765.jpg"
}
],
"inventory": {
"aggregated": null,
"hasVariantInventory": false,
"isInStock": true
},
"maxPurchaseQuantity": 1,
"minPurchaseQuantity": null,
"mpn": null,
"name": "Printable PDF - Guide to Spices & Herbs in the Kitchen",
"prices": {
"basePrice": {
"currencyCode": "USD",
"value": 3.95
},
"bulkPricing": [],
"mapPrice": null,
"price": {
"currencyCode": "USD",
"value": 3.95
},
"priceRange": {
"max": {
"currencyCode": "USD",
"value": 3.95
},
"min": {
"currencyCode": "USD",
"value": 3.95
}
},
"retailPrice": null,
"retailPriceRange": null,
"salePrice": null,
"saved": null
},
"productOptions": [],
"reviewSummary": {
"numberOfReviews": 2,
"summationOfRatings": 6
},
"reviews": [
{
"author": {
"name": "Kalibb"
},
"createdAt": {
"utc": "2024-10-08T12:15:30Z"
},
"id": 5395,
"rating": 5,
"text": "Great reference guide for the kitchen, or great gift for the up and coming kitchen wizard. ",
"title": "Decent Guide"
},
{
"author": {
"name": "Donna Hood"
},
"createdAt": {
"utc": "2025-03-03T15:13:57Z"
},
"id": 5598,
"rating": 1,
"text": "I never received the PDF to print. I’ve searched and searched. I would appreciate you sending the file again. ",
"title": "Printable PDF-Guide to Herbs and Spices in the Kitchen"
}
],
"sku": "07SPICDIG",
"type": "Digital",
"upc": null,
"url": "https://store.almanac.com/guide-spices-herbs-kitchen/",
"variants": [
{
"gtin": null,
"id": 1218,
"inventory": {
"aggregated": null,
"isInStock": true
},
"isPurchasable": true,
"mpn": null,
"options": [],
"sku": "07SPICDIG",
"upc": null
}
],
"videos": [],
"warranty": "",
"weight": null,
"width": null
}
```
### ✏️ Support
⚡️ Feel free to [reach out](https://console.apify.com/actors/W5iZrLPhvkkVSIGc1/issues) to the developer for any [issues](https://console.apify.com/actors/W5iZrLPhvkkVSIGc1/issues) or suggestions for improvement.
# Actor input Schema
## `query` (type: `array`):
💡 Homepage URLs
## `limit` (type: `integer`):
💡 Number of results
## `filters.search` (type: `string`):
💡 Searches against several fields on the product including Name, SKU, and Description
## `filters.sort` (type: `string`):
No description
## `filters.brand_id` (type: `string`):
💡 Brand ID must be digits
## `filters.category_id` (type: `string`):
💡 Category ID must be digits
## `filters.min_rating` (type: `integer`):
No description
## `filters.max_rating` (type: `integer`):
No description
## `filters.featured` (type: `boolean`):
No description
## `filters.in_stock` (type: `boolean`):
No description
## `filters.free_ship` (type: `boolean`):
No description
## `dev_proxy_config` (type: `object`):
💡 Supported protocol:
HTTP(S), SOCKS5
{http|socks5}://{user:pass}@{hostname|ip-address}:port
Example: socks5://example.com:9000
## `dev_custom_headers` (type: `array`):
💡 Additional HTTP Headers
## `dev_custom_cookies` (type: `array`):
💡 Additional HTTP Cookies
## `dev_transform_fields` (type: `array`):
💡 Transform the resulting output. Select only needed fields.
For nested object use DOT. For example: address.streetAddress
For nested array use NUMBER (index of array element starting from index=0). For example: images.0.url
## `dev_dataset_name` (type: `string`):
💡 Save results into custom named Dataset, use mask to customize dataset name
{ACTOR} = actor name
{DATE} = date (YYYYMMDD)
{TIME} = time (HHMMSS)
This masks can be used to autogenerate Dataset Name.
example: data-{DATE}
Depending on today date the dataset name will be: data-20230603
default: data-{ACTOR}-{DATE}-{TIME}
## `dev_dataset_clear` (type: `boolean`):
Clear Dataset before insert/update.
## `dev_no_strip` (type: `boolean`):
💡 Keep/Save empty values (NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)
## Actor input object example
```json
{
"query": [
"https://www.eightcig.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 '' with your token
const client = new ApifyClient({
token: '',
});
// Prepare Actor input
const input = {
"query": [
"https://www.eightcig.com/"
],
"limit": 5
};
// Run the Actor and wait for it to finish
const run = await client.actor("jupri/bigcommerce").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 '' with your token.
client = ApifyClient("")
# Prepare the Actor input
run_input = {
"query": ["https://www.eightcig.com/"],
"limit": 5,
}
# Run the Actor and wait for it to finish
run = client.actor("jupri/bigcommerce").call(run_input=run_input)
# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
print(item)
# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start
```
## CLI example
```bash
echo '{
"query": [
"https://www.eightcig.com/"
],
"limit": 5
}' |
apify call jupri/bigcommerce --silent --output-dataset
```
## MCP server setup
```json
{
"mcpServers": {
"apify": {
"type": "http",
"url": "https://mcp.apify.com/?tools=fetch-actor-details,jupri/bigcommerce"
}
}
}
```
The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer ` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).
## OpenAPI specification
Download the OpenAPI definition: https://api.apify.com/v2/actors/W5iZrLPhvkkVSIGc1/builds/ybWke4dfuIEg8hHz7/openapi.json