{ "openapi": "3.0.1", "info": { "title": "Shopify Store Leads & Contacts API by StoreInspect", "description": "Try five real Shopify store results per account with no StoreInspect data charge. Filter by country, category and apps. Use paid search, domain enrichment and explicitly confirmed contact reveals when you need more.", "version": "0.1", "x-build-id": "a48EdYrWdYntzg8Ch" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/storeinspect~shopify-store-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-storeinspect-shopify-store-search", "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/storeinspect~shopify-store-search/runs": { "post": { "operationId": "runs-sync-storeinspect-shopify-store-search", "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/storeinspect~shopify-store-search/run-sync": { "post": { "operationId": "run-sync-storeinspect-shopify-store-search", "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", "properties": { "mode": { "title": "Mode", "enum": [ "trial_stores", "sample", "search_stores", "enrich_domains", "search_contacts", "reveal_contacts" ], "type": "string", "description": "Trial returns up to 25 real store rows per Apify account for life. Repeating identical trial input replays saved rows. Paid modes require a paid Apify plan; sample is synthetic.", "default": "trial_stores" }, "country": { "title": "Country code", "type": "string", "description": "Two-letter country code, such as US. Blank adds no country filter; an otherwise empty trial searches US stores. Advanced countries takes precedence.", "default": "" }, "category": { "title": "Category", "enum": [ "", "beauty", "fashion", "home", "food", "health", "electronics", "sports", "pets", "jewelry", "baby", "automotive", "other" ], "type": "string", "description": "Advanced categories takes precedence.", "default": "" }, "app": { "title": "App", "type": "string", "description": "An app name, such as Klaviyo. Requires this app. Advanced apps takes precedence, including exclusions.", "default": "" }, "limit": { "title": "Result count", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum rows. Trial is capped at 25 lifetime rows across runs and Standby requests. Paid search charges for returned results.", "default": 5 }, "filters": { "title": "Advanced store filters", "type": "object", "description": "Optional JSON filters for trial_stores or search_stores, or store-side search_contacts filters. Advanced countries, categories and apps replace matching simple controls. See README for supported filters.", "default": {} }, "person": { "title": "Person filters", "type": "object", "description": "Person filters for search_contacts. Example: target founders, owners, ecommerce managers, marketing leaders, or operations roles.", "default": {} }, "domains": { "title": "Domains", "type": "array", "description": "Known Shopify domains to enrich when mode is enrich_domains.", "items": { "type": "string" }, "default": [] }, "contact_ids": { "title": "Contact IDs", "type": "array", "description": "Public StoreInspect contact IDs to reveal when mode is reveal_contacts, e.g. ct_123.", "items": { "type": "string" }, "default": [] }, "confirm_spend_credits": { "title": "Confirm reveal spend", "type": "boolean", "description": "Must be true for reveal_contacts. This prevents accidental contact reveal charges.", "default": false }, "push_data": { "title": "Save results to dataset", "type": "boolean", "description": "When true, response items are saved to the Apify dataset.", "default": 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 }, "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 } } } } } } } } } }