{ "openapi": "3.0.1", "info": { "title": "Shopify Product Search | Cross-Store SKU Match & CSV", "description": "Search public Shopify product feeds for stores you select, using SKU, vendor, tag and price filters. Export CSV and identify shared SKUs across stores. No global store index, currency conversion or private stock quantity.", "version": "0.1", "x-build-id": "E8mGM6G0Ap45D8Ub6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/practical_ai_lab_jp~pal-shopify-public-product-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-practical_ai_lab_jp-pal-shopify-public-product-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/practical_ai_lab_jp~pal-shopify-public-product-search/runs": { "post": { "operationId": "runs-sync-practical_ai_lab_jp-pal-shopify-public-product-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/practical_ai_lab_jp~pal-shopify-public-product-search/run-sync": { "post": { "operationId": "run-sync-practical_ai_lab_jp-pal-shopify-public-product-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": { "storeUrls": { "title": "Shopify store URLs", "type": "array", "description": "Public https store root URLs or domains (up to 10). Only /products.json is read, and only if robots.txt allows it. Leave empty to search the inline sample data instead. Only use stores whose data you are permitted to collect.", "default": [], "items": { "type": "string" } }, "inlineProducts": { "title": "Inline product data (offline mode)", "type": "array", "description": "Optional list of product objects in Shopify products.json format that you already hold. They are searched with the same filters and no network request is made for them." }, "query": { "title": "Search text", "type": "string", "description": "Words that must all appear in the SKU, title, variant title, vendor, product type, tags or handle (case-insensitive)." }, "skuContains": { "title": "SKU contains", "type": "array", "description": "Keep variants whose SKU contains any of these fragments.", "items": { "type": "string" } }, "skuExact": { "title": "Exact SKUs", "type": "array", "description": "Keep variants whose SKU equals any of these values (case-insensitive).", "items": { "type": "string" } }, "vendors": { "title": "Vendors", "type": "array", "description": "Keep only these vendors (exact, case-insensitive).", "items": { "type": "string" } }, "productTypes": { "title": "Product types", "type": "array", "description": "Keep only these product types (exact, case-insensitive).", "items": { "type": "string" } }, "tags": { "title": "Tags (any)", "type": "array", "description": "Keep products carrying at least one of these tags.", "items": { "type": "string" } }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Variant price lower bound, in the store's own currency." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Variant price upper bound, in the store's own currency." }, "onlyAvailable": { "title": "Only available variants", "type": "boolean", "description": "Keep only variants the feed marks as available.", "default": false }, "granularity": { "title": "Record granularity", "enum": [ "variant", "product" ], "type": "string", "description": "One record per matching variant (best for SKU lists) or one record per matching product.", "default": "variant" }, "maxResults": { "title": "Max records", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on exported records (1-5000). Also the cap on billable records.", "default": 100 }, "maxPagesPerStore": { "title": "Max pages per store", "minimum": 1, "maximum": 20, "type": "integer", "description": "Feed pages of up to 250 products read per store (1-20).", "default": 4 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 500, "maximum": 10000, "type": "integer", "description": "Pause before each feed request. Minimum 500 ms to stay polite.", "default": 1000 }, "writeCsv": { "title": "Write CSV export", "type": "boolean", "description": "Also save EXPORT_CSV to the key-value store.", "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 } } } } } } } } } }