{
"openapi": "3.0.1",
"info": {
"title": "Shopify Products Scraper: Prices, Variants & Stock",
"description": "Scrape every product from any Shopify store: prices, sale prices, variants, SKUs, stock, images, tags and vendor, via the public products.json feed. Whole store or one collection. Tracks price and stock changes between runs. Fast, no browser, no login.",
"version": "1.0",
"x-build-id": "4XF3cqJY3b9zC8tZy"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/lanternlane-data~shopify-store-products-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-lanternlane-data-shopify-store-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/lanternlane-data~shopify-store-products-scraper/runs": {
"post": {
"operationId": "runs-sync-lanternlane-data-shopify-store-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/lanternlane-data~shopify-store-products-scraper/run-sync": {
"post": {
"operationId": "run-sync-lanternlane-data-shopify-store-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": [
"storeUrls"
],
"properties": {
"storeUrls": {
"title": "Shopify store URLs",
"type": "array",
"description": "Store domains or URLs, one per line: allbirds.com, https://colourpop.com. Add a collection URL (https://colourpop.com/collections/lips) to get only that collection.",
"items": {
"type": "string"
}
},
"outputLevel": {
"title": "One row per",
"enum": [
"product",
"variant"
],
"type": "string",
"description": "Product: one record per product with a nested variants list. Variant: one flat record per variant (SKU), ideal for CSV/Sheets and price monitoring.",
"default": "product"
},
"keywords": {
"title": "Keywords (any match)",
"type": "array",
"description": "Keep products whose title, product type, vendor or tags contain one of these.",
"items": {
"type": "string"
}
},
"productTypes": {
"title": "Product types",
"type": "array",
"description": "Exact product types to keep (case-insensitive), e.g. Shoes.",
"items": {
"type": "string"
}
},
"vendors": {
"title": "Vendors / brands",
"type": "array",
"description": "Exact vendor names to keep (case-insensitive).",
"items": {
"type": "string"
}
},
"onlyAvailable": {
"title": "Only in-stock products",
"type": "boolean",
"description": "Keep products (or variants) that are available to buy.",
"default": false
},
"onlyOnSale": {
"title": "Only discounted products",
"type": "boolean",
"description": "Keep products with a compare-at price above the current price.",
"default": false
},
"minPrice": {
"title": "Min price",
"minimum": 0,
"type": "integer",
"description": "In the store's currency."
},
"maxPrice": {
"title": "Max price",
"minimum": 0,
"type": "integer",
"description": "In the store's currency."
},
"updatedSince": {
"title": "Updated since",
"type": "string",
"description": "2026-10-01 or relative: 24 hours, 7 days."
},
"maxProductsPerStore": {
"title": "Max products per store",
"minimum": 0,
"type": "integer",
"description": "Products read per store / collection (0 = all, up to 25,000).",
"default": 1000
},
"maxResults": {
"title": "Max records in total",
"minimum": 0,
"type": "integer",
"description": "Overall cap on output records (0 = no cap). Also caps your cost.",
"default": 0
},
"includeDescription": {
"title": "Include description text",
"type": "boolean",
"description": "Plain-text product description.",
"default": true
},
"trackChanges": {
"title": "Track price & stock changes",
"type": "boolean",
"description": "Remember prices and stock between runs and set isNew, priceChanged, previousPrice and availabilityChanged.",
"default": true
},
"onlyChanges": {
"title": "Only new / changed items",
"type": "boolean",
"description": "Output only items that are new or whose price or stock changed since the previous run (needs tracking on). Great for scheduled price alerts.",
"default": false
},
"stateStoreName": {
"title": "Tracking store name",
"type": "string",
"description": "Named key-value store that keeps the tracking snapshot. Use different names for separate monitors.",
"default": "shopify-products-tracker"
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Requests go direct first. If a store rate-limits (HTTP 429), the Actor switches to a fresh proxy IP from this configuration. Apify Proxy (default) works well.",
"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
}
}
}
}
}
}
}
}
}
}