{
"openapi": "3.0.1",
"info": {
"title": "Shopify Store Scraper ยท Products, Prices & Stock From Any Store",
"description": "Shopify store products scraper to extract full product catalogs, prices, variants, discounts and stock from any Shopify store via public /products.json. Scrape product titles, SKUs, vendors, images, pricing and inventory. Ideal for dropshipping research, price monitoring and e-commerce intelligence.",
"version": "0.1",
"x-build-id": "W5OTZfsJmnYqvSdRR"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/reapx~shopify-store-products-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-reapx-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/reapx~shopify-store-products-scraper/runs": {
"post": {
"operationId": "runs-sync-reapx-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/reapx~shopify-store-products-scraper/run-sync": {
"post": {
"operationId": "run-sync-reapx-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",
"type": "array",
"description": "Domains of the Shopify stores to scrape. A bare domain or a full URL both work - https://gymshark.com, gymshark.com and https://gymshark.com/collections/all are all accepted.",
"items": {
"type": "string"
}
},
"collectionHandles": {
"title": "Collections only (optional)",
"type": "array",
"description": "Limit the scrape to specific collections instead of the whole catalogue. Use the handle from the URL or paste the URL itself - \"sale\", \"new-arrivals\" or https://gymshark.com/collections/sale all work. Leave empty to scrape every product in the store.",
"items": {
"type": "string"
}
},
"maxProductsPerStore": {
"title": "Max products per store",
"minimum": 1,
"maximum": 20000,
"type": "integer",
"description": "Hard cap on how many products each store returns. This is also your cost cap: you are charged once per product returned.
The higher the number, the longer the run takes and the more you are charged, because you pay per row returned.",
"default": 100
},
"sortBy": {
"title": "Sort products by",
"enum": [
"none",
"newest",
"oldest",
"priceAsc",
"priceDesc",
"discountDesc"
],
"type": "string",
"description": "How to pick which products you get when the cap is smaller than the catalogue. \"Feed order\" is the fastest and stops as soon as the cap is met; every other option scans the catalogue first, so it is slower on large stores.
Options: none, newest, oldest, priceAsc, priceDesc, discountDesc.",
"default": "none"
},
"minPrice": {
"title": "Minimum price",
"minimum": 0,
"type": "integer",
"description": "Keep only products whose lowest variant price is at least this much, in the store's own currency."
},
"maxPrice": {
"title": "Maximum price",
"minimum": 0,
"type": "integer",
"description": "Keep only products whose lowest variant price is at most this much, in the store's own currency.
The higher the number, the longer the run takes and the more you are charged, because you pay per row returned."
},
"onSaleOnly": {
"title": "Discounted products only",
"type": "boolean",
"description": "Keep only products where a compare-at price is higher than the current price - the store's own definition of \"on sale\".",
"default": false
},
"minDiscountPercent": {
"title": "Minimum discount %",
"minimum": 1,
"maximum": 99,
"type": "integer",
"description": "Keep only products discounted by at least this percentage off the compare-at price."
},
"inStockOnly": {
"title": "In-stock products only",
"type": "boolean",
"description": "Keep only products with at least one variant the store currently marks as available to buy.",
"default": false
},
"newerThanDays": {
"title": "Published in the last N days",
"minimum": 1,
"maximum": 3650,
"type": "integer",
"description": "Keep only products published to the storefront within this many days - the new-arrivals window.
The higher the number, the longer the run takes and the more you are charged, because you pay per row returned."
},
"vendors": {
"title": "Vendors",
"type": "array",
"description": "Keep only products from these vendors (exact, case-insensitive match on the store's vendor field).
Leave this field empty to include every option.",
"items": {
"type": "string"
}
},
"productTypes": {
"title": "Product types",
"type": "array",
"description": "Keep only products of these types (exact, case-insensitive match on the store's product type field).
Leave this field empty to include every option.",
"items": {
"type": "string"
}
},
"requiredTags": {
"title": "Must have one of these tags",
"type": "array",
"description": "Keep only products carrying at least one of these storefront tags.
Leave this field empty to include every option.",
"items": {
"type": "string"
}
},
"titleKeywords": {
"title": "Title contains one of",
"type": "array",
"description": "Keep only products whose title contains at least one of these words or phrases (case-insensitive).
Leave this field empty to include every option.",
"items": {
"type": "string"
}
},
"includeVariants": {
"title": "Include the full variant list",
"type": "boolean",
"description": "Add a variants array to each row with per-variant id, SKU, price, compare-at price, availability and option values. Off by default to keep rows small.",
"default": false
},
"includeDescription": {
"title": "Include the product description",
"type": "boolean",
"description": "Add the product description as plain text, stripped of HTML and capped at 5,000 characters.",
"default": false
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Optional. Most Shopify storefronts answer fine without a proxy, so this is off by default. Turn it on if a specific store returns 403 or 429 for the datacenter that runs the actor.",
"default": {
"useApifyProxy": 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
}
}
},
"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
}
}
}
}
}
}
}
}
}
}