{ "openapi": "3.0.1", "info": { "title": "Shopify Store Scraper - Products, Prices & Variants", "description": "Scrape any Shopify store via the public /products.json endpoint. Get product title, vendor, type, tags, images, full variants (SKU, price, compare-at, availability), and options. No auth, no browser, works on most myshopify.com stores and custom domains.", "version": "1.0", "x-build-id": "VKVarfbpmPzMXpTFy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thirdwatch~shopify-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thirdwatch-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/thirdwatch~shopify-store-scraper/runs": { "post": { "operationId": "runs-sync-thirdwatch-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/thirdwatch~shopify-store-scraper/run-sync": { "post": { "operationId": "run-sync-thirdwatch-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", "required": [ "storeUrls" ], "properties": { "storeUrls": { "title": "Shopify Store URLs", "type": "array", "description": "List of Shopify store URLs to scrape. Accepts the homepage (e.g. 'https://www.allbirds.com'), a myshopify.com subdomain, or a specific collection URL (e.g. 'https://store.com/collections/new-arrivals').", "items": { "type": "string" } }, "collectionHandles": { "title": "Collection Handles (per-store categories)", "type": "array", "description": "Optional list of Shopify collection handles (e.g. 'mens-shoes', 'sale', 'new-arrivals'). When provided, each store URL is scraped once per handle via /collections/{handle}/products.json. Collections are Shopify's per-store category equivalent -- there is no global taxonomy across stores. Leave empty to scrape the store's full catalog from /products.json.", "items": { "type": "string" } }, "sortBy": { "title": "Sort By", "enum": [ "relevance", "priceAsc", "priceDesc", "newest", "bestSelling", "title" ], "type": "string", "description": "Sort order for collection results. Note: Shopify's root /products.json (no collection) DOES NOT support sort_by -- sorting only applies to collection URLs. For root /products.json, this field is ignored and Shopify's natural pagination order is used.", "default": "relevance" }, "minPrice": { "title": "Minimum Price", "minimum": 0, "type": "integer", "description": "Optional minimum price filter. Applied as a POST-filter in code (Shopify's /products.json does not accept price params). A product is kept if any of its variants has a price >= minPrice." }, "maxPrice": { "title": "Maximum Price", "minimum": 0, "type": "integer", "description": "Optional maximum price filter. Applied as a POST-filter in code. A product is kept if any of its variants has a price <= maxPrice." }, "maxProductsPerStore": { "title": "Max Products Per Store", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of products to fetch per store. Start small for a test run; raise for full catalog pulls.", "default": 25 }, "includeVariants": { "title": "Include Variants", "type": "boolean", "description": "If true, include the full list of variants (size/color/SKU/price/availability) on each product. If false, only the price range is kept (smaller output).", "default": true }, "useProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Route requests through Apify's proxy. Most Shopify stores work without it; enable this only if a specific store returns errors.", "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 } } }, "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 } } } } } } } } } }