{ "openapi": "3.0.1", "info": { "title": "Shopify Store Catalog & Pricing Extractor", "description": "Extract a Shopify store's product catalog with titles, prices, compare-at prices, variants, SKUs, images and stock availability from any custom or myshopify.com domain.", "version": "2.0", "x-build-id": "rfdRrnEMOeqFiOPHE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nimbryxo-studio~shopify-store-catalog-and-pricing-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nimbryxo-studio-shopify-store-catalog-and-pricing-extractor", "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/nimbryxo-studio~shopify-store-catalog-and-pricing-extractor/runs": { "post": { "operationId": "runs-sync-nimbryxo-studio-shopify-store-catalog-and-pricing-extractor", "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/nimbryxo-studio~shopify-store-catalog-and-pricing-extractor/run-sync": { "post": { "operationId": "run-sync-nimbryxo-studio-shopify-store-catalog-and-pricing-extractor", "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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "catalog", "collection", "product", "search", "collections", "auto" ], "type": "string", "description": "What to scrape. `catalog` walks the public product feed, `collection` walks specific collections, `product` fetches exact product handles, `search` uses the storefront search suggestions, `collections` lists collection metadata, and `auto` detects the type of each URL in `startUrls`.", "default": "catalog" }, "storeUrls": { "title": "Shopify store URLs", "type": "array", "description": "Store domains or URLs, e.g. `deathwishcoffee.com` or `https://www.allbirds.com`. Accepts custom domains and `*.myshopify.com`. A product or collection URL is reduced to its store for catalog/collections/search modes.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs (mixed, optional)", "type": "array", "description": "Store, collection or product URLs. In `auto` mode each URL selects its own job: `/products/` fetches one product, `/collections/` fetches a collection, any other store URL fetches the catalog. In the other modes these URLs add stores and, for collection/product modes, their handles.", "default": [], "items": { "type": "string" } }, "collectionHandles": { "title": "Collection handles (mode=collection)", "type": "array", "description": "Collection handles or collection URLs, e.g. `new-arrivals`, `sale`, or `https://store.com/collections/sale`. Handles are applied to every store in `storeUrls`; a full collection URL is applied to its own store.", "default": [], "items": { "type": "string" } }, "productHandles": { "title": "Product handles (mode=product)", "type": "array", "description": "Product handles or product URLs, e.g. `dark-roast-coffee` or `https://store.com/products/dark-roast-coffee`. Handles are applied to every store in `storeUrls`; a full product URL is applied to its own store.", "default": [], "items": { "type": "string" } }, "searchQuery": { "title": "Search query (mode=search)", "type": "string", "description": "In-store search term. Shopify's public suggest endpoint returns at most 10 products per store and has no pagination." }, "currency": { "title": "Currency", "type": "string", "description": "ISO 4217 code to pin prices to, e.g. `USD`, `EUR`, `GBP`. Use `store` to use the store's base currency from `/meta.json`. Pinning is important because Shopify localizes prices by IP.", "default": "store" }, "country": { "title": "Country (optional)", "type": "string", "description": "Two-letter ISO country code passed as `?country=` to the storefront, e.g. `US`, `GB`, `DE`." }, "vendor": { "title": "Vendor contains", "type": "string", "description": "Keep products whose vendor contains this text (case-insensitive)." }, "productType": { "title": "Product type contains", "type": "string", "description": "Keep products whose product type contains this text (case-insensitive)." }, "tag": { "title": "Tag contains", "type": "string", "description": "Keep products with at least one tag containing this text (case-insensitive)." }, "minPrice": { "title": "Minimum price", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Drop products whose lowest variant price is below this value." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Drop products whose lowest variant price is above this value." }, "available": { "title": "Availability", "enum": [ "any", "available", "unavailable" ], "type": "string", "description": "Keep all products, only products with at least one purchasable variant, or only sold-out products.", "default": "any" }, "maxItems": { "title": "Max records", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Hard cap on dataset rows across all stores. When `flattenVariants` is on, each variant row counts as one.", "default": 1000 }, "maxPages": { "title": "Max pages per feed", "minimum": 1, "maximum": 100, "type": "integer", "description": "Page cap per product/collection feed. Each page holds up to 250 items and Shopify refuses offsets above 25,000, so the effective maximum is 100.", "default": 100 }, "includeDetails": { "title": "Include barcode, weight and inventory", "type": "boolean", "description": "Fetch `/products/{handle}.json` for each emitted product to add barcode, weight/grams and inventory fields. Costs one extra request per product and is off by default. Product mode always uses the detail endpoint.", "default": false }, "flattenVariants": { "title": "One row per variant", "type": "boolean", "description": "Emit one `recordType: variant` row per variant instead of one product row with nested variants. Variant and product IDs are de-duplicated.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration (optional)", "type": "object", "description": "Leave empty to fetch directly. After a 403 or 429 block the actor retries through Apify's datacenter proxy (AUTO) automatically. If you set this, your configuration is used for that retry instead of AUTO; direct requests are still tried first." } } }, "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 } } } } } } } } } }