{
"openapi": "3.0.1",
"info": {
"title": "Shopify Products Scraper & AI Shopping Readiness Audit",
"description": "Shopify products scraper and catalog export with a 0-100 AI shopping readiness audit. Every store gets a row explaining its result; can read past Shopify's 25,000-product feed limit and says if the catalogue is complete.",
"version": "0.1",
"x-build-id": "Zhf9eUmkbSTbyzxae"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/yourevenings~shopify-catalogue-audit/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-yourevenings-shopify-catalogue-audit",
"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/yourevenings~shopify-catalogue-audit/runs": {
"post": {
"operationId": "runs-sync-yourevenings-shopify-catalogue-audit",
"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/yourevenings~shopify-catalogue-audit/run-sync": {
"post": {
"operationId": "run-sync-yourevenings-shopify-catalogue-audit",
"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": "Shopify stores (domains or URLs)",
"minItems": 1,
"maxItems": 1000,
"type": "array",
"description": "One store per line: a domain such as beardbrand.com, a store URL such as https://www.example.com/collections/all or a *.myshopify.com address. Paths are ignored; the whole store is read. Sites that aren't Shopify stores, or whose public product feed is closed, return one free status row.",
"default": [
"partakefoods.com",
"drinkolipop.com",
"beardbrand.com"
],
"items": {
"type": "string"
}
},
"includeCatalogueRows": {
"title": "Include catalogue rows (one row per product)",
"type": "boolean",
"description": "Return a row for every product: title, vendor, product type, tags, variant count, price range, availability, SKUs, image count, URL and dates. Turn off if you only want the per-store audit (product rows are charged per row).",
"default": true
},
"includeAudit": {
"title": "Include readiness audit (one row per store)",
"type": "boolean",
"description": "Return one audit row per store with data-quality percentages (missing GTIN/barcode, brand, product type, thin descriptions, duplicate titles, image alt text, SKUs), a 0-100 readiness score and the top issues with example product handles.",
"default": true
},
"maxProductsPerStore": {
"title": "Max products per store",
"minimum": 0,
"maximum": 100000,
"type": "integer",
"description": "Stop after this many products in each store. The audit covers the products scanned. 0 means the whole catalogue (up to 100,000 products per store). Requests are rate-limited to one per second per store, so large catalogues take about 1 second per 250 products through the main feed. Above Shopify's 25,000-product feed limit the rest is read from the public sitemap, collection feeds and product pages, which is much slower: raise the run timeout for very large stores. The audit row's catalogueComplete field says whether the whole catalogue was read.",
"default": 250
},
"readAllProductDetails": {
"title": "Check every variant's barcode and read full product details",
"type": "boolean",
"description": "Off: barcodes, image alt text, weight units and inventory fields are read for the audit sample only (detailSampleSize). On: each product's own public JSON is read too, so the barcode check (missing, invalid or duplicate barcodes) covers every variant of every product read, the GTIN and alt-text checks cover every product, and every row gets barcodes, alt text, weights and inventory fields where the store publishes them. Costs one extra request per product (about 1 second each, more if the store's robots.txt asks for a Crawl-delay), so raise the run timeout for big catalogues; products not reached in time are counted in the note. No extra charge.",
"default": false
},
"detailSampleSize": {
"title": "Products to check for GTIN/barcode and image alt text",
"minimum": 0,
"maximum": 250,
"type": "integer",
"description": "Barcodes and image alt text are only in each product's own JSON, so the Actor fetches that for a sample of products spread evenly across the catalogue and measures GTIN and alt-text gaps on that sample. Each sampled product costs one extra request (about 1 second). 0 turns these two checks off.",
"default": 20
},
"requestTimeoutSecs": {
"title": "Request timeout (seconds)",
"minimum": 5,
"maximum": 60,
"type": "integer",
"description": "Timeout for each request. Failed, rate-limited or timed-out requests are retried up to 3 times with backoff.",
"default": 15
}
}
},
"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
}
}
}
}
}
}
}
}
}
}