{ "openapi": "3.0.1", "info": { "title": "Shopify Product Scraper", "description": "Export any Shopify store's full catalogue to CSV, Excel or JSON: variants, SKUs, prices, sale prices, stock and images. Opens stores that answer 403, 404 or 429 to other scrapers. From $0.79 per 1,000 products. No account, no API key.", "version": "0.1", "x-build-id": "UB7Dh1r0rF86XGh4P" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lightmoon~shopify-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lightmoon-shopify-product-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/lightmoon~shopify-product-scraper/runs": { "post": { "operationId": "runs-sync-lightmoon-shopify-product-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/lightmoon~shopify-product-scraper/run-sync": { "post": { "operationId": "run-sync-lightmoon-shopify-product-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": [ "storeDomains" ], "properties": { "storeDomains": { "title": "Store addresses", "type": "array", "description": "One per line, in any form: `allbirds.com`, `https://www.allbirds.com/`, a link to a single product, or the internal address `example.myshopify.com`. Duplicates and `www.` variants of the same shop are merged, so pasting a messy list costs you one run per store and not one per line.", "items": { "type": "string" } }, "maxProducts": { "title": "Maximum products in total", "minimum": 0, "type": "integer", "description": "Across all stores. 0 means no limit. A catalogue page carries up to 250 products, so a store of 300 costs two requests — start small on the free plan, where your own Apify usage is the cap.", "default": 1000 }, "maxProductsPerStore": { "title": "Maximum per store", "minimum": 0, "type": "integer", "description": "How deep to read one store before moving to the next. 0 means no limit. Use it to sample forty competitors evenly instead of spending the whole run inside the first one.", "default": 5000 }, "onlyAvailable": { "title": "In stock only", "type": "boolean", "description": "Keep products with at least one variant in stock. **Filters run before billing**, so what a filter removes is never charged to you — you pay for the products you asked for and we pay for the rest of the page.", "default": false }, "onlyOnSale": { "title": "On sale only", "type": "boolean", "description": "Keep products where at least one variant has a compare-at price above its current price. This is the field a raw catalogue download makes you compute yourself.", "default": false }, "minPrice": { "title": "Cheapest variant at least", "minimum": 0, "type": "integer", "description": "In the store's own currency. A product is kept if any of its variants reaches this price, so a 45–95 product belongs to both `over 90` and `under 50`." }, "maxPrice": { "title": "Cheapest variant at most", "minimum": 0, "type": "integer", "description": "In the store's own currency. Combine with the field above to take one price band out of a catalogue." }, "productTypes": { "title": "Only these product types", "type": "array", "description": "Shopify's own `product_type` field, matched exactly but ignoring case — for example `Shoes`, `T-Shirts`. Leave empty for every type. Run once without it to see what a store actually uses; the values are the store owner's, not a standard list.", "items": { "type": "string" } }, "vendors": { "title": "Only these vendors", "type": "array", "description": "Shopify's `vendor` field, matched exactly but ignoring case. On a multi-brand store this is how you take one brand out of it.", "items": { "type": "string" } }, "titleContains": { "title": "Title contains", "type": "string", "description": "A word or phrase, matched anywhere in the product title, ignoring case." }, "updatedSince": { "title": "Changed since", "type": "string", "description": "Keep only products the store has added or edited since then. Either a date — `2026-08-01` — or a span relative to the run: `24h`, `7d`, `2w`. **The relative form is what makes a schedule work**: a daily task set to `24h` returns what changed yesterday, every day, without anyone editing it." }, "includeVariants": { "title": "Include the variant list", "type": "boolean", "description": "Every size, colour and SKU with its own price, sale price and stock flag. This is the largest part of a row — turning it off keeps `variantsTotal`, `variantsAvailable`, `priceMin` and `priceMax`, and makes the export several times smaller for a spreadsheet.", "default": true }, "includeImages": { "title": "Include every image URL", "type": "boolean", "description": "The full image list in the store's own order. Turning it off keeps `imageCount` and `featuredImage`.", "default": true }, "includeDescription": { "title": "Include the description", "type": "boolean", "description": "The product description as plain readable text rather than as raw HTML.", "default": 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 } } } } } } } } } }