{ "openapi": "3.0.1", "info": { "title": "Walmart Product & Local Store Scraper", "description": "Extracts structured product data, physical store-bound shelf prices, local inventory, in-store aisle locations, seller details, technical specifications, nutrition facts, and paginated customer reviews from Walmart US (walmart.com, USD) and Walmart Mexico.", "version": "0.0", "x-build-id": "08oyQP8eZgbNzNIdB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hypebridge~walmart-product-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hypebridge-walmart-product-scraper", "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/hypebridge~walmart-product-scraper/runs": { "post": { "operationId": "runs-sync-hypebridge-walmart-product-scraper", "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/hypebridge~walmart-product-scraper/run-sync": { "post": { "operationId": "run-sync-hypebridge-walmart-product-scraper", "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": { "startUrls": { "title": "Start URLs", "maxItems": 5000, "type": "array", "description": "Walmart US (.com) or Mexico (.com.mx) collection, store or direct product URLs. URLs select their own market; unsupported countries, including Canada, are skipped with a warning.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Maximum items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of total products to extract across all queries and URLs.", "default": 50 }, "getProductDetails": { "title": "Enrich with full product details", "type": "boolean", "description": "Visit discovered products for full PDP details. Off by default; getProductReviews automatically enables this. Direct product URLs and itemIds always return full details.", "default": false }, "getProductReviews": { "title": "Include product reviews", "type": "boolean", "description": "Fetch individual product review titles, bodies, ratings, dates, and available provenance. Also works on direct PDP URLs/itemIds. Automatically enables PDP details for products discovered from home, overview, search, or category pages. Reviews stay nested on each product and are bounded by the limits below. Each returned review is charged separately in addition to the detailed product; see Pricing.", "default": false }, "maxReviewsPerProduct": { "title": "Maximum reviews per product", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum unique review records per product when reviews are enabled. The page and output-size caps can return fewer.", "default": 20 }, "maxReviewPagesPerProduct": { "title": "Maximum review pages per product", "minimum": 1, "maximum": 50, "type": "integer", "description": "Hard maximum logical review pages attempted per product, including failed pages. Stops even if the review count limit is not met.", "default": 10 }, "searchQueries": { "title": "Search queries", "maxItems": 100, "type": "array", "description": "Keywords to search in the selected US or Mexican market.", "items": { "type": "string", "pattern": "^.{1,200}$" } }, "itemIds": { "title": "Direct Item IDs", "maxItems": 5000, "uniqueItems": true, "type": "array", "description": "IDs in the selected market. Keep leading zeros for Mexican IDs. Direct IDs always return full details.", "items": { "type": "string", "pattern": "^[A-Za-z0-9]{1,24}$" } }, "zipCode": { "title": "ZIP code (Store Localization)", "pattern": "^[0-9]{5}$", "type": "string", "description": "5-digit US ZIP code to resolve the nearest physical Walmart Supercenter and bind the session for localized shelf prices, inventory, aisle locations, and store metadata (e.g. '77001', '95829', '96814').", "default": "77001" }, "storeId": { "title": "Store ID override", "pattern": "^[1-9][0-9]{0,5}$", "type": "string", "description": "Optional direct Walmart Store Number (e.g. '5959', '3081', '3478'). Overrides zipCode lookup if provided." }, "maxPagesPerSearch": { "title": "Maximum collection pages per start", "minimum": 1, "maximum": 25, "type": "integer", "description": "Maximum discovery pages per search, category, home, or overview seed, including paginated product feeds. Continues until maxItems, source exhaustion, or this cap. Defaults to 25; source limits can stop sooner. Review pages use a separate limit.", "default": 25 }, "debugMode": { "title": "Save failure diagnostics", "type": "boolean", "description": "Save bounded sanitized failure HTML/JSON and available screenshots for diagnosis. Off by default.", "default": false }, "market": { "title": "Market for searches and item IDs", "enum": [ "US", "MX" ], "type": "string", "description": "Applies to searchQueries and itemIds. Start URLs select their own market and can mix countries in one run. The maximum items and spending limits apply to the whole run.", "default": "US" }, "mexicoPostalCode": { "title": "Mexico postal code", "pattern": "^[0-9]{5}$", "type": "string", "description": "Five-digit postal code used to resolve and bind the Mexican store. Prices are returned in MXN.", "default": "11220" }, "mexicoStoreId": { "title": "Mexico store ID override", "pattern": "^[1-9][0-9]{0,5}$", "type": "string", "description": "Optional Mexican store number. Supply its nearby Mexico postal code too; the selected store must occur in the location response. Overrides Mexican store URLs." } } }, "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 } } } } } } } } } }