{
  "openapi": "3.0.1",
  "info": {
    "title": "Shopify Products Scraper - Variants, Stock & Store Leads",
    "description": "Shopify products scraper: export prices, variants, SKUs, stock and inventory to CSV/JSON. Store mode: one lead row per store (theme, installed apps, socials); filter by app, theme, email/phone or catalog size (filtered free). $0.70 per 1,000 products; non-Shopify, blocked or filtered results free.",
    "version": "0.1",
    "x-build-id": "DummtR1bH5w2sft46"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tinyrex~shopify-products-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tinyrex-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/tinyrex~shopify-products-scraper/runs": {
      "post": {
        "operationId": "runs-sync-tinyrex-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/tinyrex~shopify-products-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-tinyrex-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",
        "properties": {
          "stores": {
            "title": "Shopify stores, collections or products",
            "type": "array",
            "description": "Store domains (allbirds.com), store URLs, collection URLs (https://store.com/collections/sale) or product URLs (https://store.com/products/handle). Headless stores are supported when their *.myshopify.com domain can be found. Inputs that are not Shopify stores are skipped and not charged.",
            "default": [
              "deathwishcoffee.com"
            ],
            "items": {
              "type": "string"
            }
          },
          "maxProductsPerStore": {
            "title": "Max products per store",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of products to save per input (after filters). 0 = all products.",
            "default": 50
          },
          "outputMode": {
            "title": "Output: one row per",
            "enum": [
              "products",
              "variants",
              "stores"
            ],
            "type": "string",
            "description": "Product: one row per product with a nested variants list. Variant: one flat row per variant (size/color), easiest for spreadsheets and price tracking. One charge per row. Store: one store-leads row per store (catalog size, price range, discounts, stock, top vendors/types/tags, new products in 30 days, social profiles, public emails/phones from the homepage), scans the whole catalog (up to 25,000 products) and ignores Max products and Monitoring; each store row costs the same as 5 product rows.",
            "default": "products"
          },
          "keywords": {
            "title": "Keywords",
            "type": "array",
            "description": "Keep only products whose title, vendor, product type or tags contain any of these words (case-insensitive).",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "excludeKeywords": {
            "title": "Exclude keywords",
            "type": "array",
            "description": "Drop products whose title or tags contain any of these words.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "vendors": {
            "title": "Vendors / brands",
            "type": "array",
            "description": "Keep only products from these vendors (partial match).",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "productTypes": {
            "title": "Product types",
            "type": "array",
            "description": "Keep only these product types (partial match), e.g. Shoes, Coffee.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "minPrice": {
            "title": "Min price",
            "minimum": 0,
            "type": "integer",
            "description": "Lowest variant price must be at least this (store currency). Leave empty for no limit."
          },
          "maxPrice": {
            "title": "Max price",
            "minimum": 0,
            "type": "integer",
            "description": "Lowest variant price must be at most this (store currency). Leave empty for no limit."
          },
          "onlyAvailable": {
            "title": "Only in stock",
            "type": "boolean",
            "description": "Keep only products with at least one variant available for sale.",
            "default": false
          },
          "onlyOnSale": {
            "title": "Only on sale",
            "type": "boolean",
            "description": "Keep only products with a compare-at price higher than the price (discounted).",
            "default": false
          },
          "minDiscountPercent": {
            "title": "Min discount %",
            "minimum": 0,
            "maximum": 99,
            "type": "integer",
            "description": "Keep only products whose discount (compare-at vs price) is at least this percent. 0 = off. Products below the cut are free.",
            "default": 0
          },
          "publishedWithinDays": {
            "title": "Published within (days)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep only products published in the last N days. 0 = any time.",
            "default": 0
          },
          "onlyIfUsesApps": {
            "title": "Only stores using these apps",
            "type": "array",
            "description": "Store mode only. Keep only stores where at least one of these apps or app categories is detected on the homepage, e.g. Klaviyo, Recharge, Judge.me, or a category: email-sms, reviews, subscriptions, loyalty, upsell, search, wishlist, support, page-builder, payments, shipping-returns, translation, analytics, affiliate. Partial, case-insensitive match. Non-matching stores are skipped before the catalog scan and are free.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "excludeIfUsesApps": {
            "title": "Skip stores using these apps",
            "type": "array",
            "description": "Store mode only. Skip stores where any of these apps or categories is detected, e.g. Klaviyo to find stores without an email tool (prospects for an email agency). Skipped stores are free.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "onlyIfThemes": {
            "title": "Only stores on these themes",
            "type": "array",
            "description": "Store mode only. Keep only stores whose Shopify theme name or base theme matches, e.g. Dawn, Prestige, Impulse. Partial, case-insensitive match. Headless stores have no theme and are skipped (free).",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "onlyWithEmail": {
            "title": "Only stores with a homepage email",
            "type": "boolean",
            "description": "Store mode only. Keep only stores that link at least one mailto: email on the homepage. Checked after the homepage fetch and before the catalog scan. Filtered stores are free.",
            "default": false
          },
          "onlyWithPhone": {
            "title": "Only stores with a homepage phone",
            "type": "boolean",
            "description": "Store mode only. Keep only stores that link at least one tel: phone on the homepage. Checked after the homepage fetch and before the catalog scan. Filtered stores are free.",
            "default": false
          },
          "minCatalogSize": {
            "title": "Min catalog size",
            "minimum": 0,
            "type": "integer",
            "description": "Store mode only. Keep only stores with at least this many published products. Uses the store meta count when available (before the catalog scan); otherwise checks products found after the scan and skips the charge. Filtered stores are free. Leave empty for no minimum."
          },
          "maxCatalogSize": {
            "title": "Max catalog size",
            "minimum": 0,
            "type": "integer",
            "description": "Store mode only. Keep only stores with at most this many published products. Uses the store meta count when available (before the catalog scan); otherwise checks products found after the scan and skips the charge. Filtered stores are free. Leave empty for no maximum."
          },
          "convertPricesTo": {
            "title": "Convert prices to currency",
            "enum": [
              "",
              "USD",
              "EUR",
              "GBP",
              "CAD",
              "AUD",
              "NZD",
              "CHF",
              "SEK",
              "NOK",
              "DKK",
              "PLN",
              "CZK",
              "JPY",
              "INR",
              "SGD",
              "HKD",
              "MXN",
              "BRL",
              "ZAR"
            ],
            "type": "string",
            "description": "Adds converted price fields (priceConverted, compareAtPriceConverted, and in Store mode min/median/avg/maxPriceConverted) plus exchangeRate, using the daily European Central Bank reference rates. Handy to compare stores that sell in different currencies. Original prices are kept. Leave empty for no conversion. No extra charge.",
            "default": ""
          },
          "descriptionFormat": {
            "title": "Description",
            "enum": [
              "text",
              "html",
              "both",
              "none"
            ],
            "type": "string",
            "description": "Product description as plain text, HTML, both, or none (smaller output).",
            "default": "text"
          },
          "includeInventory": {
            "title": "Add stock quantity and barcode (extra charge)",
            "type": "boolean",
            "description": "Fetches each product page feed to add inventory quantity, inventory policy and barcode per variant, when the store exposes them. Slower (one extra request per product). Charged per product where stock data was found.",
            "default": false
          },
          "monitorMode": {
            "title": "Monitoring mode",
            "enum": [
              "off",
              "new",
              "changes"
            ],
            "type": "string",
            "description": "Off: return all matching products. New: only products not seen in previous runs. Changes: new products plus price, compare-at price or availability changes (with previous values). State is kept per store under the state key. The first monitoring run returns everything as the baseline.",
            "default": "off"
          },
          "stateKey": {
            "title": "State key",
            "type": "string",
            "description": "Name of the monitoring state. Use different keys for different schedules or filters.",
            "default": "default"
          },
          "maxConcurrency": {
            "title": "Stores in parallel",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "How many stores are processed at the same time. Keep this low (2 is the default) so stores are less likely to return HTTP 429. Pages of one store are fetched one after another.",
            "default": 2
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Optional. Some Shopify stores block data-center IPs (HTTP 403/429), including Apify Proxy datacenter. A residential proxy may work but costs extra. Blocked stores are free.",
            "default": {
              "useApifyProxy": false
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}