{ "openapi": "3.0.1", "info": { "title": "Shopify Products Scraper | Variants & Inventory", "description": "Export Shopify products, variants, prices, images and publicly exposed inventory from known stores. Includes coverage summaries. $1 per 1,000 products plus platform usage. Independent third-party tool.", "version": "0.1", "x-build-id": "OpZf7vuFlIXz4oQQO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/peerless_columbine~shopify-products-inventory-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-peerless_columbine-shopify-products-inventory-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/peerless_columbine~shopify-products-inventory-scraper/runs": { "post": { "operationId": "runs-sync-peerless_columbine-shopify-products-inventory-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/peerless_columbine~shopify-products-inventory-scraper/run-sync": { "post": { "operationId": "run-sync-peerless_columbine-shopify-products-inventory-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": [ "domains" ], "properties": { "domains": { "title": "Store domains", "maxItems": 100, "type": "array", "description": "Stores to read. Bare hosts and HTTP(S) URLs are accepted; paths are ignored. An empty list uses deathwishcoffee.com. This input does not discover stores.", "items": { "type": "string", "minLength": 1 } }, "maxProducts": { "title": "Maximum products per store", "minimum": 0, "maximum": 2147483647, "type": "integer", "description": "0 reads the complete available catalogue until an empty page, a documented source limit, or a safety/time/budget stop. Positive values cap stored products separately for each store.", "default": 0 }, "includeInventoryDetails": { "title": "Read public inventory and product details", "type": "boolean", "description": "Read public product JSON, Ajax JSON and HTML for source-exposed quantities, barcode, policies, subscriptions, metadata and structured brand. No cart mutation or quantity probing. Unavailable fields are omitted.", "default": false }, "proxyConfiguration": { "title": "Optional proxy", "type": "object", "description": "The Console trial and automatic test prefill use Apify RESIDENTIAL proxy, which incurs separate proxy usage costs. If omitted in JSON, proxy remains disabled. Apify proxy settings or user-supplied HTTP CONNECT proxyUrls route requests. Direct cloud requests can receive HTTP 429. HTTPS-scheme and SOCKS proxies are not supported; configuration failures are explicit.", "default": { "useApifyProxy": false } }, "datasetId": { "title": "Existing dataset ID for a copy", "pattern": "^([A-Za-z0-9]{17})?$", "type": "string", "description": "Optional existing dataset receives each stored product in addition to the default dataset. Read/write access is requested only for the selected dataset. Leave unselected or empty to use only the default dataset. Failure to verify it stops setup; append failures stop with partial status." }, "runId": { "title": "Parent run ID", "pattern": "^([A-Za-z0-9]{17})?$", "type": "string", "description": "Optional 17-character ID copied verbatim onto each product. Omitted from output when empty." }, "locale": { "title": "Optional locale route", "pattern": "^([a-z]{2,3}(-[a-zA-Z]{2})?)?$", "type": "string", "description": "Explicit locale prefix such as fr or en-gb. Store must expose that route. Domain paths are otherwise ignored. Currency is observed, never converted.", "default": "" }, "pageSize": { "title": "Products requested per page", "minimum": 1, "maximum": 250, "type": "integer", "description": "Pagination batch size, not a total result limit. The same size is used on every page.", "default": 250 }, "maxPagesPerStore": { "title": "Pagination safety ceiling", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Emergency stop. Reaching this limit sets partial status and never claims a complete catalogue.", "default": 10000 }, "requestTimeoutSecs": { "title": "Request timeout in seconds", "minimum": 5, "maximum": 120, "type": "integer", "description": "Finite timeout per request attempt.", "default": 25 }, "maxRetries": { "title": "Transient retries", "minimum": 0, "maximum": 4, "type": "integer", "description": "Retry transient network failures, 429 and selected 5xx responses. Access denial is not retried or bypassed.", "default": 2 }, "requestIntervalSecs": { "title": "Minimum seconds between source requests", "minimum": 0.2, "maximum": 10, "type": "number", "description": "Sequential requests with this minimum start interval; no concurrent store crawling.", "default": 0.5 }, "maxRunSeconds": { "title": "Graceful runtime ceiling", "minimum": 10, "maximum": 86400, "type": "integer", "description": "Stops collection and records incomplete progress in SUMMARY. Set below the platform timeout to leave time for final storage.", "default": 3300 } } }, "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 } } } } } } } } } }