{ "openapi": "3.0.1", "info": { "title": "Shopify Variant Image Association Audit", "description": "Read-only audit of Shopify catalog snapshots: broken variant-image links, duplicate IDs and SKUs, missing alt text, and drift between two exports. Returns SKU-linked corrections.", "version": "0.1", "x-build-id": "wGY11P0gd5ZXtpgQ3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/practical_ai_lab_jp~pal-shopify-variant-image-association-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-practical_ai_lab_jp-pal-shopify-variant-image-association-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/practical_ai_lab_jp~pal-shopify-variant-image-association-audit/runs": { "post": { "operationId": "runs-sync-practical_ai_lab_jp-pal-shopify-variant-image-association-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/practical_ai_lab_jp~pal-shopify-variant-image-association-audit/run-sync": { "post": { "operationId": "run-sync-practical_ai_lab_jp-pal-shopify-variant-image-association-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", "properties": { "currentProducts": { "title": "Current snapshot (products array)", "type": "array", "description": "Products in Shopify products.json shape (id, handle, title, variants[], images[]). Use this for exports you are authorized to audit. Leave empty if you use a URL." }, "currentSnapshotUrl": { "title": "Current snapshot (public products.json URL)", "type": "string", "description": "HTTPS URL of a public Shopify feed, for example https://store.example.com/products.json or https://store.example.com/collections/sale/products.json. Only audit stores you own or are authorized to review. robots.txt is checked first." }, "baselineProducts": { "title": "Baseline snapshot (products array, optional)", "type": "array", "description": "An earlier export in the same shape. When provided, the Actor reports drift in SKUs, variant-image links and alt text." }, "baselineSnapshotUrl": { "title": "Baseline snapshot (public products.json URL, optional)", "type": "string", "description": "Public HTTPS feed URL of an earlier or alternative catalog to compare against. Rarely useful for live stores, since a live feed shows only the current state." }, "checkAltText": { "title": "Check alt text", "type": "boolean", "description": "Report missing, over-long and filename-like image alt text.", "default": true }, "maxAltLength": { "title": "Maximum alt text length", "minimum": 50, "maximum": 2000, "type": "integer", "description": "Alt text longer than this is flagged.", "default": 512 }, "flagVariantsWithoutImage": { "title": "Flag variants without an image", "type": "boolean", "description": "Report variants of multi-variant products that have no image assigned. Off by default because many stores intentionally share one image.", "default": false }, "maxProducts": { "title": "Maximum products per snapshot", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Upper bound on products read from each snapshot.", "default": 2000 }, "maxPages": { "title": "Maximum pages per URL snapshot", "minimum": 1, "maximum": 80, "type": "integer", "description": "Each page holds up to 250 products. Applies to URL snapshots only.", "default": 10 }, "requestDelaySecs": { "title": "Delay between requests (seconds)", "minimum": 0.5, "maximum": 10, "type": "number", "description": "Pause between page requests to a store. Minimum 0.5.", "default": 1 }, "maxFindings": { "title": "Maximum findings returned", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Findings are sorted by severity before this cap is applied. The summary reports the uncapped total.", "default": 5000 } } }, "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 } } } } } } } } } }