{
"openapi": "3.0.1",
"info": {
"title": "Shopify Products Scraper: Full Catalog Export",
"description": "Export full Shopify store catalogs: products, variants, SKUs, prices, compare-at prices, availability and image URLs. Gets past the 25,000-product limit and reports coverage per store.",
"version": "1.0",
"x-build-id": "IxvzG5pbGTpJMam9f"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/openfeeds~shopify-store-products-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-openfeeds-shopify-store-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/openfeeds~shopify-store-products-scraper/runs": {
"post": {
"operationId": "runs-sync-openfeeds-shopify-store-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/openfeeds~shopify-store-products-scraper/run-sync": {
"post": {
"operationId": "run-sync-openfeeds-shopify-store-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": [
"storeUrls"
],
"properties": {
"storeUrls": {
"title": "Shopify store URLs",
"minItems": 1,
"maxItems": 1000,
"type": "array",
"description": "Store domains or URLs, one per line, e.g. www.allbirds.com or https://www.tentree.com. A collection URL (…/collections/mens) exports only that collection. *.myshopify.com domains work too. Product page URLs (…/products/…) are skipped. Up to 1,000 stores per run.",
"items": {
"type": "string"
}
},
"maxProductsPerStore": {
"title": "Max products per store",
"minimum": 1,
"maximum": 200000,
"type": "integer",
"description": "Stop after this many products from each store. You pay per product, so this is also your cost cap. Most stores have fewer than 10,000 products.",
"default": 10000
},
"outputLayout": {
"title": "Output layout",
"enum": [
"products",
"variants"
],
"type": "string",
"description": "One row per product keeps the variants in a nested list. One row per variant gives a flat sheet (SKU, options, price) ready for Excel. Same price per product either way: variant rows are never billed.",
"default": "products"
},
"includeDescriptions": {
"title": "Include product descriptions",
"type": "boolean",
"description": "Adds the merchant's product description as plain text and HTML (e-mail addresses and phone numbers are removed). Off by default to keep exports small.",
"default": false
},
"splitLargeStores": {
"title": "Get past the 25,000-product limit",
"type": "boolean",
"description": "Shopify's product feed stops at 25,000 products. For bigger stores, also read the feed in a second order and then collection by collection, removing duplicates. Takes longer; the store status shows the coverage reached.",
"default": true
},
"splitRequestBudget": {
"title": "Extra requests per large store",
"minimum": 0,
"maximum": 5000,
"type": "integer",
"description": "Upper limit on requests for the collection split of each store above 25,000 products (listing collections and reading their pages). Higher values can raise coverage but take longer.",
"default": 400
},
"strictStores": {
"title": "Strict store check",
"type": "boolean",
"description": "Self-check: fail the run unless every store ends with status OK and at least one product.",
"default": false
}
}
},
"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
}
}
}
}
}
}
}
}
}
}