{ "openapi": "3.0.1", "info": { "title": "Shopify Store Products Scraper: Prices, Variants, Stock", "description": "Get every product of any public Shopify store: title, prices and compare-at prices, sale flag and discount %, in-stock flag, all variants with SKU, options, images, vendor, type, tags and dates. Whole store or one collection, product or variant rows, keyword and on-sale filters.", "version": "0.1", "x-build-id": "RzjSTD9njF3KHa0p3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/larkmoor~shopify-store-products/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-larkmoor-shopify-store-products", "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/larkmoor~shopify-store-products/runs": { "post": { "operationId": "runs-sync-larkmoor-shopify-store-products", "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/larkmoor~shopify-store-products/run-sync": { "post": { "operationId": "run-sync-larkmoor-shopify-store-products", "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": "Store or collection URLs", "type": "array", "description": "Shopify store home pages (e.g. allbirds.com) or collection URLs (e.g. kith.com/collections/mens-footwear) to export only that collection. One per line.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many rows per store. Default: 1,000.", "default": 1000 }, "outputMode": { "title": "One row per", "enum": [ "product", "variant" ], "type": "string", "description": "Product rows carry a `variants` list; variant rows are flat (one per size/color) and are each charged as one row. Default: product.", "default": "product" }, "onlyAvailable": { "title": "Only in-stock", "type": "boolean", "description": "Skip products (or variants) that are sold out. Default: false.", "default": false }, "onlyOnSale": { "title": "Only on sale", "type": "boolean", "description": "Keep only products with a compare-at price above the price. Default: false.", "default": false }, "keywords": { "title": "Keywords (any match)", "type": "array", "description": "Keep only products whose title, vendor, type, tags or description contain one of these words. Empty = all.", "default": [], "items": { "type": "string" } }, "updatedSinceDays": { "title": "Updated in the last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Keep only products updated within this many days (new products, price changes, restocks). Empty = all." }, "includeDescription": { "title": "Include description", "type": "boolean", "description": "Add the product description as plain text. Default: true.", "default": true }, "descriptionMaxChars": { "title": "Description length (characters)", "minimum": 50, "maximum": 50000, "type": "integer", "description": "Default: 1,000.", "default": 1000 }, "includeAllImages": { "title": "Include all image URLs", "type": "boolean", "description": "Add the full `images` list (the first image is always in `imageUrl`). Default: false.", "default": false }, "maxResults": { "title": "Max rows in total", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Stop after this many rows across all stores. Default: 5,000.", "default": 5000 }, "delaySeconds": { "title": "Pause between pages (seconds)", "minimum": 0, "maximum": 30, "type": "number", "description": "Polite pause between catalog pages of 250 products. Default: 1.", "default": 1 }, "timeoutSeconds": { "title": "Timeout per request (seconds)", "minimum": 3, "maximum": 120, "type": "integer", "description": "Default: 25.", "default": 25 }, "userAgent": { "title": "User-Agent", "type": "string", "description": "Optional custom User-Agent header." } } }, "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 } } } } } } } } } }