{
  "openapi": "3.0.1",
  "info": {
    "title": "Shopify Store Scraper — Products, Contacts & Installed Apps",
    "description": "Scrape Shopify stores for products, collections, reviews, merchant emails, social links and installed apps for lead generation. USD 5 per 1,000 products.",
    "version": "1.0",
    "x-build-id": "4A4stLpSIfei2LBRu"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/muhammadafzal~shopify-store-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-muhammadafzal-shopify-store-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/muhammadafzal~shopify-store-scraper/runs": {
      "post": {
        "operationId": "runs-sync-muhammadafzal-shopify-store-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/muhammadafzal~shopify-store-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-muhammadafzal-shopify-store-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": {
          "storeUrls": {
            "title": "Shopify Store URLs",
            "type": "array",
            "description": "The Shopify storefronts to scrape, for example https://www.allbirds.com. Product page URLs are reduced to the store homepage, and the same store given twice is scraped once. The Actor does not search for stores: bring your own list. Default scrapes Allbirds so health checks produce output.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "Store URL",
                  "description": "A Shopify store homepage or product URL, for example https://www.allbirds.com. The actor normalizes product paths to the store origin before scraping."
                }
              }
            },
            "default": [
              {
                "url": "https://www.allbirds.com"
              }
            ]
          },
          "maxProducts": {
            "title": "Max Products per Store",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Maximum products to extract from each Shopify store. Use 10 for quick tests, higher values for full catalog research. Default 100, max 10000. Applies per store, not across all stores.",
            "default": 100
          },
          "includeReviews": {
            "title": "Include Review Summaries & Sales Estimates",
            "type": "boolean",
            "description": "When enabled, fetches each product page and reads JSON-LD aggregate ratings. Adds rating, review_count, review_source, and estimated_monthly_sales fields to product records. Default true. Disable for faster catalog-only runs.",
            "default": true
          },
          "maxReviewsPerProduct": {
            "title": "Max Reviews per Product (individual)",
            "minimum": 0,
            "maximum": 500,
            "type": "integer",
            "description": "Use this when you need individual customer reviews as separate review records, for example 20 for sentiment analysis. Requires Include Review Summaries & Sales Estimates. Reads Judge.me and Yotpo widgets rendered in the product page plus JSON-LD reviews; reviews loaded later by JavaScript are not visible. Default 0 (off), max 500.",
            "default": 0
          },
          "scrapeCollections": {
            "title": "Scrape Collections",
            "type": "boolean",
            "description": "When enabled, extracts all store collections (categories) from /collections.json. Each collection is returned as a separate record with title, handle, description, product count, and image. Default false.",
            "default": false
          },
          "maxCollections": {
            "title": "Max Collections per Store",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Maximum collections to extract per store when scrapeCollections is enabled. Default 250, max 5000. Large stores may have thousands of collections.",
            "default": 250
          },
          "scrapeContactInfo": {
            "title": "Scrape Merchant Contact Info",
            "type": "boolean",
            "description": "Use this for B2B leads: reads the store homepage once and returns one contact record with email, phone, address and Facebook, Instagram, X, TikTok, YouTube and Pinterest links. Phone numbers without a tel: link are pattern matches and can be wrong. Charged once per store. Default false.",
            "default": false
          },
          "scrapeTechStack": {
            "title": "Detect Installed Apps & Tech Stack",
            "type": "boolean",
            "description": "Use this to see which apps a store runs: matches the homepage against 47 app script signatures (email, SMS, reviews, subscriptions, analytics, support and more) and returns one storeIntel record with apps by category and the theme ID when exposed. Charged once per store. Default false.",
            "default": false
          },
          "reviewConversionRate": {
            "title": "Review Conversion Rate",
            "minimum": 0.001,
            "maximum": 1,
            "type": "number",
            "description": "Estimated share of buyers who leave reviews, used to convert review counts into conservative monthly sales estimates. Example: 0.02 means 2% of buyers review. Default 0.02. This is an estimate, NOT verified revenue data.",
            "default": 0.02
          },
          "requestDelayMs": {
            "title": "Request Delay Milliseconds",
            "minimum": 0,
            "maximum": 10000,
            "type": "integer",
            "description": "Delay between successful HTTP requests. Use 0 for fastest runs or 500-2000 for gentler scraping on larger catalogs. Default 500, max 10000. This is NOT a timeout setting.",
            "default": 500
          },
          "maxRequestRetries": {
            "title": "Max Request Retries",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "Retry attempts for temporary HTTP, proxy, or network failures. Default 3, max 10. A 404 product catalog still produces no products rather than retrying forever. Does NOT bypass private stores or password walls.",
            "default": 3
          }
        }
      },
      "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}