{ "openapi": "3.0.1", "info": { "title": "Shopify Variant Scraper: Price, SKU & Stock", "description": "Scrape any public Shopify store into one row per product variant: SKU, variant title, options, price, compare-at price, discount percent, availability, barcode, weight, images, vendor, product type, tags and description. Batch many stores, filter by collection, vendor, price or sale status.", "version": "0.1", "x-build-id": "b5kdvWINsDkLml7NF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiorasolutions~shopify-variant-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiorasolutions-shopify-variant-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/axiorasolutions~shopify-variant-scraper/runs": { "post": { "operationId": "runs-sync-axiorasolutions-shopify-variant-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/axiorasolutions~shopify-variant-scraper/run-sync": { "post": { "operationId": "run-sync-axiorasolutions-shopify-variant-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": [ "stores" ], "properties": { "stores": { "title": "Shopify stores", "minItems": 1, "uniqueItems": true, "type": "array", "description": "One store per entry. A bare domain, a full URL or a myshopify.com address all work: allbirds.com, https://kith.com, examplestore.myshopify.com.", "items": { "type": "string" } }, "collections": { "title": "Collection handles", "type": "array", "description": "Restrict to specific collections by handle, for example mens-shoes or new-arrivals. The handle is the last path segment of a /collections/... URL. Leave empty to read the whole catalogue.", "items": { "type": "string" } }, "productHandles": { "title": "Product handles", "type": "array", "description": "Fetch only these specific products by handle, the last path segment of a /products/... URL. Fastest option when you track a known set of SKUs.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 25000, "type": "integer", "description": "Stop after this many products from each store. One product usually expands to several variant rows.", "default": 250 }, "maxVariantsTotal": { "title": "Max variants for the whole run", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Hard ceiling on billed rows across every store. The run stops cleanly when it is reached.", "default": 5000 }, "includeDescription": { "title": "Include product description", "type": "boolean", "description": "Add the product description as clean plain text. Off by default because descriptions dominate export size.", "default": false }, "descriptionMaxChars": { "title": "Description character limit", "minimum": 100, "maximum": 40000, "type": "integer", "description": "Truncate description text at this length.", "default": 2000 }, "availableOnly": { "title": "In-stock variants only", "type": "boolean", "description": "Keep only variants the store currently reports as purchasable. Leave off to see sold-out variants too, which is what you want for stockout tracking.", "default": false }, "onSaleOnly": { "title": "Discounted variants only", "type": "boolean", "description": "Keep only variants where the compare-at price is higher than the current price, meaning the store is advertising a discount.", "default": false }, "minPrice": { "title": "Minimum price", "type": "number", "description": "Keep only variants priced at or above this value, in the store's own currency. Leave empty for no lower bound." }, "maxPrice": { "title": "Maximum price", "type": "number", "description": "Keep only variants priced at or below this value, in the store's own currency." }, "vendors": { "title": "Vendors", "type": "array", "description": "Keep only products from these vendors, case-insensitive substring match.", "items": { "type": "string" } }, "productTypes": { "title": "Product types", "type": "array", "description": "Keep only these Shopify product types, case-insensitive substring match.", "items": { "type": "string" } }, "tags": { "title": "Tags", "type": "array", "description": "Keep only products carrying at least one of these tags, case-insensitive.", "items": { "type": "string" } }, "publishedAfter": { "title": "Published after", "type": "string", "description": "Keep only products published on or after this date. Accepts 2026-01-31 or a relative value such as 30 days. Good for catching new arrivals." }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 5, "maximum": 120, "type": "integer", "description": "Give up on a single store request after this many seconds.", "default": 30 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Some stores put a bot shield in front of their product feed and answer 403. Datacenter proxy rotation usually clears that. Residential groups also work but Apify bills them per gigabyte.", "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 } } } } } } } } } }