{ "openapi": "3.0.1", "info": { "title": "Shopify Store Scraper — All Products, Variants, Prices & Stock", "description": "Scrape any Shopify store's full catalogue: products, variants, SKUs, prices, compare-at prices, discounts, stock status, vendors, tags, images and descriptions. Collections, one row per variant, barcodes and stock counts, and a monitor mode for new products, price changes and sell-outs.", "version": "0.1", "x-build-id": "Z5svmqEcoX2ecyl6K" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yugenox~shopify-store-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yugenox-shopify-store-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/yugenox~shopify-store-products-scraper/runs": { "post": { "operationId": "runs-sync-yugenox-shopify-store-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/yugenox~shopify-store-products-scraper/run-sync": { "post": { "operationId": "run-sync-yugenox-shopify-store-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", "properties": { "storeUrls": { "title": "🛍️ Shopify store URLs", "type": "array", "description": "Stores to scrape: a domain (\"allbirds.com\"), a store URL, a collection URL (\"https://www.allbirds.com/collections/mens\" = only that collection) or a product URL (\"…/products/\" = only that product). Mix as many as you like; each store is read once.", "items": { "type": "string" } }, "collectionHandles": { "title": "Only these collections", "type": "array", "description": "Optional: collection handles (the part after /collections/ in the URL, e.g. \"mens\", \"sale\", \"new-arrivals\"). When set, only these collections of the stores above are read instead of the whole catalogue. Each row says which collection it came from.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Stop reading a store after this many products. 0 = the whole catalogue.", "default": 1000 }, "maxItems": { "title": "Max rows for the whole run", "minimum": 0, "maximum": 2000000, "type": "integer", "description": "Maximum number of dataset rows (and charged results) for the whole run, across all stores. 0 = no limit. In monitor mode it limits the saved changes; how many products are compared (and charged as \"Product checked\") is set by Max products per store.", "default": 0 }, "outputPerVariant": { "title": "One row per variant", "type": "boolean", "description": "Save one row per variant (size / colour / …) with its own SKU, price, compare-at price, stock status and options, instead of one row per product with the variants as a list. Each variant row counts as one result.", "default": false }, "includeStockDetails": { "title": "Include stock quantity and barcode", "type": "boolean", "description": "Also read each product's own data to add every variant's barcode (UPC / EAN / GTIN) and stock quantity, where the store shows it (many stores hide quantities). One extra request per product, charged as \"Stock details\" (see the Pricing tab). Product URLs always include them, free.", "default": false }, "monitorMode": { "title": "Monitor mode: only what changed", "type": "boolean", "description": "Compare with the previous run that had the same store and scope, and save only new products, price and compare-at price changes, sell-outs, back-in-stock and removed products (each row has changeType, changes and the previous values). The first run saves everything as \"new\" (the baseline). Unchanged products are not saved and are charged as \"Product checked\", half the price of a result. Schedule it daily to track competitors.", "default": false }, "saveUnchanged": { "title": "Monitor mode: also save unchanged products", "type": "boolean", "description": "In monitor mode, save unchanged products too (changeType \"unchanged\"), charged as normal results. Useful for a full daily snapshot with change flags.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy (datacenter) is the default and comes with every Apify plan. If a store keeps throttling datacenter IPs (HTTP 429 / 430), its product data is retried on residential proxies when your account has them, at no extra charge to you.", "default": { "useApifyProxy": true } }, "_noResidential": { "title": "Run as an account without residential proxies", "type": "boolean", "description": "Internal (canaries): behave exactly like an account without the RESIDENTIAL proxy group.", "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 } } } } } } } } } }