{ "openapi": "3.0.1", "info": { "title": "Shopify Products Scraper — Barcode GTIN, Variants & Prices", "description": "Full product catalogs from any Shopify store: one row per product with every variant's barcode (GTIN/EAN/UPC), SKU, price, currency, availability and stock where exposed. Custom domains and headless stores resolved automatically. Measured barcode fill: 94.1% of variants across 6 stores.", "version": "0.1", "x-build-id": "9u6S4pvn4hEMewTwE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapersdelight~shopify-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapersdelight-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/scrapersdelight~shopify-products-scraper/runs": { "post": { "operationId": "runs-sync-scrapersdelight-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/scrapersdelight~shopify-products-scraper/run-sync": { "post": { "operationId": "run-sync-scrapersdelight-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", "required": [ "storeUrls" ], "properties": { "storeUrls": { "title": "Store domains", "type": "array", "description": "One Shopify store per line. Measured on the shipped defaults: barcode on 94.1% of variants, currency on 100%, SKU on 100%. A store that turns out to be password-protected or not on Shopify is reported in the log and skipped — it never bills anything.", "default": [ "allbirds.com", "colourpop.com" ], "items": { "type": "string" } }, "enrichVariants": { "title": "Fetch barcodes, currency & stock per variant", "type": "boolean", "description": "ON (default): one extra request per product fills barcode, currency, weight, inventory policy and inventory quantity per variant. OFF: feed-only mode — roughly half the requests and runtime, but barcode/currency/stock stay null on every row. Price per product is identical either way.", "default": true }, "onlyWithBarcode": { "title": "Only products that carry a barcode", "type": "boolean", "description": "Keep only products where at least one variant has a barcode/GTIN. Measured across 6 stores: 85.6% of products pass. Products dropped by this filter are never billed. Requires the enrichment toggle above to stay on.", "default": false }, "onlyAvailable": { "title": "Only products in stock", "type": "boolean", "description": "Keep only products with at least one purchasable variant. Applied from the catalog feed BEFORE the enrichment request is spent, so filtered products cost nothing and are never billed.", "default": false }, "maxItems": { "title": "Max products (total)", "minimum": 1, "type": "integer", "description": "Hard cap on products returned across all stores, and therefore your cost ceiling: 300 = $0.30, 1,000 = $1, 25,000 (the biggest single catalog the public feed can serve) = $25.", "default": 300 }, "maxItemsPerStore": { "title": "Max products per store", "minimum": 0, "type": "integer", "description": "Per-store cap so one huge catalog cannot eat the whole run. 0 = no per-store cap. The shipped default (150) with two stores gives a balanced 300-row sample.", "default": 0 }, "maxConcurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel requests within one store (stores are processed in order). Measured 30/30 = 100% sustained at concurrency 5 through the Apify proxy; going past 10 buys little and leans on the stores harder.", "default": 5 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy by default — Shopify is not walled (measured 100% sustained through the cheap rung), so you are not paying for residential IPs you do not need. ONE thing the proxy country changes: Shopify Markets localizes price AND currency by exit-IP country (the same catalog priced CAD from Canada, USD from the US). Pin a country here if you need one consistent currency; every variant row also carries its own currency field.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }