{ "openapi": "3.0.1", "info": { "title": "Shopify Product Scraper - CSV & Excel Export", "description": "Scrape public Shopify stores, collections and product URLs into CSV, Excel, JSON and ZIP. Export variants, SKUs, prices, availability and image URLs, with coverage reports and supplier CSV parts. No Shopify login or Admin API key required.", "version": "0.1", "x-build-id": "e0ftfAFl8kPMctqGK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/whoareyouanas~shopify-website-product-catalogue/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-whoareyouanas-shopify-website-product-catalogue", "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/whoareyouanas~shopify-website-product-catalogue/runs": { "post": { "operationId": "runs-sync-whoareyouanas-shopify-website-product-catalogue", "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/whoareyouanas~shopify-website-product-catalogue/run-sync": { "post": { "operationId": "run-sync-whoareyouanas-shopify-website-product-catalogue", "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": [ "startUrls" ], "properties": { "startUrls": { "title": "Store, collection or product URLs", "minItems": 1, "maxItems": 100, "type": "array", "description": "Public HTTPS Shopify roots, collections or product URLs. Locale prefixes are preserved. Unsupported filters are rejected rather than widened to a full-store capture.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxProductsPerTarget": { "title": "Maximum products per URL", "minimum": 0, "maximum": 25000, "type": "integer", "description": "0 removes this user cap; global, page, byte, variant and time bounds still apply. A capped result is marked partial.", "default": 1000 }, "maxProducts": { "title": "Maximum unique products for the run", "minimum": 1, "maximum": 25000, "type": "integer", "description": "Global product limit. Overlapping scopes in the same observed store/locale context count once. Apify's maximum charge per run also applies.", "default": 10000 }, "exportFormats": { "title": "Export files", "type": "array", "description": "Choose csv, xlsx, json and/or zip. ZIP includes the standard formats. XLSX includes normalized JSON for full text exceeding Excel cell limits. The product dataset and coverage manifest are always available.", "default": [ "csv", "xlsx", "json", "zip" ] }, "currencyOverrides": { "title": "Confirmed source price currencies", "type": "array", "description": "Optional operator assertions: [{\"storeUrl\":\"https://supplier.example\",\"localePrefix\":\"\",\"currency\":\"CAD\"}]. Does not convert prices or verify currency. Without an assertion, feed currency stays unknown.", "default": [] }, "saveSourceResponses": { "title": "Save source responses for auditing", "type": "boolean", "description": "Save the exact accepted feed response text in the run's key-value store. Manifest observations link each response and its hash, allowing export reconciliation even when a live catalogue changes. Adds storage usage; disabled by default.", "default": false }, "maxConcurrency": { "title": "Parallel stores", "minimum": 1, "maximum": 10, "type": "integer", "description": "Different store contexts run concurrently; targets within a context are processed sequentially.", "default": 3 }, "requestIntervalMs": { "title": "Request interval per store (milliseconds)", "minimum": 500, "maximum": 60000, "type": "integer", "description": "Minimum pause between requests to a store context. Persistent throttling is reported explicitly.", "default": 1000 } } }, "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 } } } } } } } } } }