{ "openapi": "3.0.1", "info": { "title": "Shopify Products Scraper: Prices, Variants, Stock & Launches", "description": "Scrape every product from any Shopify store or collection: price, compare-at price and discount, stock, variants, sizes and colors, tags, images and launch dates. Plus a free store summary with price range, top product types and what launched in the last 30 days.", "version": "1.0", "x-build-id": "XgSanwZaoK1HeTVVE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vncntlabs~shopify-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vncntlabs-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/vncntlabs~shopify-products-scraper/runs": { "post": { "operationId": "runs-sync-vncntlabs-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/vncntlabs~shopify-products-scraper/run-sync": { "post": { "operationId": "run-sync-vncntlabs-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": "Shopify store or collection URLs", "type": "array", "description": "Up to 50 Shopify stores. Use the store's home page (https://example.com) for the whole catalog, or a collection URL (https://example.com/collections/t-shirts) for one collection. Stores that aren't on Shopify, are password protected or block the request are reported and not charged.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Products to return from each store. You pay $0.0005 per product row ($0.50 per 1,000). The store's feed lists the most recently published products first.", "default": 250 }, "keywords": { "title": "Only products matching these words (optional)", "type": "array", "description": "Keep products whose title, tags, product type, vendor or handle contain any of these words, for example hoodie or halloween. With a filter on, the Actor reads up to 4x your max products (at least 1,000, at most 10,000) to find matches.", "items": { "type": "string" } }, "publishedWithinDays": { "title": "Only products published in the last N days", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Good for spotting a competitor's new launches. 0 means any date.", "default": 0 }, "onlyOnSale": { "title": "Only products on sale", "type": "boolean", "description": "Keep products where at least one variant has a compare-at price above its price.", "default": false }, "onlyInStock": { "title": "Only products in stock", "type": "boolean", "description": "Keep products with at least one available variant.", "default": false }, "sortBy": { "title": "Sort products by", "enum": [ "store", "newest", "price-asc", "price-desc", "discount" ], "type": "string", "description": "Sorting applies to the products read from each store.", "default": "store" }, "includeVariants": { "title": "Include every variant", "type": "boolean", "description": "Adds a variants list to each product: title, SKU, price, compare-at price, stock and option values. Same price per product.", "default": false }, "includeDescription": { "title": "Include product description", "type": "boolean", "description": "Adds the description as plain text (up to 1,000 characters). Same price per product.", "default": 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 } } } } } } } } } }