Shopify Product Search Scraper Actor Documentation

Overview

The Shopify Product Search Scraper enables users to search for products within Shopify stores by providing a search query. This actor retrieves targeted product data based on your input, including details such as product titles, descriptions, and metadata, making it a perfect tool for focused product research and analysis.

---

Features

• Search by Query: Easily filter products in a store using a specific keyword or phrase.
• Limit Results: Specify the maximum number of products to retrieve.
• Detailed Metadata: Fetch creation dates, vendor information, tags, and more.
• Targeted Output: Get only the most relevant products matching your query.

---

Use Cases

• Targeted Research: Find products in a specific category or matching a keyword.
• Content Aggregation: Build curated lists of products for reviews or blogs.
• Price Tracking: Monitor the prices of specific items over time.
• Market Analysis: Understand trends and customer preferences for specific product types.

---

Input Parameters

The actor accepts the following input parameters:

Parameter Name	Type	Description
url	String	The URL of the Shopify store to search. Example: https://www.tentree.com/.
query	String	The search term to filter products by. Example: "hoodie".
limit	Number	The maximum number of products to retrieve. Default is 10.

Example Input

1const { 
2  url = 'https://www.tentree.com/', 
3  query = 'hoodie', 
4  limit = 150 
5} = input;

---

Output

The actor returns a JSON object containing an array of products matching the search query.

Example Output

1{
2  "products": [
3    {
4      "id": 7165565731002,
5      "title": "Highline Drop Shoulder Sweater",
6      "handle": "womens-highline-drop-shoulder-crew-urban-green",
7      "url": "https://www.tentree.com/products/womens-highline-drop-shoulder-crew-urban-green",
8      "body_html": "<p>The next most sustainable option after having your grandma knit you a sweater. This sustainably made crewneck is great for chilly spring walks or nights at the cabin.</p>",
9      "published_at": "2024-11-18T09:35:24-08:00",
10      "created_at": "2022-08-10T17:14:16-07:00",
11      "updated_at": "2024-11-21T04:42:18-08:00",
12      "vendor": "tentree",
13      "product_type": "Womens",
14      "tags": [/* Array of tags */],
15      "variants": [/* Array of variants */],
16      "images": [/* Array of image URLs */],
17      "options": [/* Array of options */]
18    },
19    {
20      "id": 7133073178810,
21      "title": "Destination Latitude Short Light",
22      "handle": "mens-destination-latitude-shorts-light",
23      "url": "https://www.tentree.com/products/mens-destination-latitude-shorts-light",
24      "body_html": "<p>These lightweight, everyday shorts are made from recycled polyester for a light, comfortable, stretchy fit that’s kind to the planet.</p>",
25      "published_at": "2024-10-23T09:40:42-07:00",
26      "created_at": "2022-07-12T21:21:21-07:00",
27      "updated_at": "2024-11-21T04:42:18-08:00",
28      "vendor": "tentree",
29      "product_type": "Mens",
30      "tags": [/* Array of tags */],
31      "variants": [/* Array of variants */],
32      "images": [/* Array of image URLs */],
33      "options": [/* Array of options */]
34    }
35  ]
36}

Key Fields

• id: Unique identifier for the product.
• title: Name of the product.
• handle: Shopify handle for the product.
• url: URL of the product page.
• body_html: HTML description of the product.
• published_at: Date and time when the product was published.
• created_at: Date and time when the product was created.
• updated_at: Last update date and time.
• vendor: Name of the vendor or store.
• product_type: Category of the product.
• tags: Tags associated with the product.
• variants: Array of product variants (e.g., sizes, colors).
• images: Array of product image URLs.
• options: Product options (e.g., size, color).

---

How to Use

1. Set Up Input: Provide the url of the Shopify store, a query string, and a limit value for results.
2. Run the Actor: Execute the actor with your specified parameters.
3. Analyze Results: Use the returned JSON to extract product details matching your search query.

---

FAQs

1. Q: Can I search for multiple queries at once?
   A: Currently, the actor supports one query per run. You can loop through multiple queries programmatically.

2. Q: Does this actor return pricing details?
   A: Yes, if the product variants include pricing information.

3. Q: Is there a default limit on the number of products retrieved?
   A: The default limit is 10, but you can customize it by setting the limit parameter.

4. Q: Can I use this actor for non-Shopify stores?
   A: No, this actor is designed specifically for Shopify-based stores.

5. Q: Does the actor include unpublished or hidden products?
   A: No, it retrieves only publicly accessible products.

6. Q: How are product images returned?
   A: Images are provided as an array of URLs, which can be used directly in your application.

7. Q: Can I filter products by category?
   A: While this actor doesn’t support category filtering directly, you can use specific keywords in the query to approximate category-based results.

8. Q: Is there a free trial for this actor?
   A: Yes, a 2-hour free trial is included to test its capabilities.

---

SEO Benefits

• Enhanced Product Pages: Enrich your website with detailed product information.
• Targeted Content: Attract more visitors by focusing on high-demand queries.
• Competitive Analysis: Keep tabs on competitor products and pricing.

---

Simplify your Shopify product searches with the Shopify Product Search Scraper today! 🚀