{ "openapi": "3.0.1", "info": { "title": "ASDA UK Product & Price Scraper", "description": "ASDA UK product, price, promotion, taxonomy and store-scoped availability Actor.", "version": "1.5", "x-build-id": "QrysgA3UE7pSlCe0R" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dromb~asda-uk-product-price-availability/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dromb-asda-uk-product-price-availability", "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/dromb~asda-uk-product-price-availability/runs": { "post": { "operationId": "runs-sync-dromb-asda-uk-product-price-availability", "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/dromb~asda-uk-product-price-availability/run-sync": { "post": { "operationId": "run-sync-dromb-asda-uk-product-price-availability", "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": { "operation": { "title": "Operation", "enum": [ "search", "product", "products", "category", "shelf", "suggestions" ], "type": "string", "description": "Choose one buyer workflow. Legacy task names remain accepted through the API but are hidden from the Console." }, "query": { "title": "Query", "minLength": 1, "maxLength": 300, "type": "string", "description": "Required for search and suggestions. Example: milk, coffee, shampoo.", "default": "milk" }, "productId": { "title": "Product ID (CIN)", "pattern": "^[0-9]+$", "type": "string", "description": "ASDA CIN for the product operation. Product IDs are returned in every product row." }, "productIds": { "title": "Product IDs (CINs)", "minItems": 1, "maxItems": 100, "uniqueItems": true, "type": "array", "description": "ASDA CINs for the products operation. Up to 100 unique IDs.", "items": { "type": "string", "pattern": "^[0-9]+$" } }, "categoryId": { "title": "Category ID", "pattern": "^[0-9]+$", "type": "string", "description": "Category taxonomy ID for the category operation. Copy it from a product result.", "default": "1215660378320" }, "shelfId": { "title": "Shelf ID", "pattern": "^[0-9]+$", "type": "string", "description": "Shelf taxonomy ID for the shelf operation. Copy it from a product result.", "default": "1215339438036" }, "priceRegion": { "title": "Price region", "enum": [ "EN", "SC", "WA", "NI" ], "type": "string", "description": "Select the England, Scotland, Wales, or Northern Ireland source price field. This does not geolocate the request.", "default": "EN" }, "storeId": { "title": "Store ID", "pattern": "^[0-9]+$", "minLength": 1, "maxLength": 50, "type": "string", "description": "ASDA commerce store ID used for store-scoped availability. Postcode conversion is not yet included." }, "inStockOnly": { "title": "Only in-stock products", "type": "boolean", "description": "For listing operations, keep only products with positive source stock for the selected store.", "default": false }, "limit": { "title": "Maximum results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum Dataset rows. The Coles-style quick default is 8; hard maximum is 1,000." }, "page": { "title": "Page", "minimum": 1, "maximum": 1000, "type": "integer", "description": "One-based starting page for search, category, shelf, and suggestions." }, "includeSponsored": { "title": "Include sponsored products", "type": "boolean", "description": "Include sponsored products when the source returns them.", "default": true }, "includePromotions": { "title": "Include promotion details", "type": "boolean", "description": "Include source promotion names and validity windows.", "default": true }, "includeRatings": { "title": "Include ratings", "type": "boolean", "description": "Include average rating and rating count when supplied.", "default": true }, "mode": { "title": "Ranking mode", "enum": [ "deterministic", "storefront_parity" ], "type": "string", "description": "Deterministic is recommended. Storefront parity adds source ranking hints while preserving hard filters.", "default": "deterministic" }, "hitsPerPage": { "title": "Source page size", "minimum": 1, "maximum": 100, "type": "integer", "description": "Results requested per source call. Maximum 100.", "default": 60 }, "requestDelayMs": { "title": "Delay after each request", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Optional delay after successful source calls.", "default": 200 }, "timeoutSecs": { "title": "Request timeout", "minimum": 5, "maximum": 60, "type": "integer", "description": "Per-request timeout.", "default": 30 }, "maxRetries": { "title": "Maximum retries", "minimum": 0, "maximum": 3, "type": "integer", "description": "Retries for retryable network or source-response failures.", "default": 2 }, "proxyMode": { "title": "Direct/proxy order", "enum": [ "direct_only", "direct_first", "proxy_first", "proxy_only" ], "type": "string", "description": "Direct access is the proven default. Custom proxy URLs are optional.", "default": "direct_only" }, "proxyUrls": { "title": "Custom proxy URLs", "maxItems": 5, "uniqueItems": true, "type": "array", "description": "Encrypted custom HTTP proxy URLs used only by proxy-enabled modes.", "items": { "type": "string", "minLength": 8 } }, "task": { "title": "Legacy task", "enum": [ "search", "category", "shelf", "exact_product", "product_batch", "suggestions" ], "type": "string", "description": "Backward-compatible task alias for API integrations. Prefer operation for new integrations." }, "cin": { "title": "Legacy CIN", "pattern": "^[0-9]+$", "type": "string", "description": "Backward-compatible alias for productId." }, "cins": { "title": "Legacy CIN batch", "minItems": 1, "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Backward-compatible alias for productIds.", "items": { "type": "string", "pattern": "^[0-9]+$" } }, "commerceStoreId": { "title": "Legacy commerce store ID", "pattern": "^[0-9]+$", "type": "string", "description": "Backward-compatible alias for storeId." }, "maxItems": { "title": "Legacy maximum results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Backward-compatible alias for limit." }, "pageStart": { "title": "Legacy zero-based page", "minimum": 0, "maximum": 999, "type": "integer", "description": "Backward-compatible alias for page." } } }, "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 } } } } } } } } } }