{ "openapi": "3.0.1", "info": { "title": "Shopify Scraper — Products, Prices, Variants, Stock", "description": "Shopify store scraper for any public Shopify storefront, worldwide: products, variant prices, compare-at (sale) prices, SKUs, availability, options, images, tags and vendor, plus optional barcodes and inventory counts. Input: store domains, collection URLs or handles. Pay per result, no login.", "version": "0.0", "x-build-id": "tVCzKZTy761JjPwOt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/architekture~shopify-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-architekture-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/architekture~shopify-products-scraper/runs": { "post": { "operationId": "runs-sync-architekture-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/architekture~shopify-products-scraper/run-sync": { "post": { "operationId": "run-sync-architekture-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": [ "storeUrls" ], "properties": { "storeUrls": { "title": "Shopify stores", "maxItems": 200, "type": "array", "description": "Store domains or URLs, e.g. allbirds.com or https://www.gymshark.com. A collection URL (https://store.com/collections/sale) scrapes just that collection. Each store is checked first; stores that are not Shopify (or block access) are reported, never charged. Up to 200 per run.", "items": { "type": "string" } }, "collections": { "title": "Collections (optional)", "type": "array", "description": "Collection handles to scrape on every store instead of the whole catalog, e.g. sale or mens-shoes (the part after /collections/ in the URL).", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 0, "maximum": 25000, "type": "integer", "description": "Stop each store after this many products (one product = one row with all its variants). 0 = whole catalog (Shopify serves at most 25,000).", "default": 1000 }, "includeProductDetails": { "title": "Include product details (barcodes, stock counts)", "type": "boolean", "description": "Also fetch each product's storefront detail: per-variant barcode (GTIN/UPC), inventory quantity and inventory policy where the store exposes them, selling plans. One extra request per product; enriched rows are charged as product-detail.", "default": false }, "incrementalMode": { "title": "Incremental: only new or changed products", "type": "boolean", "description": "Requires stateKey. Delivers only products that are new to this stateKey, or whose title, variants, SKUs, prices, sale prices or availability changed since they were last delivered. Unchanged products are skipped and not charged; they still count toward maxProductsPerStore.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Any name (e.g. my-stores). Saves progress and the incremental baseline in your account under this name, so a stopped or aborted collection can be resumed and reruns can skip unchanged products. Use a different key for different store lists.", "default": "" }, "continuePreviousRun": { "title": "Continue saved collection", "type": "boolean", "description": "Resume an unfinished collection saved under stateKey (after a spending limit, timeout or abort) with the same stores. Products already delivered are not delivered or charged again.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy is the tested default. On HTTP 429 the actor retries on a fresh IP.", "default": { "useApifyProxy": true } }, "feedback": { "title": "Feedback for the maintainers", "type": "string", "description": "Tell the maintainers what you needed and did not get. Read by a human; does not change the output." } } }, "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 } } } } } } } } } }