{ "openapi": "3.0.1", "info": { "title": "Shopify Store Intelligence — Catalog + Pricing", "description": "Snapshot any Shopify storefront's full public catalog. One row per product with title, vendor, type, tags, all variants (SKU, price, compare_at_price, available), images. Skips non-Shopify domains gracefully. Source: /products.json + /collections.json (public, no auth).", "version": "0.2", "x-build-id": "OZmN8PBZkqa7uGv4l" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/v0iddo~shopify-store-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-v0iddo-shopify-store-intelligence", "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/v0iddo~shopify-store-intelligence/runs": { "post": { "operationId": "runs-sync-v0iddo-shopify-store-intelligence", "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/v0iddo~shopify-store-intelligence/run-sync": { "post": { "operationId": "run-sync-v0iddo-shopify-store-intelligence", "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": [ "stores" ], "properties": { "stores": { "title": "Store domains / URLs", "type": "array", "description": "Storefront URLs or bare domains. Examples: \"gymshark.com\", \"https://allbirds.com\", \"shop.example.com\". The actor probes /products.json; non-Shopify URLs are skipped with a note in the output.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Max products per store", "minimum": 1, "maximum": 37500, "type": "integer", "description": "Hard cap per store. Each page returns up to 250 products; the actor paginates until empty or this cap is reached. Shopify's public storefront API enforces an upper page index ~150, so true cap is ~37500.", "default": 5000 }, "includeCollections": { "title": "Include collections snapshot", "type": "boolean", "description": "Also pull /collections.json. Adds collection metadata (title, handle, products_count) to the store summary in OUTPUT.", "default": true }, "rowMode": { "title": "Row granularity", "enum": [ "per_product", "per_variant" ], "type": "string", "description": "\"per_product\" (default) emits one row per product with all variants nested. \"per_variant\" emits one row per SKU — more rows, easier for spreadsheet joins.", "default": "per_product" }, "includeBodyHtml": { "title": "Include product body HTML", "type": "boolean", "description": "Adds the long-form product description HTML to each row. Roughly 2-10 KB per product. Off by default to keep dataset compact.", "default": false }, "detectStack": { "title": "Detect installed apps + tech stack", "type": "boolean", "description": "Fetch the store homepage and detect installed apps (Recharge, Loox, Klaviyo, Yotpo, Judge.me, …) plus tech-stack categories (subscriptions, reviews, email, chat, loyalty, pixels). Adds `installedApps` and `techStack` fields to the per-store summary. One extra HTTP request per store, no billing impact.", "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 } } }, "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 } } } } } } } } } }