{ "openapi": "3.0.1", "info": { "title": "Shopify Store Analyzer", "description": "Analyze any Shopify store from just its URL: detect the theme it runs, export the full product catalogue with prices and variants, list newly added products, and track price, stock and catalogue changes between runs. No login or API key needed.", "version": "0.0", "x-build-id": "VwNWDyjA7KFpVeuO0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fanndev~shopify-store-analyzer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fanndev-shopify-store-analyzer", "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/fanndev~shopify-store-analyzer/runs": { "post": { "operationId": "runs-sync-fanndev-shopify-store-analyzer", "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/fanndev~shopify-store-analyzer/run-sync": { "post": { "operationId": "run-sync-fanndev-shopify-store-analyzer", "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", "storeUrls" ], "properties": { "mode": { "title": "Mode", "enum": [ "store-analysis", "products", "new-products", "changes", "collections", "detect" ], "type": "string", "description": "What to do with each store URL. Store analysis is the all-in-one overview. Products exports the whole catalogue. New products lists only recent arrivals. Changes compares against your previous run. Collections exports the collection list. Detect just checks whether a site is Shopify and which theme it runs -- fast and cheap for qualifying many domains.", "default": "store-analysis" }, "storeUrls": { "title": "Shopify store URLs", "type": "array", "description": "One or more store URLs. A domain on its own works too (allbirds.com). You can also paste a myshopify.com address directly.", "items": { "type": "string" } }, "maxProducts": { "title": "Max products per store", "minimum": 0, "type": "integer", "description": "Caps how many products are read per store. Leave empty or set 0 for the whole catalogue. Large stores can hold thousands of products, so set a limit when you only need a sample.", "default": 1000 }, "newWithinDays": { "title": "New within (days)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "New products mode only. How far back counts as 'new', based on when the product went live in the store.", "default": 7 }, "newestProducts": { "title": "Newest products to include", "minimum": 0, "maximum": 250, "type": "integer", "description": "Store analysis mode only. How many of the most recently published products to return alongside the store profile.", "default": 10 }, "explodeVariants": { "title": "One row per variant", "type": "boolean", "description": "Products mode only. In addition to one row per product (with variants nested), also emit a flat row for every single variant -- easier to open in a spreadsheet.", "default": false }, "maxConcurrency": { "title": "Max concurrent stores", "minimum": 1, "maximum": 16, "type": "integer", "description": "How many stores to analyse in parallel.", "default": 4 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Shopify's public store data needs no proxy and the actor runs fine without one. Use a country-specific proxy if a store shows different storefronts per region.", "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 } } } } } } } } } }