{ "openapi": "3.0.1", "info": { "title": "UK PPE & Safety Equipment Shelf Monitor", "description": "The whole priced UK safety-equipment trade catalogue in seconds: ex-VAT and inc-VAT price, minimum order quantity, unit, brand, category and the product lifecycle stage that flags a discontinuation early. Delta mode annotates every row with what moved.", "version": "0.1", "x-build-id": "h7jYmUfSO8kG5cGd0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zhorex~ppe-shelf-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zhorex-ppe-shelf-monitor", "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/zhorex~ppe-shelf-monitor/runs": { "post": { "operationId": "runs-sync-zhorex-ppe-shelf-monitor", "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/zhorex~ppe-shelf-monitor/run-sync": { "post": { "operationId": "run-sync-zhorex-ppe-shelf-monitor", "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": { "brands": { "title": "Brands (optional)", "type": "array", "description": "Narrow to specific brands, e.g. 3M, ARCO, JSP. Leave empty for the FULL catalogue — which is the point of this Actor: you need the competitor lines to benchmark your own, and the whole shelf costs 16 requests.", "items": { "type": "string" } }, "categories": { "title": "Categories (optional)", "type": "array", "description": "Narrow to specific low-level categories as they appear in the catalogue, e.g. 'Safety Footwear'. Combined with brands using AND.", "items": { "type": "string" } }, "filterExpression": { "title": "Raw filter (advanced)", "type": "string", "description": "A raw index filter for anything the two fields above cannot express, e.g. product_lifecycle:\"4 EXIT1\" to pull only the lines being discontinued." }, "maxProducts": { "title": "Max products", "minimum": 1, "maximum": 40000, "type": "integer", "description": "Ceiling on rows returned. The full catalogue measured ~14,800 priceable lines, harvested in 16 requests and about 8 seconds, so the default covers it with room to spare.", "default": 20000 }, "includeUnpriceableRows": { "title": "Include index entries with no name or price", "type": "boolean", "description": "The catalogue contains a small number of entries with no display name and a zero price (59 of 14,843 when measured). They are skipped and never charged by default; turn this on if you are auditing the index itself rather than the shelf.", "default": false }, "deltaMode": { "title": "Delta mode — annotate what moved", "type": "boolean", "description": "The first run records a baseline. Every later run returns the shelf with each row annotated by what changed since last time: a lifecycle transition (ESTABLISHED to EXIT is a discontinuation warning weeks early), a trade-price move with delta and percentage, a change in minimum order quantity or order interval, a promotion change, or a delisting. Rows that did not move are billed at the ordinary row rate, not the change rate.", "default": false }, "returnChangesOnly": { "title": "Return only the rows that moved", "type": "boolean", "description": "Optional, and off on purpose. Most buyers of a price file want the WHOLE shelf every run with the movement annotated — a changed-rows-only feed cannot be joined to yesterday's file. Turn this on only if you are feeding an alerting pipeline that already holds the full catalogue.", "default": false }, "deltaStateKey": { "title": "Delta stream name", "type": "string", "description": "Names an independent delta stream so several monitors don't collide. Only used when Delta mode is on.", "default": "default" }, "proxyConfiguration": { "title": "Proxy (optional — not required)", "type": "object", "description": "Not needed: the catalogue search answers ordinary IPs with no challenge. Leave it off unless you specifically want your traffic routed.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }