{ "openapi": "3.0.1", "info": { "title": "Shopify Store Scraper — Products & Variants", "description": "Scrape any Shopify store's products from its public JSON endpoints: title, vendor, type, tags, variants with prices, compare-at prices, SKUs and stock status, images and URLs. Filter by collection, one row per product or per variant, monitor prices and stock on a schedule. No login or API key.", "version": "0.1", "x-build-id": "GXL43Z5XWXVe8iGlD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~shopify-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-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/tortuga~shopify-store-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-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/tortuga~shopify-store-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-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": "Store URLs", "type": "array", "description": "Shopify stores to scrape: a domain (allbirds.com) or any page of the store (https://colourpop.com/collections/best-sellers). A collection page scrapes that collection, a product page that product, anything else the whole catalog. One line per store.", "items": { "type": "string" } }, "collections": { "title": "Collections", "type": "array", "description": "Collection handles to scrape instead of the whole catalog, applied to every store above: the part after /collections/ in the store's URL, e.g. best-sellers, new-arrivals, sale. An unknown handle returns no products and is listed in the run summary.", "items": { "type": "string" } }, "productUrls": { "title": "Product URLs", "type": "array", "description": "Single product pages to scrape, e.g. https://colourpop.com/products/bare-necessity. Fetched first, before the stores; a product that is no longer published is listed in the run summary (not charged).", "items": { "type": "string" } }, "itemPerVariant": { "title": "One row per variant", "type": "boolean", "description": "Off: one item per product with a `variants` array (price = the cheapest variant). On: one item per variant (size, colour, ...) with its own price, compare-at price, SKU, barcode, stock status and URL; each variant row is charged as one result.", "default": false }, "onlyAvailable": { "title": "Only in-stock products", "type": "boolean", "description": "Skip products (or variants, with one row per variant) that are sold out. Skipped items are not charged.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many items in total (products, or variant rows with one row per variant). Keeps the cost predictable: a request returns up to 250 products.", "default": 500 }, "maxPagesPerStore": { "title": "Max pages per store", "minimum": 1, "maximum": 400, "type": "integer", "description": "How many catalog pages of 250 products to read per store (or per collection, when Collections are set), so one huge store does not use up Max items for the others. 20 pages = 5,000 products; up to 400.", "default": 20 }, "onlyNewOrChanged": { "title": "Only new or changed items", "type": "boolean", "description": "Remember what earlier runs of this input returned and output only new products or products whose price or stock status changed. Use with a Schedule; unchanged products are not charged. With this on, Max items is the number of products checked per run.", "default": false }, "monitoringKey": { "title": "Monitoring key", "type": "string", "description": "Name for this watch, so several schedules on the same stores stay separate; defaults to a key derived from the input" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy (datacenter) is the default and is enough: Shopify's public JSON endpoints answer datacenter IPs (one page of 250 products is 1-2 MB). Switch to residential only if a store keeps answering Shopify's 'Verify your browser' check.", "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 } } } } } } } } } }