{
  "openapi": "3.0.1",
  "info": {
    "title": "Shopify Products Scraper & Price Monitor + WooCommerce",
    "description": "Every product of any Shopify or WooCommerce store: prices, sale prices, stock, variants, SKUs, images. Price & stock change alerts (new, removed, cheaper, back in stock). Whole catalogs, collections, many stores per run. $0.60 per 1,000. No login, no proxy setup.",
    "version": "0.1",
    "x-build-id": "iApSglk5ACHndefdj"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/nat-labs~shopify-products-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-nat-labs-shopify-products-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/nat-labs~shopify-products-scraper/runs": {
      "post": {
        "operationId": "runs-sync-nat-labs-shopify-products-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/nat-labs~shopify-products-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-nat-labs-shopify-products-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",
        "required": [
          "startUrls"
        ],
        "properties": {
          "startUrls": {
            "title": "Store, collection or product URLs",
            "type": "array",
            "description": "One per line (a bare domain like <code>allbirds.com</code> is fine). A store home page (<code>https://allbirds.com</code> or just <code>allbirds.com</code>) gets the whole catalog; a collection (<code>…/collections/sale</code>) or WooCommerce category (<code>…/product-category/bottles/</code>) gets only those products; a product URL gets one product. Market paths such as <code>/en-gb</code> return that market's prices. The platform (Shopify, WooCommerce, or any store with schema.org product data) is detected for you.",
            "items": {
              "type": "string"
            }
          },
          "maxProductsPerStore": {
            "title": "Max products per URL",
            "minimum": 0,
            "type": "integer",
            "description": "Stop each store, collection or category after this many products (after filters). 0 = the whole catalog. The form starts at 100 so a first try stays cheap; API calls without this field get 1000.",
            "default": 1000
          },
          "outputMode": {
            "title": "Output",
            "enum": [
              "products",
              "variants"
            ],
            "type": "string",
            "description": "<code>products</code>: one row per product with a <code>variants</code> list (sizes, colours, SKUs, prices, stock). <code>variants</code>: one flat row per variant, ready for Excel and Google Sheets (each row is charged as one product).",
            "default": "products"
          },
          "includeDescription": {
            "title": "Include description",
            "type": "boolean",
            "description": "Product description as plain text (HTML removed). Turn off for smaller datasets.",
            "default": true
          },
          "includeStoreSummary": {
            "title": "Add a store summary row",
            "type": "boolean",
            "description": "One <code>type: store-summary</code> row per URL: catalog size, price quartiles, % on sale, % in stock, top vendors, product types and tags, newest launches. Charged as one <b>store summary</b>.",
            "default": false
          },
          "keywords": {
            "title": "Keywords (any of)",
            "type": "array",
            "description": "Keep products whose title, tags, vendor, product type or category contains any of these words, e.g. <code>hoodie</code>, <code>organic</code>.",
            "items": {
              "type": "string"
            }
          },
          "excludeKeywords": {
            "title": "Exclude keywords",
            "type": "array",
            "description": "Drop products whose title, tags, vendor, product type or category contains any of these words.",
            "items": {
              "type": "string"
            }
          },
          "vendors": {
            "title": "Vendors / brands",
            "type": "array",
            "description": "Keep only these vendors (exact name, case-insensitive). Useful for multi-brand retailers.",
            "items": {
              "type": "string"
            }
          },
          "productTypes": {
            "title": "Product types / categories",
            "type": "array",
            "description": "Keep only these product types (Shopify) or categories (WooCommerce), exact name, case-insensitive.",
            "items": {
              "type": "string"
            }
          },
          "minPrice": {
            "title": "Min price",
            "minimum": 0,
            "type": "integer",
            "description": "Keep products with at least one variant at or above this price (store currency)."
          },
          "maxPrice": {
            "title": "Max price",
            "minimum": 0,
            "type": "integer",
            "description": "Keep products with at least one variant at or below this price (store currency)."
          },
          "onlyAvailable": {
            "title": "Only in stock",
            "type": "boolean",
            "description": "Keep only products with at least one variant available to buy.",
            "default": false
          },
          "onlyOnSale": {
            "title": "Only on sale",
            "type": "boolean",
            "description": "Keep only products with a compare-at (was) price above the current price.",
            "default": false
          },
          "updatedSince": {
            "title": "Updated within / since",
            "type": "string",
            "description": "Shopify only: products updated in this window (<code>24h</code>, <code>7d</code>, <code>2w</code>, <code>1m</code>) or since a date (<code>2026-10-01</code>)."
          },
          "publishedSince": {
            "title": "Published within / since",
            "type": "string",
            "description": "Shopify only: new launches published in this window (<code>7d</code>) or since a date."
          },
          "onlyChanges": {
            "title": "Only changes since my last run (price & stock monitor)",
            "type": "boolean",
            "description": "For scheduled runs: compare each store with the previous run of the same <b>Monitor name</b> and deliver one <code>type: change</code> row per product that is <b>new, removed, cheaper, dearer, back in stock or sold out</b> (with old/new price and variant-level details). Unchanged products are not delivered. Each product compared costs a tiny <b>product checked</b> fee; each change row is one <b>change</b>.",
            "default": false
          },
          "monitorName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Separate memory per schedule, e.g. <code>competitors-daily</code>. Runs with the same name compare against each other.",
            "default": "default"
          },
          "baselineMode": {
            "title": "First monitoring run",
            "enum": [
              "deliver",
              "silent"
            ],
            "type": "string",
            "description": "<code>deliver</code>: the first run returns every product (charged as products) and records them. <code>silent</code>: the first run only records the catalog (charged as products checked) and later runs deliver changes.",
            "default": "deliver"
          },
          "priceChangeMinPercent": {
            "title": "Min price change to report (%)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Ignore price moves smaller than this percentage. 0 = report every change.",
            "default": 0
          },
          "includeRemoved": {
            "title": "Report removed products",
            "type": "boolean",
            "description": "Add a <code>changeType: removed</code> row when a product disappears from the catalog. Only reported when the whole catalog was read (Max products per URL = 0 or large enough).",
            "default": true
          },
          "includeStockChanges": {
            "title": "Report stock changes",
            "type": "boolean",
            "description": "Report <code>back_in_stock</code> and <code>out_of_stock</code> (product and variant level).",
            "default": true
          },
          "platform": {
            "title": "Platform",
            "enum": [
              "auto",
              "shopify",
              "woocommerce",
              "jsonld"
            ],
            "type": "string",
            "description": "Leave on <b>auto</b>. Force a platform only if detection picks the wrong one.",
            "default": "auto"
          },
          "maxItems": {
            "title": "Max rows in total",
            "minimum": 0,
            "type": "integer",
            "description": "Stop after this many product / variant / change rows across all URLs. 0 = no limit. The run also stops cleanly at your run's maximum cost.",
            "default": 0
          },
          "maxConcurrency": {
            "title": "URLs in parallel",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "How many URLs are processed at once. Requests to one store are always paced (about 2 per second, or the store's robots.txt Crawl-delay).",
            "default": 5
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Default: Apify Proxy (shared datacenter IPs, included in the price). Shopify throttles single IPs across all its stores, so keep it on for reliable runs; turn it off only for a few small stores.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}