# Magento E-Commerce Scraper 🚧 (`jupri/magento-scraper`) Actor Scrape data about product price, description and other information from Magento E-Commerce websites. - **URL**: https://apify.com/jupri/magento-scraper.md - **Developed by:** [cat](https://apify.com/jupri) (community) - **Categories:** E-commerce - **Stats:** 471 total users, 3 monthly users, 84.2% runs succeeded, 6 bookmarks - **User rating**: No ratings yet ## Pricing $30.00/month + usage To use this Actor, you pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month after the free trial period.You also pay for the Apify platform usage, which gets cheaper the higher Apify subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#rental-actors ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. 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. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use 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 Magento Scraper ![dont be sad readme is here](https://raw.githubusercontent.com/JupriGH/resources/main/cats/catframe.png) #### About Magento **Magento** is an [open-source](https://en.wikipedia.org/wiki/Open-source_software "Open-source software") [e-commerce platform](https://en.wikipedia.org/wiki/E-commerce "E-commerce") written in [PHP](https://en.wikipedia.org/wiki/PHP "PHP"). It uses multiple other PHP frameworks such as [Laminas](https://en.wikipedia.org/wiki/Laminas "Laminas") (formerly known as [Zend Framework](https://en.wikipedia.org/wiki/Zend_Framework "Zend Framework")) and [Symfony](https://en.wikipedia.org/wiki/Symfony "Symfony"). Magento [source code](https://en.wikipedia.org/wiki/Source_code "Source code") is distributed under [Open Software License (OSL)](https://en.wikipedia.org/wiki/Open_Software_License "Open Software License") v3.0. Magento was acquired by [Adobe Inc](https://en.wikipedia.org/wiki/Adobe_Inc "Adobe Inc") in May 2018 for $1.68 billion.[[2]](https://en.wikipedia.org/wiki/Magento#cite_note-2) #### About This Actor Use this actor to extract product price, description, variants and other info from a Magento E-Commerce website. Example of websites can be found [here](https://trends.builtwith.com/websitelist/Magento). #### Disclaimer This Actor is using generic logic to scrape a Magento website. It may not work for all website. Please contact support to submit an issue. #### Tutorial ***Example #1: Basic Usage*** ```json { "url": "www.rebook.id" } ```` #### Output Samples ```json { "created_at": "2023-05-12 02:05:42", "description": "

Ideal for the summer-season, this short-sleeve shirt features a seasonal 'Overlapping Check' print in muted tones.

\n", "id": 286995, "image": { "big": { "url": "https://media.paulsmith.com/dam/products/w_auto,c_scale/q_80/STILL/M1R/M1R-905U-L02056-92/M1R-905U-L02056-92_10.jpg" }, "small": { "url": "https://media.paulsmith.com/dam/products/w_auto,c_scale/q_80/STILL/M1R/M1R-905U-L02056-92/M1R-905U-L02056-92_10.jpg" }, "thumb": { "url": "https://media.paulsmith.com/dam/products/w_auto,c_scale/q_80/STILL/M1R/M1R-905U-L02056-92/M1R-905U-L02056-92_10.jpg" } }, "name": "Viscose 'Overlapping Check' Print Shirt", "overview": "This short-sleeve shirt features a seasonal 'Overlapping Check' print in muted tones. Order today with FREE shipping offers available.", "price": { "max": { "discount": { "amount": 0, "percent": 0 }, "final": { "currency": "GBP", "value": 325 }, "regular": { "currency": "GBP", "value": 325 } }, "min": { "discount": { "amount": 0, "percent": 0 }, "final": { "currency": "GBP", "value": 325 }, "regular": { "currency": "GBP", "value": 0 } } }, "sku": "M1R-905U-L02056-92", "status": "OUT_OF_STOCK", "type": "configurable", "updated_at": "2023-05-24 13:28:33", "url": "https://www.paulsmith.com/viscose-overlapping-check-print-shirt", "variants": [ { "attributes": [ { "code": "size", "label": "L", "value_index": 346 } ], "product": { "id": 286991, "name": "MENS S/S REGULAR FIT SHIRT", "sku": "M1R-905U-L02056-92-L" } }, { "attributes": [ { "code": "size", "label": "M", "value_index": 347 } ], "product": { "id": 286992, "name": "MENS S/S REGULAR FIT SHIRT", "sku": "M1R-905U-L02056-92-M" } }, { "attributes": [ { "code": "size", "label": "S", "value_index": 348 } ], "product": { "id": 286993, "name": "MENS S/S REGULAR FIT SHIRT", "sku": "M1R-905U-L02056-92-S" } }, { "attributes": [ { "code": "size", "label": "XL", "value_index": 349 } ], "product": { "id": 286994, "name": "MENS S/S REGULAR FIT SHIRT", "sku": "M1R-905U-L02056-92-XL" } } ] } ``` # Actor input Schema ## `url` (type: `string`): No description ## `search` (type: `string`): Search by Keywords ## `limit` (type: `integer`): Limit number of results. ## `show_filters` (type: `boolean`): Show available filters & sorting Keys (in console). ## `sort` (type: `string`): Every website could have different Sorting Key. Use show\_filters=true to show available options. Most common values is: name, price ## `order` (type: `string`): Sorting Order ## `includes:description` (type: `boolean`): Long description (HTML). ## `includes:gallery` (type: `boolean`): No description ## `includes:related` (type: `boolean`): No description ## `includes:variants` (type: `boolean`): No description ## `includes:upsell` (type: `boolean`): Upselling is the process of encouraging customers to upgrade or include add-ons to the product or service they're buying. ## `includes:crosssell` (type: `boolean`): Cross-selling is the process of offering a customer products that are compatible with the ones they're purchasing. ## `deprecated` (type: `boolean`): No description ## `filters:sku` (type: `string`): No description ## `filters:name` (type: `string`): No description ## `filters:description` (type: `string`): No description ## `min_price` (type: `integer`): Minimum price ## `max_price` (type: `integer`): Maximum price ## `other_filters` (type: `array`): Use show\_filters=true to show all available options. ## `dev_proxy_config` (type: `object`): Supported protocol:

