{ "openapi": "3.0.1", "info": { "title": "E-Com Checkout Auditor", "description": "Checkout monitoring Actor for Shopify-first e-commerce stores using Playwright and deterministic heuristics.", "version": "0.1", "x-build-id": "nTu6JieiRBIOMcaQO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solutionssmart~e-com-checkout-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solutionssmart-e-com-checkout-auditor", "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/solutionssmart~e-com-checkout-auditor/runs": { "post": { "operationId": "runs-sync-solutionssmart-e-com-checkout-auditor", "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/solutionssmart~e-com-checkout-auditor/run-sync": { "post": { "operationId": "run-sync-solutionssmart-e-com-checkout-auditor", "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": [ "target_url" ], "properties": { "target_url": { "title": "Store URL", "type": "string", "description": "Required. Shopify homepage, collection, or product page. Paste a product URL to skip browsing and go straight to Add to Cart." }, "coupon_code": { "title": "Coupon / promo code (optional)", "type": "string", "description": "Leave empty for a normal smoke. Set only when you want to verify a real discount code applies on the way to checkout." }, "store_password": { "title": "Storefront password (optional)", "type": "string", "description": "Shopify password-protected / staging storefront password. Leave empty for public stores." }, "timeout_seconds": { "title": "Per-phase timeout (seconds)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Max wait for each step (discover, add to cart, cart, coupon, checkout).", "default": 30 }, "use_proxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Default OFF for public stores. Turn ON for geo tests (set Proxy country) or when the storefront blocks direct / datacenter traffic. Residential recommended.", "default": false }, "proxy_country": { "title": "Proxy country", "enum": [ "US", "GB", "CA", "DE", "FR", "AU", "NL", "IE" ], "type": "string", "description": "Used only when Use Apify Proxy is on. ISO country for geo-specific catalog/checkout checks.", "default": "US" }, "proxy_groups": { "title": "Proxy groups", "uniqueItems": true, "type": "array", "description": "When proxy is on, prefer RESIDENTIAL for storefronts. Only change if your Apify account uses other groups.", "items": { "type": "string", "enumSuggestedValues": [ "RESIDENTIAL", "SHADER", "GOOGLE_SERP" ], "enumTitles": [ "Residential", "Shader", "Google SERP" ] } }, "proxy_session_id": { "title": "Proxy session ID (optional)", "type": "string", "description": "Sticky session id (letters, numbers, _, ., ~). Useful for consistent geo IPs across retries." }, "retry_without_proxy": { "title": "Retry once without proxy if proxy fails", "type": "boolean", "description": "If a proxy-backed run fails early (navigation / product / cart), retry once with proxy off.", "default": true }, "take_screenshot_on_failure": { "title": "Screenshot on failure", "type": "boolean", "description": "Save a failure screenshot to the default key-value store (recommended for post-deploy checks).", "default": true }, "headless": { "title": "Headless browser", "type": "boolean", "description": "Keep on for normal runs. Turn off only when debugging with a visible browser (local / special builds).", "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 } } } } } } } } } }