{ "openapi": "3.0.1", "info": { "title": "Shopify Store Scraper & Products API — Prices & Variants", "description": "Full product catalogue of any Shopify store from its public products.json: title, vendor, type, tags, variants with price, SKU and stock, images, collections. Unofficial Shopify API.", "version": "0.1", "x-build-id": "UhLUcEhOxMsx6wfBC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/highbrow_fame~shopify-store-products-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-highbrow_fame-shopify-store-products-api", "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/highbrow_fame~shopify-store-products-api/runs": { "post": { "operationId": "runs-sync-highbrow_fame-shopify-store-products-api", "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/highbrow_fame~shopify-store-products-api/run-sync": { "post": { "operationId": "run-sync-highbrow_fame-shopify-store-products-api", "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 stores to read, one per line: a domain (allbirds.com) or any URL on the store — it is reduced to the store's origin. The whole catalogue is read, 250 products per page, unless Collections narrows it.", "items": { "type": "string" } }, "collections": { "title": "Collections", "type": "array", "description": "Optional. Collection handles (mens, sale) or collection URLs (https://store.com/collections/sale), one per line. A handle applies to every store above; a URL to its own store (added when it is not listed). Then only those collections are read and each product carries its collection.", "items": { "type": "string" } }, "maxProducts": { "title": "Max products per store", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Products to deliver per store, after the filters, up to 50,000. Pages of 250 are read until that many are collected or the catalogue ends.", "default": 250 }, "includeCollectionsList": { "title": "Include the collection list", "type": "boolean", "description": "Also list the store's collections — id, handle, title, product count, dates — as free records with status COLLECTION, one per collection (from /collections.json).", "default": false }, "onlyAvailable": { "title": "Only in stock", "type": "boolean", "description": "Keep only products with at least one variant available.", "default": false }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Keep products with at least one variant priced at or above this, in the store's currency." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Keep products with at least one variant priced at or below this, in the store's currency." }, "vendor": { "title": "Vendor", "type": "string", "description": "Keep only products of this vendor (brand): exact match, case-insensitive." }, "includeDescription": { "title": "Include description", "type": "boolean", "description": "The product description as plain text: HTML removed, e-mail addresses and phone numbers scrubbed, cut at 5,000 characters.", "default": true }, "includeDescriptionHtml": { "title": "Include description HTML", "type": "boolean", "description": "Also the original body_html of the product (e-mail addresses and phone numbers scrubbed).", "default": false }, "maxConcurrency": { "title": "Parallel stores", "minimum": 1, "maximum": 10, "type": "integer", "description": "Stores read at the same time. Pages within one store are always read one after another, with the delay below between them.", "default": 3 }, "delayMs": { "title": "Delay between pages (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Pause between two pages of the same store. 500 ms keeps a run under most stores' rate limits.", "default": 500 }, "respectRobots": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip a store whose robots.txt disallows /products.json for crawlers (free ROBOTS_DISALLOWED record). Shopify's default robots.txt allows it.", "default": true }, "proxyFromFirstRequest": { "title": "Proxy from the first request", "type": "boolean", "description": "Send every request through the proxy from the first try instead of trying directly first. Switch on — ideally with a residential proxy group below — when stores answer HTTP 429 or 403 to direct requests. A refused request is still never retried from another IP.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Which proxy to use. By default the first try of every request goes out without a proxy and the proxy serves only retries after a network error; with Proxy from the first request on, every request goes through it. A store that refuses a request (HTTP 403, bot check) is never retried on another IP.", "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 }, "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 } } } } } } } } } }