{ "openapi": "3.0.1", "info": { "title": "Shopify Products API & Scraper", "description": "Shopify products API: exports the whole public catalog of a Shopify store (title, vendor, tags, price range, discount, currency, stock flag and more) over REST. Filter by vendor, type, tag, keyword, stock or update date before billing. JSON, CSV or Excel. $0.50 per 1,000 products, no subscription.", "version": "0.1", "x-build-id": "SVUBmkGD8fBMSm5zI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rocketyard~shopify-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rocketyard-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/rocketyard~shopify-products-scraper/runs": { "post": { "operationId": "runs-sync-rocketyard-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/rocketyard~shopify-products-scraper/run-sync": { "post": { "operationId": "run-sync-rocketyard-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, collection or product URLs", "type": "array", "description": "Store URLs read the whole catalog. A collection URL (…/collections/sale) reads that collection. A product URL (…/products/some-handle) returns that product. Leave empty if you use Store domains.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "stores": { "title": "Store domains", "type": "array", "description": "Store domains such as \"muji.us\", as an alternative to URLs. Each one reads the whole catalog.", "items": { "type": "string" } }, "recordType": { "title": "One record per", "enum": [ "product", "variant" ], "type": "string", "description": "Product (default) keeps all variants in one record, in the `variants` list. Variant gives one flat row per variant, which suits spreadsheets and price tracking. Each stored record is one paid result.", "default": "product" }, "keyword": { "title": "Keyword", "type": "string", "description": "Keep products with this word in the title, tags, vendor, type, handle, variant title or SKU. Separate alternatives with commas." }, "vendor": { "title": "Vendor", "type": "string", "description": "Keep products whose vendor contains this text. Separate alternatives with commas." }, "productType": { "title": "Product type", "type": "string", "description": "Keep products whose type contains this text. Separate alternatives with commas." }, "tag": { "title": "Tag", "type": "string", "description": "Keep products with exactly this tag (any capitalization). Separate alternatives with commas." }, "inStockOnly": { "title": "In stock only", "type": "boolean", "description": "Keep only products with a variant that can be bought. For variant records, keep only the variants that can be bought.", "default": false }, "updatedSince": { "title": "Updated since", "type": "string", "description": "Keep products changed since this date, such as \"2026-10-01\", or within this age, such as \"7 days\". On a schedule, this returns only what changed." }, "country": { "title": "Market country", "type": "string", "description": "Two-letter code such as \"US\" or \"DE\": read each store as shoppers in that country see it, with that market's prices, currency and availability. Without it, stores answer for the location of the run. Stores without that market answer for their default, and every record says its currency." }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop after this many records in total, over all stores. This also caps the cost of the run.", "default": 10000 }, "maxItemsPerStore": { "title": "Max results per store", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop reading a store or collection after this many records. Leave empty for its whole catalog." }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Stores read in parallel. Without a proxy, a run still sends one request per second overall, because Shopify rate-limits clients that read faster.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify Proxy for ordinary routing. A proxy changes the location a store sees, which can change the market it answers for. It is not a way around a store that refuses access." } } }, "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 } } } } } } } } } }