{ "openapi": "3.0.1", "info": { "title": "Shopify Scraper — Store Products, Prices & Catalog Intel", "description": "Scrape any Shopify store's full product catalog from its public products.json: titles, vendors, variants, SKUs, prices, real discounts and stock status. Adds a store-intelligence row — price bands, % on sale, out-of-stock rate, new products. No API key. Company-level data only.", "version": "1.0", "x-build-id": "vIh1P6lUkRs445jF9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mochiboo~shopify-store-products-price-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mochiboo-shopify-store-products-price-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/mochiboo~shopify-store-products-price-scraper/runs": { "post": { "operationId": "runs-sync-mochiboo-shopify-store-products-price-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/mochiboo~shopify-store-products-price-scraper/run-sync": { "post": { "operationId": "run-sync-mochiboo-shopify-store-products-price-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": { "storeDomains": { "title": "Shopify store domains", "type": "array", "description": "Store domains to scrape, e.g. allbirds.com. Scheme and paths are stripped automatically. Each store is read from its own public /products.json endpoint.", "default": [ "allbirds.com" ], "items": { "type": "string" } }, "outputMode": { "title": "What to return", "enum": [ "products", "storeSummary", "both" ], "type": "string", "description": "products = one row per product. storeSummary = one rollup row per store (price bands, % discounted, stock rate). both = product rows plus a summary row.", "default": "products" }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "type": "integer", "description": "Upper bound on product rows returned per store. Store-summary mode always reads the whole catalog.", "default": 20 }, "keyword": { "title": "Keyword filter", "type": "string", "description": "Keep only products whose title, description or tags contain this text. Case-insensitive. Empty = no keyword filter.", "default": "" }, "productType": { "title": "Product type", "type": "string", "description": "Exact-match filter on the Shopify product_type field, e.g. Shoes. Empty = all types.", "default": "" }, "vendor": { "title": "Vendor", "type": "string", "description": "Exact-match filter on the Shopify vendor field. Empty = all vendors.", "default": "" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Keep products with at least one variant priced at or above this value, in the store's own currency. 0 = no minimum.", "default": 0 }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Keep products with at least one variant priced at or below this value, in the store's own currency. 0 = no maximum.", "default": 0 }, "onlyDiscounted": { "title": "Only discounted products", "type": "boolean", "description": "Keep only products genuinely on sale — a variant whose compare-at price is strictly higher than its price.", "default": false }, "onlyInStock": { "title": "Only products in stock", "type": "boolean", "description": "Drop products whose every variant is unavailable.", "default": false }, "publishedAfter": { "title": "Published after", "type": "string", "description": "Keep only products published on or after this date, format YYYY-MM-DD. Useful for spotting new arrivals. Empty = no date filter.", "default": "" }, "respectRobots": { "title": "Respect each store's robots.txt", "type": "boolean", "description": "Fetch and honour every store's robots.txt before reading its catalog, and skip stores that disallow it. Leave on unless you own the store.", "default": true }, "requestDelayMs": { "title": "Delay between page requests (ms)", "minimum": 0, "type": "integer", "description": "Pause between catalog pages of the same store. The 500 ms default keeps large catalog walks from tripping the store's rate limiter; raise it further for stores that still return HTTP 429.", "default": 500 }, "useApifyProxy": { "title": "Use Apify residential proxy", "type": "boolean", "description": "Route requests through rotating residential IPs. Off by default — these are public endpoints and usually need no proxy.", "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 } } } } } } } } } }