{ "openapi": "3.0.1", "info": { "title": "Shopify Store Products Scraper - Full Catalog Export", "description": "Export any Shopify store's full product catalog: titles, variants, SKUs, prices, compare-at prices, stock, images, tags. Multi-store batch, collection filter, one-row-per-variant. JSON, CSV, Excel.", "version": "0.1", "x-build-id": "iTyoaXRgyz4BkHlSq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~shopify-store-products-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-shopify-store-products-scraper", "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/scrapers_lat~shopify-store-products-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-shopify-store-products-scraper", "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/scrapers_lat~shopify-store-products-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-shopify-store-products-scraper", "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 Domains / URLs", "type": "array", "description": "One or more Shopify store domains or URLs (bare domain, https URL, or myshopify subdomain). Each store's full public catalog is exported. Example: allbirds.com, https://gymshark.com, mystore.myshopify.com.", "items": { "type": "string" } }, "storeUrl": { "title": "Single Store (alternative)", "type": "string", "description": "A single Shopify store domain/URL. Use this or Store Domains above." }, "collection": { "title": "Collection Handle (optional)", "type": "string", "description": "Limit the export to a single collection by its handle, e.g. \"mens\" or \"sale\". Applies to every store. Leave empty to export the whole catalog." }, "productType": { "title": "Product Type Filter (optional)", "type": "string", "description": "Only keep products whose product_type exactly matches this value (case-insensitive), e.g. \"Shoes\"." }, "vendor": { "title": "Vendor Filter (optional)", "type": "string", "description": "Only keep products whose vendor exactly matches this value (case-insensitive)." }, "oneRowPerVariant": { "title": "One Row Per Variant", "type": "boolean", "description": "Off (default) = one row per product with a nested variants array. On = one row PER VARIANT (variantId, SKU, price, compare-at price, availability, option values) - ideal for price/stock monitoring.", "default": false }, "maxProductsPerStore": { "title": "Max Products Per Store", "type": "integer", "description": "Maximum number of products to capture from each store. Leave empty for the whole catalog." }, "maxProducts": { "title": "Max Products (all stores)", "type": "integer", "description": "Maximum number of products to capture across all stores combined. Leave empty for no limit. Free Apify plans are capped at 10 output rows." }, "withStoreProfile": { "title": "Add store profile (paid add-on)", "type": "boolean", "description": "Off by default. When on, fetches each store's public meta.json once per store to add store-level context the product feed lacks, INCLUDING the store CURRENCY, plus store name, country, city, myshopify domain, and product/collection counts. Emitted as one extra store_profile record per store. Billed $0.012 per store, only when usable data is returned. Disabled for free users.", "default": false }, "withAiTags": { "title": "Add AI tags and attributes (paid AI add-on)", "type": "boolean", "description": "Off by default. When on, uses AI (OpenRouter, gpt-4o-mini) to produce structured buyer-search tags per product: category, subCategory, material, targetAudience, and 5-8 SEO keywords. One model call per product. Billed $0.012 per product, only on usable AI output. Disabled for free users.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Defaults to Apify Residential proxy because many Shopify stores return 403 to datacenter IPs. You can override with your own selection.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }