{ "openapi": "3.0.1", "info": { "title": "Shopify Products API & Scraper", "description": "Shopify products scraper and API: enter store addresses and get one row per product with prices, compare-at prices, variants, images and availability from each store's public catalogue. No API key; pay only for saved products. Unofficial: not affiliated with or endorsed by Shopify.", "version": "0.1", "x-build-id": "ii4QM5f8hXgSxWaqO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sourcing-data-studio~shopify-products-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sourcing-data-studio-shopify-products-api", "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/sourcing-data-studio~shopify-products-api/runs": { "post": { "operationId": "runs-sync-sourcing-data-studio-shopify-products-api", "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/sourcing-data-studio~shopify-products-api/run-sync": { "post": { "operationId": "run-sync-sourcing-data-studio-shopify-products-api", "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": "Store URLs", "minItems": 1, "maxItems": 50, "type": "array", "description": "The Shopify stores to read, one address per line, for example https://www.allbirds.com or just www.allbirds.com. Only the host name is used: a path, a query or a port after it is ignored. Between 1 and 50 stores. A store that refuses (answers 401, 403 or shows a password page), has no public catalogue (404) or keeps limiting requests (429) is listed with its state in the RUN_SUMMARY record and no product result is charged for it. Two addresses of the same shop are read once.", "items": { "type": "string" } }, "maxItemsPerStore": { "title": "Maximum products per store", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum number of products to save from each store, in the order of the store's catalogue. A store is read page by page (up to 250 products per page) until this many products are saved or the catalogue ends.", "default": 250 }, "includeVariants": { "title": "Include variants", "type": "boolean", "description": "When on, every row carries the list of variants (size, colour and so on) with price, compare-at price, SKU, availability and weight in grams. Turn it off for smaller rows; the product-level price range, variant count and availability stay.", "default": true }, "maxItems": { "title": "Maximum products in total", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum number of product results to save and pay for in this run, across all stores. The run stops as soon as this many products are saved.", "default": 1000 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy servers used for the requests. The default is no proxy, and that is the right choice for most runs: stores limit requests per IP address, and shared proxy addresses are usually over the limit already, so a store then answers HTTP 429 at once. With a proxy, the whole run uses one address (one proxy session), and a store that refuses or limits requests is never asked again from another address. The address changes only when the connection through the proxy fails.", "default": { "useApifyProxy": false } }, "maxRequestRetries": { "title": "Retries per page", "minimum": 0, "maximum": 6, "type": "integer", "description": "How many times a page that failed with a server error (HTTP 5xx) or a connection error is tried again, with a growing pause. A store that limits requests (HTTP 429) gets the pause it asks for (at most 60 seconds) and is asked again, from the same address, at most twice per run, or fewer times if this number is lower; after that, or when it says x-ratelimit-remaining: 0, it is recorded as rate-limited. Refusals (401, 403, 404) are never retried. Failed pages are never charged.", "default": 3 }, "debugLog": { "title": "Debug log", "type": "boolean", "description": "Print detailed debug messages to the run log.", "default": false }, "feedback": { "title": "Feedback for the developer", "maxLength": 1000, "type": "string", "description": "Optional. Tell us which field or store type you need next, or what went wrong. It is saved with the run summary. Do not include personal data. AI agents may also use this field to report problems." } } }, "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 } } } } } } } } } }