{ "openapi": "3.0.1", "info": { "title": "Shopify Scraper: Any Store's Full Product Catalog", "description": "Export the complete catalog of any Shopify store: every product and variant with price, compare-at price, live discount, SKU, stock status, images, tags, vendor and description. Filter by keyword, vendor, type, price range, in-stock or on-sale. Official Shopify endpoint, no key.", "version": "0.1", "x-build-id": "dCmS9BNgWw9awKo5M" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/glitchbound~shopify-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-glitchbound-shopify-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/glitchbound~shopify-scraper/runs": { "post": { "operationId": "runs-sync-glitchbound-shopify-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/glitchbound~shopify-scraper/run-sync": { "post": { "operationId": "run-sync-glitchbound-shopify-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": { "storeUrls": { "title": "Shopify stores", "uniqueItems": true, "type": "array", "description": "Store domains, one per line, e.g. \"allbirds.com\" or \"https://gymshark.com\". Any URL from the store works; only the domain is used.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max rows per store", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Cap on rows returned per store. Counts rows kept after filtering, so filters never make a run come back empty. The form is prefilled with 50 so a first run costs cents; the cap when this field is left out entirely is 1000.", "default": 1000 }, "oneRowPerProduct": { "title": "One row per product", "type": "boolean", "description": "By default you get one row per variant (each size/colour, with its own price and stock). Turn this on to collapse to one row per product with a price range instead.", "default": false }, "keywords": { "title": "Keyword filter", "uniqueItems": true, "type": "array", "description": "Only keep products whose title, type, vendor or tags contain one of these words.", "items": { "type": "string" } }, "vendors": { "title": "Vendor filter", "uniqueItems": true, "type": "array", "description": "Only keep products from these vendors (exact match, case-insensitive).", "items": { "type": "string" } }, "productTypes": { "title": "Product type filter", "uniqueItems": true, "type": "array", "description": "Only keep these product types, e.g. \"Shoes\", \"T-Shirts\" (exact match, case-insensitive).", "items": { "type": "string" } }, "inStockOnly": { "title": "In stock only", "type": "boolean", "description": "Drop sold-out variants.", "default": false }, "onSaleOnly": { "title": "On sale only", "type": "boolean", "description": "Only variants currently discounted below their compare-at price.", "default": false }, "minPrice": { "title": "Min price", "type": "integer", "description": "Only products at or above this price, in the store's own currency." }, "maxPrice": { "title": "Max price", "type": "integer", "description": "Only products at or below this price, in the store's own currency." }, "includeDescription": { "title": "Include description", "type": "boolean", "description": "Include the product description as plain text.", "default": true }, "includeCollections": { "title": "Include collections", "type": "boolean", "description": "Also return the store's collections with product counts, a quick map of how the catalog is organised.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy settings. Shopify blocks datacenter IP ranges outright on this endpoint, so residential proxy is the default and is required for most stores, and changing it will cause HTTP 429 errors.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "maxItems": { "title": "Maximum results (whole run)", "minimum": 0, "type": "integer", "description": "A hard ceiling on rows for the entire run, across every target. The per-target limits above cap each one separately, so fifty targets at twenty each is still a thousand rows; this caps the total. The run stops cleanly when it is reached and nothing beyond that point is fetched or charged. Leave empty for no ceiling." } } }, "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 } } }, "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 } } } } } } } } } }