{ "openapi": "3.0.1", "info": { "title": "Shopify Scraper - Products, Variants, Prices & Stock", "description": "Shopify scraper and Shopify product scraper for any public Shopify store: all Shopify products with every variant's SKU, price, compare-at price and stock, from the store's own products.json. Built for Shopify price monitoring and catalog export. $1.00 per 1,000 products.", "version": "0.1", "x-build-id": "VVkGo99YAKdx8zAXz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/offgrid-labs~shopify-store-products/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-offgrid-labs-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/offgrid-labs~shopify-store-products/runs": { "post": { "operationId": "runs-sync-offgrid-labs-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/offgrid-labs~shopify-store-products/run-sync": { "post": { "operationId": "run-sync-offgrid-labs-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": "Shopify store URLs", "type": "array", "description": "Required. Shopify stores to scrape, one per line. Accepts a bare domain (allbirds.com), a homepage URL (https://www.deathwishcoffee.com) or a collection URL (https://store.com/collections/sale - scrapes only that collection). Sites that are not Shopify are skipped and not charged.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of products saved per store (or per store + collection). One product = one dataset row with all its variants = one charged result. Default 1000; range 1-100000. Example: 500", "default": 1000 }, "collections": { "title": "Collections (handles)", "type": "array", "description": "Optional. Only scrape these collection handles in every store: the part after /collections/ in the URL. Leave empty to scrape the whole catalog. Examples: sale, new-arrivals, mens", "items": { "type": "string" } }, "keyword": { "title": "Keyword filter", "type": "string", "description": "Optional. Keep only products whose title, vendor, product type or tags contain this text (case-insensitive substring). Filtered-out products are not charged. Example: hoodie" }, "onlyAvailable": { "title": "Only in-stock products", "type": "boolean", "description": "If true, keep only products with at least one variant available for sale. Default false (all products, in stock or not).", "default": false }, "includeDescription": { "title": "Include description text", "type": "boolean", "description": "If true (default), adds the product description converted to plain text in the description field. Set false for smaller datasets.", "default": true }, "includeInventory": { "title": "Include stock quantities (extra event)", "type": "boolean", "description": "Optional, default false. Adds inventoryQuantity per variant and totalInventory per product when the store publishes stock counts in its public product data (/products/.js; many stores do, some don't). One extra request per product. Charged as an extra inventory event ($1.00 per 1,000) only for products where counts were found.", "default": false }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "If true (default, recommended), skips stores whose robots.txt disallows /products.json. Skipped stores are not charged.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Usually not needed (default: no proxy). Enable Apify Proxy only if a store keeps answering HTTP 429 (rate limited) for large catalogs.", "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 } } } } } } } } } }