{
  "openapi": "3.0.1",
  "info": {
    "title": "Shopify Products Scraper & Price Change Monitor",
    "description": "Scrape any Shopify store: products, prices, stock, ratings & customer review texts (Judge.me, Okendo, Yotpo, Junip, REVIEWS.io, Loox, Stamped) — or store tech stack. Monitor price drops & restocks. $1/1,000 rows.",
    "version": "1.0",
    "x-build-id": "KiLPskQGUREjlcbWg"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/signalscope-data~shopify-store-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-signalscope-data-shopify-store-monitor",
        "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/signalscope-data~shopify-store-monitor/runs": {
      "post": {
        "operationId": "runs-sync-signalscope-data-shopify-store-monitor",
        "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/signalscope-data~shopify-store-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-signalscope-data-shopify-store-monitor",
        "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",
        "required": [
          "stores"
        ],
        "properties": {
          "stores": {
            "title": "Shopify stores",
            "type": "array",
            "description": "Store URLs (e.g. https://www.allbirds.com), collection URLs (…/collections/sale — scrape only that collection) or individual product URLs (…/products/<handle> — track just those products). Mix freely.",
            "items": {
              "type": "string"
            }
          },
          "mode": {
            "title": "Mode",
            "enum": [
              "catalog",
              "changes"
            ],
            "type": "string",
            "description": "'changes' compares with the previous run and outputs only new products, removed products, price changes, restocks and sell-outs. The first run saves a baseline.",
            "default": "catalog"
          },
          "stateKey": {
            "title": "Monitor name",
            "type": "string",
            "description": "Used in monitor mode. Use a different name for each separate monitor/schedule.",
            "default": "default"
          },
          "outputLevel": {
            "title": "Catalog output level",
            "enum": [
              "product",
              "variant",
              "store",
              "reviews"
            ],
            "type": "string",
            "description": "Only for full catalog mode. \"store\" = one row per store for competitor research and lead lists: product/variant counts, price range and median, share on sale and average discount, sold-out share, new products in the last 30/90 days and launches per month, top vendors / product types / tags, newest products, Shopify theme and detected apps (Klaviyo, Recharge, Yotpo, Gorgias, Meta/TikTok pixels, BNPL... 60+ checked on the homepage). Add includeRatings for total reviews + most-reviewed products, includeInventory for total stock and inventory value. Charged as one store event per store. \"reviews\" = the product reviews themselves (rating, title, text, author display name, date, verified buyer, helpful votes, store reply, Yotpo fit/size answers) read from the store's public Judge.me, Okendo or Yotpo widget, newest first; charged per review. Combine with keywords / maxProductsPerStore to pick products and the review filters below.",
            "default": "product"
          },
          "includeDescription": {
            "title": "Include description",
            "type": "boolean",
            "description": "Add the product description as plain text.",
            "default": false
          },
          "includeInventory": {
            "title": "Include inventory & barcodes",
            "type": "boolean",
            "description": "Fetch each product's variant data to add barcode (GTIN/UPC/EAN), stock quantity per variant (inventoryQuantity, when the store makes it public — many do), totalInventory and inventoryPolicy. In changes mode this also reports 'inventory_change' events with estimatedUnitsSold and estimatedRevenue — a sales-velocity signal for competitor stores. Adds one request per product, so big stores take longer.",
            "default": false
          },
          "includeRatings": {
            "title": "Include product ratings & review counts",
            "type": "boolean",
            "description": "Add rating (average stars), reviewCount, ratingSource and (Okendo/Yotpo/Junip/Loox) ratingDistribution per product, read from the store's public review app: Okendo, Yotpo, Junip, REVIEWS.io, Stamped and Loox via their public widget APIs, Judge.me and others via the product page (Judge.me badge or schema.org rating). In changes mode this also reports 'new_reviews' events (reviewsAdded since last run, plus the newest review texts in newReviews for every app that supports review texts) — review velocity is a demand signal. Adds one request per product.",
            "default": false
          },
          "maxProductsPerStore": {
            "title": "Max products per store",
            "minimum": 0,
            "type": "integer",
            "description": "0 = all.",
            "default": 0
          },
          "keywords": {
            "title": "Keywords",
            "type": "array",
            "description": "Only include products whose title, vendor, product type or tags contain at least one of these words (case-insensitive), e.g. 'runner', 'merino'. Empty = all products.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "excludeKeywords": {
            "title": "Exclude keywords",
            "type": "array",
            "description": "Skip products whose title, vendor, product type or tags contain any of these words, e.g. 'gift card', 'sample'.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "minPrice": {
            "title": "Min price",
            "minimum": 0,
            "type": "integer",
            "description": "Only products with at least one variant priced at or above this (store currency). Leave empty for no limit."
          },
          "maxPrice": {
            "title": "Max price",
            "minimum": 0,
            "type": "integer",
            "description": "Only products with at least one variant priced at or below this (store currency). Leave empty for no limit."
          },
          "onlyOnSale": {
            "title": "Only products on sale",
            "type": "boolean",
            "description": "Catalog mode: output only products with a compare-at (crossed-out) price higher than the current price. See discountPercent in the output.",
            "default": false
          },
          "onlyAvailable": {
            "title": "Only in-stock products",
            "type": "boolean",
            "description": "Catalog mode: skip products where every variant is sold out.",
            "default": false
          },
          "minRating": {
            "title": "Min rating",
            "pattern": "^$|^[0-5](\\.[0-9]{1,2})?$",
            "type": "string",
            "description": "Catalog mode, needs 'Include product ratings': only products rated at least this many stars, e.g. 4.5. Leave empty for no limit."
          },
          "minReviewCount": {
            "title": "Min review count",
            "minimum": 0,
            "type": "integer",
            "description": "Catalog mode, needs 'Include product ratings': only products with at least this many reviews, e.g. 100 = proven best sellers. Leave empty for no limit."
          },
          "maxReviewsPerProduct": {
            "title": "Max reviews per product",
            "minimum": 0,
            "maximum": 5000,
            "type": "integer",
            "description": "For outputLevel \"reviews\": newest reviews to output per product (0 = all, up to ~1,000 per product). Stores that pool reviews across product variants (common with Okendo and Judge.me) show the same review on several products only once.",
            "default": 20
          },
          "reviewMinRating": {
            "title": "Review min stars",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "For outputLevel \"reviews\": only reviews with at least this many stars. Leave empty for all."
          },
          "reviewMaxRating": {
            "title": "Review max stars",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "For outputLevel \"reviews\": only reviews with at most this many stars, e.g. 2 = complaints only (competitor weaknesses, product defects). Leave empty for all."
          },
          "reviewsSince": {
            "title": "Reviews since date",
            "type": "string",
            "description": "For outputLevel \"reviews\": only reviews written on or after this date, e.g. 2026-09-01. Paging stops at older reviews, so this also makes runs faster."
          },
          "changeTypes": {
            "title": "Change types to report",
            "type": "array",
            "description": "Changes mode: report only these change types (e.g. just price drops and restocks). Empty = all types. You only pay for reported changes.",
            "items": {
              "type": "string",
              "enum": [
                "new_product",
                "removed_product",
                "new_variant",
                "price_drop",
                "price_increase",
                "back_in_stock",
                "out_of_stock",
                "inventory_change",
                "new_reviews"
              ],
              "enumTitles": [
                "New product",
                "Removed product",
                "New variant",
                "Price drop",
                "Price increase",
                "Back in stock",
                "Out of stock",
                "Inventory change (needs Include inventory)",
                "New reviews (needs Include ratings)"
              ]
            },
            "default": []
          },
          "minChangePercent": {
            "title": "Min price change %",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Changes mode: ignore price drops/increases smaller than this percentage, e.g. 10 = only report changes of 10% or more.",
            "default": 0
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}