{ "openapi": "3.0.1", "info": { "title": "Shopify Store Products Scraper", "description": "Scrape any Shopify store's full product catalog from its public feed. Get prices, compare-at prices, variants, SKUs, stock status, images, tags and vendor. Paste a domain or collection URL, no login or API key needed. One row per product or per variant.", "version": "0.0", "x-build-id": "neKIIgTrMEReApc6l" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mangudai~shopify-store-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mangudai-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/mangudai~shopify-store-products-scraper/runs": { "post": { "operationId": "runs-sync-mangudai-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/mangudai~shopify-store-products-scraper/run-sync": { "post": { "operationId": "run-sync-mangudai-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": "Store URLs", "type": "array", "description": "Shopify store home pages or collection URLs. A bare domain works too. Paste a /collections/ URL to scrape only that collection.", "default": [ "https://gymshark.com", "https://colourpop.com" ], "items": { "type": "string" } }, "collectionHandles": { "title": "Collection handles", "type": "array", "description": "Optional. Restrict every store to these collection handles, for example womens-leggings. Leave empty to scrape the whole catalog.", "default": [], "items": { "type": "string" } }, "searchTerm": { "title": "Keyword filter", "type": "string", "description": "Optional. Keep only products whose title, type, vendor or tags contain this text." }, "outputMode": { "title": "Output mode", "enum": [ "product", "variant" ], "type": "string", "description": "One row per product, or one row per variant for price and stock monitoring.", "default": "product" }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "type": "integer", "description": "Stop after this many products from each store or collection.", "default": 100 }, "onlyAvailable": { "title": "Only products in stock", "type": "boolean", "description": "Skip products where every variant is sold out.", "default": false }, "minPrice": { "title": "Minimum price", "type": "integer", "description": "Optional. Skip products cheaper than this, in the store's own currency." }, "maxPrice": { "title": "Maximum price", "type": "integer", "description": "Optional. Skip products more expensive than this." }, "includeVariants": { "title": "Include variants array", "type": "boolean", "description": "Add the full variant list to each product row.", "default": true }, "includeImages": { "title": "Include images array", "type": "boolean", "description": "Add the full image list to each product row.", "default": true }, "includeDescriptionHtml": { "title": "Include raw HTML description", "type": "boolean", "description": "Keep the original body_html next to the plain-text description.", "default": false }, "requestDelaySecs": { "title": "Delay between pages (seconds)", "type": "integer", "description": "Pause between catalog pages so stores are not hammered.", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy keeps requests from being throttled by busy stores.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }