# Wallmart Products Search (`ilborso/wallmart-products-search`) Actor

Unlock real-time Walmart product data at scale. Search any Walmart store's shelf by keyword and instantly receive structured, ready-to-use product listings — complete with live pricing, customer ratings, stock availability, and fulfilment options.

- **URL**: https://apify.com/ilborso/wallmart-products-search.md
- **Developed by:** [Fabio Borsotti](https://apify.com/ilborso) (community)
- **Security:** Limited permissions
- **Stats:** 3 total users, 0 monthly users, 87.5% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.99 / 1,000 results

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Walmart Product Search — Apify Actor

Unlock **real-time Walmart product data** at scale. Search any Walmart store's shelf by keyword and instantly receive structured, ready-to-use product listings — complete with live pricing, customer ratings, stock availability, and fulfilment options.

Whether you're building a price-monitoring dashboard, feeding an analytics pipeline, or powering competitive intelligence workflows, this actor delivers production-grade Walmart search data straight to your Apify Dataset in seconds.

***

### Key Features

- **Store-level precision** — target a specific Walmart store by ID, or let the system resolve the nearest store from a US ZIP code.
- **Real-time pricing** — every result reflects the actual current price and any active discount at the selected store.
- **Rich product metadata** — name, brand, images, ratings, review counts, seller identity, category path, and more.
- **Sponsored ad detection** — sponsored placements are included and clearly flagged so you can filter them as needed.
- **Flat JSON output** — zero nested objects. Every record is a simple key→value row, ready for spreadsheets, databases, or BI tools with no post-processing.
- **Seamless Apify integration** — results are pushed directly to the default Apify Dataset, accessible via API, webhooks, or the Apify console.

***

### Environment Variables

| Variable | Required | Description |
|---|---|---|
| `SCRAPEDO_KEY` | **Yes** | Your API authentication token. Configure this in **Settings → Environment Variables** on the Apify platform. |

***

### Input Parameters

| Parameter | Type | Required | Description |
|---|---|---|---|
| `q` | string | **Yes** | Search keyword (e.g. `milk`, `laptop`, `diapers`). URL-encoding is handled automatically. |
| `store` | string | \* | Walmart store ID to scope results to a specific store. Provide exactly **one** of `store` or `zipcode`. |
| `zipcode` | string | \* | 5-digit US ZIP code to scope results to a geographic area. Provide exactly **one** of `store` or `zipcode`. |
| `max_item` | integer | No | Max objects returned. Leave empty to return all results. |

> **Note:** You must provide exactly one of `store` or `zipcode` to locate which Walmart store's shelf to search.

#### Example Input

```json
{
    "q": "milk",
    "store": "2062"
}
```

Or target by area:

```json
{
    "q": "organic coffee",
    "zipcode": "60074"
}
```

***

### Output Structure

The actor returns a flat array of **Product Objects** pushed directly to the default Apify Dataset. There are no nested structures — every field is a simple scalar value.

#### Product Object Fields

| Field | Type | Description |
|---|---|---|
| `position` | integer | 1-based ranking position in the search results. |
| `item_id` | string | Walmart item identifier. |
| `name` | string | Full product title as displayed on Walmart. |
| `brand` | string | Brand name of the product. `null` when not available. |
| `url` | string | Direct URL to the Walmart product page. |
| `image` | string | Product thumbnail image URL. |
| `price` | number | Current selling price at this store. `null` when no price is shown. |
| `list_price` | number | Pre-discount / original price. Present only when the item is on sale. |
| `currency` | string | Currency code (e.g. `USD`). |
| `rating` | number | Average customer rating (out of 5). |
| `reviews_count` | integer | Total number of customer reviews. |
| `seller` | string | Who sells the item — `Walmart.com` or a third-party marketplace seller name. |
| `availability` | string | Stock status at this store (e.g. `IN_STOCK`, `OUT_OF_STOCK`). |
| `fulfillment` | string | Comma-separated fulfilment methods (e.g. `delivery, pickup`). |
| `sponsored` | boolean | `true` for paid/promoted placements. |
| `category` | string | Full category breadcrumb path (e.g. `Home Page/Food/Dairy & Eggs/Milk/Whole Milk`). |

***

### Example Output

![output image](https://raw.githubusercontent.com/ilborso/resources/refs/heads/main/screen.png)

```json
[
    {
        "position": 1,
        "item_id": "16864710228",
        "name": "Feastables Protein Fortified Chocolate Milk, Shelf-Stable, 8 fl oz, 6 Pack",
        "brand": "Feastables",
        "url": "https://www.walmart.com/ip/Feastables-6ct-Chocolate-Milk-8oz/16864710228",
        "image": "https://i5.walmartimages.com/seo/Feastables-6ct-Chocolate-Milk-8oz_0ea5cec9-01b0-4d55-9866-f38020430d8f.png",
        "price": 8.27,
        "list_price": null,
        "currency": "USD",
        "rating": 4.3,
        "reviews_count": 1826,
        "seller": "Walmart.com",
        "availability": "IN_STOCK",
        "fulfillment": "delivery, pickup",
        "sponsored": true,
        "category": "Home Page/Food/Dairy & Eggs/Milk/Flavored Milk/Chocolate Milk"
    },
    {
        "position": 2,
        "item_id": "43436773",
        "name": "fairlife Lactose Free Ultra Filtered Whole Milk, 52 fl oz",
        "brand": "fairlife",
        "url": "https://www.walmart.com/ip/fairlife-Lactose-Free-Ultra-Filtered-Whole-Milk-52-fl-oz/43436773",
        "image": "https://i5.walmartimages.com/seo/fairlife-Lactose-Free-Ultra-Filtered-Whole-Milk-52-fl-oz.jpeg",
        "price": 4.78,
        "list_price": 5.32,
        "currency": "USD",
        "rating": 4.8,
        "reviews_count": 21614,
        "seller": "Walmart.com",
        "availability": "IN_STOCK",
        "fulfillment": "delivery, pickup",
        "sponsored": true,
        "category": "Home Page/Food/Dairy & Eggs/Milk/Dairy Milk/Whole Milk"
    },
    {
        "position": 3,
        "item_id": "10450114",
        "name": "Great Value Whole Vitamin D Milk, Gallon",
        "brand": null,
        "url": "https://www.walmart.com/ip/Great-Value-Whole-Vitamin-D-Milk-Gallon-Plastic-Jug-128-Fl-Oz/10450114",
        "image": "https://i5.walmartimages.com/seo/Great-Value-Whole-Vitamin-D-Milk-Gallon-Plastic-Jug-128-Fl-Oz.jpeg",
        "price": 3.07,
        "list_price": null,
        "currency": "USD",
        "rating": 4.6,
        "reviews_count": 407290,
        "seller": "Walmart.com",
        "availability": "IN_STOCK",
        "fulfillment": "delivery, pickup",
        "sponsored": false,
        "category": "Home Page/Food/Dairy & Eggs/Milk/Dairy Milk/Whole Milk"
    }
]
```

***

### Error Handling

The actor fails with a clear status message in the following cases:

| Condition | Actor Behavior |
|---|---|
| Missing `q` (search keyword) | Fails immediately with input validation error. |
| Both `store` and `zipcode` provided | Fails — you must supply exactly one. |
| Neither `store` nor `zipcode` provided | Fails — you must supply exactly one. |
| `store` is not numeric | Fails with validation error. |
| `zipcode` is not a 5-digit US ZIP | Fails with validation error. |
| Upstream service failure | Fails with HTTP status code and error details. |
| Network / timeout error | Fails with network error details. |

***

### Use Cases

- **Price monitoring** — track product prices across specific Walmart stores on a schedule.
- **Competitive intelligence** — compare Walmart pricing against other retailers.
- **Market research** — analyze product availability, seller landscape, and category trends.
- **Inventory tracking** — monitor stock status and fulfilment options at store level.
- **Ad intelligence** — identify and track sponsored product placements for any keyword.

***

### Getting Started

1. **Set up your API key** — go to **Settings → Environment Variables** and add `SCRAPEDO_KEY` with your authentication token.
2. **Configure input** — provide a search keyword (`q`) and either a `store` ID or `zipcode`.
3. **Run the actor** — results appear in the default Apify Dataset, downloadable as JSON, CSV, Excel, or accessible via the Apify API.

# Actor input Schema

## `q` (type: `string`):

The product keyword to search for on Walmart (e.g. 'milk', 'laptop', 'diapers'). URL-encoding is handled automatically.

## `store` (type: `string`):

Walmart store ID to scope results to a specific store. Provide exactly one of 'store' or 'zipcode'.

## `zipcode` (type: `string`):

5-digit US ZIP code to scope results to a geographic area. Provide exactly one of 'store' or 'zipcode'.

## `max_item` (type: `integer`):

Max objects returned. Leave empty to return all results.

## Actor input object example

```json
{
  "q": "QAZXSWEDCVFR",
  "zipcode": "60074"
}
```

# Actor output Schema

## `productResults` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "q": "QAZXSWEDCVFR",
    "zipcode": "60074"
};

// Run the Actor and wait for it to finish
const run = await client.actor("ilborso/wallmart-products-search").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "q": "QAZXSWEDCVFR",
    "zipcode": "60074",
}

# Run the Actor and wait for it to finish
run = client.actor("ilborso/wallmart-products-search").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "q": "QAZXSWEDCVFR",
  "zipcode": "60074"
}' |
apify call ilborso/wallmart-products-search --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,ilborso/wallmart-products-search"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/Uz5QReWLpDY05KNak/builds/g23dyPDDRJKT76RjJ/openapi.json
