{ "openapi": "3.0.1", "info": { "title": "Shopify Products Scraper & API: $1 per 1,000 rows", "description": "Any Shopify store's products as JSON: prices as numbers, variants, SKUs, stock. Monitor mode returns only price and stock changes. $1 per 1,000 rows.", "version": "0.1", "x-build-id": "SFXklmE6cBdllhx9K" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dododata~shopify-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dododata-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/dododata~shopify-products-scraper/runs": { "post": { "operationId": "runs-sync-dododata-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/dododata~shopify-products-scraper/run-sync": { "post": { "operationId": "run-sync-dododata-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", "properties": { "startUrls": { "title": "Store or collection URLs", "type": "array", "description": "Any Shopify store (https://www.allbirds.com) or one of its collections (https://www.allbirds.com/collections/mens). Any page of the store works. Leave empty to try the Actor on two sample stores.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "rowPer": { "title": "One row per", "enum": [ "product", "variant" ], "type": "string", "description": "Variant mode is the one to use for price and stock monitoring at SKU level. You pay per row.", "default": "product" }, "includeInventory": { "title": "Include stock and barcodes", "type": "boolean", "description": "Read each product a second time to add stock count, barcode and inventory policy per variant, plus a total_inventory roll-up. Costs one extra request per product, so runs are slower. The fields are only filled when the merchant publishes them, and variants the shop does not track stay null instead of reporting Shopify's 999999 placeholder.", "default": false }, "keywords": { "title": "Keywords", "type": "array", "description": "Keep only products whose title, vendor, type or tags contain one of these words. Filtered-out products are not saved and not charged.", "items": { "type": "string" } }, "onlyAvailable": { "title": "Only in stock", "type": "boolean", "description": "Keep only products with at least one variant available to buy.", "default": false }, "onlyOnSale": { "title": "Only on sale", "type": "boolean", "description": "Keep only products priced below their compare-at price.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Turns on price and stock tracking. Pick any name, for example competitor-prices, and use the same name on every run. Each row then says whether it is new, updated or unchanged since the previous run under that name, with the previous price, the change in percent and the previous availability. The first run marks everything as new. State is kept in a key-value store on your own account. Leave empty to switch tracking off." }, "onlyChanges": { "title": "Only changes", "type": "boolean", "description": "Needs a monitor name. Unchanged rows are left out of the results and are not billed. A daily price watch on a 2,000-product shop usually returns a few dozen rows instead of 2,000.", "default": false }, "includeRemoved": { "title": "Report removed products", "type": "boolean", "description": "Needs a monitor name. A product or variant that was in the previous run and is gone from the feed is returned once, with change_status \"removed\", its title, URL, last known price and the dates it was first and last seen. Only reported when the feed was read to its end.", "default": true }, "maxItems": { "title": "Max rows", "minimum": 1, "type": "integer", "description": "Stop after this many rows across all stores. You pay per row, so this is also your budget cap.", "default": 500 }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel requests. 5 is polite and fast enough for most sites.", "default": 5 }, "useProxy": { "title": "Use Apify proxy", "type": "boolean", "description": "Recommended. Turn off only for testing.", "default": 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 } } }, "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 } } } } } } } } } }