{ "openapi": "3.0.1", "info": { "title": "Shopify Products Scraper: Store Catalog Export to JSON, CSV", "description": "Products from any Shopify store's public catalog: title, vendor, type, tags, description, variants with price, compare-at price, SKU and stock, images, options, store currency. Whole catalog or collections, filters by date, price and stock; robots.txt obeyed, no login, no proxy. Pay per product.", "version": "1.0", "x-build-id": "wiKkqIImMnRYBX3cM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rowcraft~shopify-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rowcraft-shopify-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/rowcraft~shopify-products-scraper/runs": { "post": { "operationId": "runs-sync-rowcraft-shopify-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/rowcraft~shopify-products-scraper/run-sync": { "post": { "operationId": "run-sync-rowcraft-shopify-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", "required": [ "stores" ], "properties": { "stores": { "title": "Stores", "type": "array", "description": "Shopify stores to read, one per line: a domain (allbirds.com), a store URL, a collection URL (https://store.com/collections/sale → only that collection) or a product URL (https://store.com/products/handle → only that product). The store's robots.txt is read first and obeyed.", "items": { "type": "string" } }, "collections": { "title": "Collections", "type": "array", "description": "Collection handles (sale, mens, new-arrivals) or collection URLs applied to every store above. Empty = the whole catalogue of each store.", "items": { "type": "string" } }, "rowPerVariant": { "title": "One row per variant", "type": "boolean", "description": "Off: one row per product with a variants list. On: one row per variant (size, colour…) with its own SKU, price and stock; you pay per row.", "default": false }, "availableOnly": { "title": "In stock only", "type": "boolean", "description": "Keep only products with at least one available variant (with rows per variant: only available variants).", "default": false }, "publishedAfter": { "title": "Published after", "type": "string", "description": "Only products published on or after this date: 2026-10-01, yesterday, 7 days, 3 months." }, "updatedAfter": { "title": "Updated after", "type": "string", "description": "Only products changed on or after this date (price, stock, text): 2026-10-01, yesterday, 7 days." }, "vendors": { "title": "Vendors", "type": "array", "description": "Keep only these vendors (brand names as shown in the store), one per line, exact match ignoring case.", "items": { "type": "string" } }, "productTypes": { "title": "Product types", "type": "array", "description": "Keep only these product types (as set by the store), one per line, exact match ignoring case.", "items": { "type": "string" } }, "tags": { "title": "Tags", "type": "array", "description": "Keep products carrying at least one of these tags, one per line, ignoring case.", "items": { "type": "string" } }, "titleContains": { "title": "Title contains", "type": "string", "description": "Keep only products whose title contains this text (ignoring case)." }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "In the store's currency; a product passes when at least one variant is at or above it." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "In the store's currency; a product passes when at least one variant is at or below it." }, "includeDescription": { "title": "Description as text", "type": "boolean", "description": "Plain-text description (HTML removed, contact data masked).", "default": true }, "includeDescriptionHtml": { "title": "Description as HTML", "type": "boolean", "description": "Also keep the description HTML as the store wrote it (contact links removed).", "default": false }, "includeImages": { "title": "Image list", "type": "boolean", "description": "All product images with size and position. The first image URL is always in the row.", "default": true }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 0, "type": "integer", "description": "Stop each store after this many products (0 = all).", "default": 0 }, "maxItems": { "title": "Max rows", "minimum": 0, "type": "integer", "description": "Stop after this many rows in total (0 = all).", "default": 1000 }, "countOnly": { "title": "Count only (free check)", "type": "boolean", "description": "Only count how many rows match your filters and estimate the cost at your price tier. Nothing is delivered and nothing is charged apart from the start event. Turn it off to get the data.", "default": false }, "onlyNew": { "title": "Only new rows since the last run", "type": "boolean", "description": "Remember the rows already delivered to you (in a key-value store in your Apify account) and deliver only rows that appeared since the last run with the same state key. The first run delivers everything that matches; later runs cost only the new rows. Ideal for schedules.", "default": false }, "stateName": { "title": "State name", "type": "string", "description": "Name of the memory used by \"Only new rows\". Use a different name for each schedule or search (for example `stockholm-python`) so they do not share one memory.", "default": "default" }, "notifyUrl": { "title": "Notify this URL when the run ends", "type": "string", "description": "A webhook address that receives one JSON POST with the number of new rows and links to the dataset: a Slack or Discord incoming webhook, a Make, n8n or Zapier catch hook, or your own endpoint. The message is also in the `text` (Slack) and `content` (Discord) fields." }, "notifyWhenEmpty": { "title": "Notify also when there are no new rows", "type": "boolean", "description": "By default the notification is sent only when at least one row was delivered.", "default": false }, "requestIntervalMs": { "title": "Pause between requests (ms)", "minimum": 500, "maximum": 10000, "type": "integer", "description": "One request per second by default (each request returns up to 250 products). 500 ms is the lowest allowed.", "default": 1000 } } }, "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 } } } } } } } } } }