{ "openapi": "3.0.1", "info": { "title": "Shopify Product Export Scraper | Variants, Stock, $0.90/1K", "description": "Scrape Shopify store products at $0.90 per 1,000 products with barcodes (GTIN) and public stock counts included, where the most-used Shopify scrapers charge $1.00 plus about $1 per 1,000 for those add-ons. Any store, no login: variants, SKU, prices, compare-at price, collections, price-change flags.", "version": "0.1", "x-build-id": "fI4g7eAdMdlFYNqqv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/aurelix~shopify-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-aurelix-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/aurelix~shopify-products-scraper/runs": { "post": { "operationId": "runs-sync-aurelix-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/aurelix~shopify-products-scraper/run-sync": { "post": { "operationId": "run-sync-aurelix-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": [ "storeUrls" ], "properties": { "storeUrls": { "title": "Shopify store URLs", "type": "array", "description": "Stores to read, as a domain or any URL on the store, e.g. 'kith.com', 'https://www.allbirds.com', 'https://shop.example.com/collections/sale'. Only the domain is used. Stores that hide their public product feed are skipped and named in the run status.", "default": [], "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Upper limit of products read per store, e.g. 100 for a quick sample. 0 = the whole catalogue.", "default": 0 }, "incremental": { "title": "Only new or changed products", "type": "boolean", "description": "Return only products that are new or changed (price, compare-at price, stock, SKU, variants, title or tags) since the previous run on the same store. Use with a schedule for a daily change feed. Price-change flags are set on every run either way.", "default": false }, "includeCollections": { "title": "Add collection names", "type": "boolean", "description": "Read the store's public collections.json and tag each product with the collections it belongs to, e.g. ['Sale', 'New Arrivals']. Costs one extra request per collection.", "default": true }, "maxCollections": { "title": "Max collections per store", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Upper limit of collections read for the collection tags, e.g. 20. Large stores can have over 1,000 collections. 0 = all.", "default": 20 }, "includeDescription": { "title": "Include description", "type": "boolean", "description": "Include the product description as plain text and HTML. Turn off for smaller, faster output.", "default": true }, "includeVariantDetails": { "title": "Barcodes and stock counts", "type": "boolean", "description": "Also read each product's public detail file for every variant's barcode (GTIN, UPC or EAN) and, on stores that publish it, the stock count (inventory_quantity, plus inventory_total per product). One extra request per product, so runs take longer; the price per product does not change. Stores that do not publish stock leave those fields empty.", "default": false }, "stateKey": { "title": "Change-tracking name (optional)", "type": "string", "description": "Name for the 'previous run' memory used by price-change flags and incremental mode, e.g. 'competitors-daily'. Leave empty to share one memory per store across all your runs." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional proxy. Shopify stores are public and usually work without one; turn on Apify Proxy if a store answers with rate limits (HTTP 429).", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }