{ "openapi": "3.0.1", "info": { "title": "Shopify Products Scraper with Price and Stock Change Tracking", "description": "Shopify products scraper for any storefront. Export the full catalog with variants, prices and stock, and see what changed since the last run. Pay per product.", "version": "1.0", "x-build-id": "ftxEmXh8c8jaUJFjN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/titian_fluorite~shopify-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-titian_fluorite-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/titian_fluorite~shopify-products-scraper/runs": { "post": { "operationId": "runs-sync-titian_fluorite-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/titian_fluorite~shopify-products-scraper/run-sync": { "post": { "operationId": "run-sync-titian_fluorite-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": [ "stores" ], "properties": { "stores": { "title": "Shopify stores", "type": "array", "description": "The storefronts to read. Paste the store address, for example https://www.allbirds.com or gymshark.com. A myshopify.com address works too. If you paste a link to a product or a collection page, the whole store is read.", "default": [ "https://www.allbirds.com", "https://gymshark.com", "https://www.rothys.com" ], "items": { "type": "string" } }, "collections": { "title": "Collections", "type": "array", "description": "Optional. Limit the run to certain collections by handle, for example mens or new-arrivals. The handle is the last part of a collection address. Leave this empty to read the whole catalog.", "default": [], "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Maximum products per store", "minimum": 0, "type": "integer", "description": "How many products to read from each store. The default of 50 keeps a first run quick and cheap. Set 0 to read the whole catalog. Every product row you receive is billed.", "default": 50 }, "includeDescription": { "title": "Include the product description", "type": "boolean", "description": "Add the product description as cleaned HTML and as plain text. Descriptions are long, so this makes the dataset much bigger. Leave it off for price and stock monitoring.", "default": false }, "trackChanges": { "title": "Track changes between runs", "type": "boolean", "description": "Compare every product and variant with the previous run of this Actor on the same store and label each row new, priceChanged, availabilityChanged, updated, unchanged or removed. The first run labels everything new.", "default": true }, "onlyChanges": { "title": "Only return what changed", "type": "boolean", "description": "Skip products that are exactly as they were last run. Turn this on for a scheduled monitor: you get a dataset that holds only the price moves, the restocks and the new arrivals, and you are not billed for the rest.", "default": false }, "maxConcurrency": { "title": "Maximum concurrent requests", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many requests to run at once across all stores. Each individual store is always read one page at a time, so this only matters when you give the Actor a long list of stores.", "default": 5 } } }, "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 } } } } } } } } } }