HTTP(S), SOCKS5
{http|socks5}://{user:pass}@{hostname|ip-address}:port

\ScrapeOps.IO
scrapeops://{api-key}

Example: socks5://example.com:9000 ## `dev_custom_headers` (type: `array`): 💡 Additional HTTP Headers ## `dev_custom_cookies` (type: `array`): 💡 Additional HTTP Cookies ## `dev_no_strip` (type: `boolean`): 💡 Keep/Save empty values (NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING) ## `dev_transform_enable` (type: `boolean`): No description ## `dev_transform_fields` (type: `array`): No description ## `dev_dataset_enable` (type: `boolean`): No description ## `dev_dataset_clear` (type: `boolean`): Clear Dataset before insert/update. ## `dev_dataset_name` (type: `string`): 💡 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} ## Actor input object example ```json { "url": "https://www.reebok.id", "limit": 5, "includes:variants": true } ``` # 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 = { "url": "https://www.reebok.id", "limit": 5 }; // Run the Actor and wait for it to finish const run = await client.actor("jupri/magento-scraper").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 = { "url": "https://www.reebok.id", "limit": 5, } # Run the Actor and wait for it to finish run = client.actor("jupri/magento-scraper").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://www.reebok.id", "limit": 5 }' | apify call jupri/magento-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=jupri/magento-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Magento E-Commerce Scraper 🚧", "description": "Scrape data about product price, description and other information from Magento E-Commerce websites.", "version": "0.1", "x-build-id": "LDPpAwCn9rvaQGDla" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jupri~magento-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jupri-magento-scraper", "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~magento-scraper/runs": { "post": { "operationId": "runs-sync-jupri-magento-scraper", "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~magento-scraper/run-sync": { "post": { "operationId": "run-sync-jupri-magento-scraper", "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": "🛒 Homepage", "type": "string", "description": "" }, "search": { "title": "🛒 Search", "type": "string", "description": "Search by Keywords" }, "limit": { "title": "🛒 Limit", "type": "integer", "description": "Limit number of results." }, "show_filters": { "title": "Show filters", "type": "boolean", "description": "Show available filters & sorting Keys (in console)." }, "sort": { "title": "Sorting Key", "type": "string", "description": "Every website could have different Sorting Key. Use show_filters=true to show available options. Most common values is: name, price" }, "order": { "title": "Order", "enum": [ "asc", "desc" ], "type": "string", "description": "Sorting Order" }, "includes:description": { "title": "Description", "type": "boolean", "description": "Long description (HTML)." }, "includes:gallery": { "title": "Media Gallery", "type": "boolean", "description": "" }, "includes:related": { "title": "Related Products", "type": "boolean", "description": "" }, "includes:variants": { "title": "Variants", "type": "boolean", "description": "", "default": true }, "includes:upsell": { "title": "Up-Sell Products", "type": "boolean", "description": "Upselling is the process of encouraging customers to upgrade or include add-ons to the product or service they're buying." }, "includes:crosssell": { "title": "Cross-Sell Products", "type": "boolean", "description": "Cross-selling is the process of offering a customer products that are compatible with the ones they're purchasing." }, "deprecated": { "title": "Include deprecated fields", "type": "boolean", "description": "" }, "filters:sku": { "title": "SKU", "type": "string", "description": "" }, "filters:name": { "title": "Name", "type": "string", "description": "" }, "filters:description": { "title": "Description", "type": "string", "description": "" }, "min_price": { "title": "Price", "type": "integer", "description": "Minimum price" }, "max_price": { "title": "", "type": "integer", "description": "Maximum price" }, "other_filters": { "title": "More Filters", "type": "array", "description": "Use show_filters=true to show all available options.", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "dev_proxy_config": { "title": "🌐 PROXY NETWORKING", "type": "object", "description": "Supported protocol:

HTTP(S), SOCKS5
{http|socks5}://{user:pass}@{hostname|ip-address}:port

ScrapeOps.IO
scrapeops://{api-key}

Example: socks5://example.com:9000" }, "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_no_strip": { "title": "Disable data cleansing", "type": "boolean", "description": "💡 Keep/Save empty values (NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)" }, "dev_transform_enable": { "title": "Enable Custom Fields", "type": "boolean", "description": "" }, "dev_transform_fields": { "title": "Fields List", "type": "array", "description": "", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "dev_dataset_enable": { "title": "Enable Custom Storage", "type": "boolean", "description": "" }, "dev_dataset_clear": { "title": "Clear Storage", "type": "boolean", "description": "Clear Dataset before insert/update." }, "dev_dataset_name": { "title": "Dataset Name", "type": "string", "description": "💡 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}" } } }, "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 } } } } } } } } } } ```