{ "openapi": "3.0.1", "info": { "title": "Shopify Scraper: Products, Prices, Stock | $0.50 per 1,000", "description": "Scrape products from any Shopify store: prices, compare-at price and discount, stock per variant, SKU, barcode, options, images, tags and the store's currency. Give store, collection or product links; one row per product or per variant, with keyword, stock and sale filters.", "version": "0.2", "x-build-id": "t6WTcHhZrnE6rJqdN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/v0iddo~shopify-store-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-v0iddo-shopify-store-intelligence", "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/v0iddo~shopify-store-intelligence/runs": { "post": { "operationId": "runs-sync-v0iddo-shopify-store-intelligence", "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/v0iddo~shopify-store-intelligence/run-sync": { "post": { "operationId": "run-sync-v0iddo-shopify-store-intelligence", "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, collections or products", "type": "array", "description": "Shopify store domains or links. A store (gymshark.com, https://www.allbirds.com) gives its whole catalog, a collection link (https://kith.com/collections/footwear) gives that collection, a product link (https://kith.com/products/handle) gives that product with its barcodes. Links that are not Shopify stores are skipped with the reason in OUTPUT.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 37500, "type": "integer", "description": "Products kept from each store, collection or product link (after the filters below). The feed gives 250 products per request; Shopify stops at about page 150, so the ceiling is about 37,500 products a store.", "default": 5000 }, "rowMode": { "title": "Row granularity", "enum": [ "per_product", "per_variant" ], "type": "string", "description": "\"per_product\" (default) gives one row per product with its variants nested. \"per_variant\" gives one row per variant (SKU) with its own price, discount, stock, barcode and link: more rows, easier for spreadsheet joins. You pay per product either way.", "default": "per_product" }, "keywords": { "title": "Keywords", "type": "array", "description": "Keep products whose title, product type, vendor or tags contain one of these words (any case). Leave empty for every product.", "items": { "type": "string" } }, "onlyAvailable": { "title": "Only in stock", "type": "boolean", "description": "Keep products that can be bought now (with \"per_variant\", the variants that can).", "default": false }, "onlyOnSale": { "title": "Only on sale", "type": "boolean", "description": "Keep products priced under their compare-at price (with \"per_variant\", the variants that are).", "default": false }, "includeDescription": { "title": "Include descriptions as plain text", "type": "boolean", "description": "Adds each product's description as plain text (up to 5,000 characters, e-mail addresses and phone numbers removed).", "default": true }, "includeCollections": { "title": "Include collections snapshot", "type": "boolean", "description": "Also reads /collections.json: collection title, handle and product count go to the store summary in OUTPUT.", "default": true }, "includeBodyHtml": { "title": "Include product body HTML", "type": "boolean", "description": "Adds the description HTML exactly as the store publishes it (bodyHtml), roughly 2 to 10 KB per product.", "default": false }, "detectStack": { "title": "Detect installed apps and tech stack", "type": "boolean", "description": "Reads the store's home page once and lists the apps it finds (Recharge, Loox, Klaviyo, Yotpo, Judge.me and more) by category (subscriptions, reviews, email, chat, loyalty, pixels) in the store summary. One extra request per store, no extra charge.", "default": 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 } } } } } } } } } }