> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mindcase.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Walmart Products API

> Walmart products with title, brand, URL, price and list price. Search by keyword or pass product URLs.

`POST /v1/data/walmart/products/run`

**Pricing:** $0.0025 per product ($2.50 per 1,000).

## Ways to call it

* **Search Keywords**: set `queries` (optional: `maxResults`, `sortBy`, `minPrice`, `maxPrice`)
* **URLs**: set `urls` (optional: `maxResults`, `sortBy`, `minPrice`, `maxPrice`)

## Request

Send the inputs under `params`. Only the keys below are accepted; any other key returns `422 invalid_params`.

**queries** `string[]`

One or more search keywords. One request reads them all.

**urls** `string[]`

One or more Walmart search, category or product URLs. One request reads them all. Sort By and the price filters apply to search and category URLs; a product URL returns that product as it is.

**maxResults** `integer` (default: 100)

How many products to return in total. Defaults to 100; use 0 for all.

**sortBy** `string` (default: best\_match)

Order of the results. Best match (Walmart default) by default. With URLs, applies to search and category URLs only.

Allowed values: `best_match` (Best match (Walmart default)), `price_low` (Price: low to high), `price_high` (Price: high to low), `best_seller` (Best seller), `rating_high` (Highly rated), `new` (New arrivals).

**minPrice** `integer`

Only return products priced at or above this amount, in whole dollars. With URLs, applies to search and category URLs only.

Min `0`.

**maxPrice** `integer`

Only return products priced at or below this amount, in whole dollars. With URLs, applies to search and category URLs only.

Min `0`.

## Example

```bash cURL theme={null}
curl -X POST "https://api.mindcase.co/v1/data/walmart/products/run?wait=true" \
  -H "Authorization: Bearer $MINDCASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "params": {
    "queries": [
      "airpods pro"
    ],
    "maxResults": 5
  }
}'
```

```python Python theme={null}
import os, requests

r = requests.post(
    "https://api.mindcase.co/v1/data/walmart/products/run",
    params={"wait": "true"},
    headers={"Authorization": f"Bearer {os.environ['MINDCASE_API_KEY']}"},
    json={"params": {
    "queries": [
        "airpods pro"
    ],
    "maxResults": 5
}},
)
job = r.json()
rows = job.get("data", [])  # if job["status"] == "running", poll /v1/jobs/{job_id}/results
```

```javascript Node.js theme={null}
const r = await fetch("https://api.mindcase.co/v1/data/walmart/products/run?wait=true", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MINDCASE_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ params: {
  "queries": [
    "airpods pro"
  ],
  "maxResults": 5
} }),
});
const job = await r.json();
const rows = job.data ?? []; // if job.status === "running", poll /v1/jobs/{job_id}/results
```

## Response fields

Each row in `data` is one product, keyed by these fields.

| Field | Name | Type |
| - | - | - |
| `itemId` | Item ID | text |
| `title` | Title | text |
| `brand` | Brand | text |
| `productUrl` | Product URL | url |
| `price` | Price | number |
| `currency` | Currency | text |
| `listPrice` | List Price | number |
| `savings` | Savings | number |
| `priceRangeMin` | Price Range Min | number |
| `priceRangeMax` | Price Range Max | number |
| `unitPrice` | Unit Price | text |
| `availability` | Availability | text |
| `inStock` | In Stock | boolean |
| `rating` | Rating | rating |
| `ratingsCount` | Ratings Count | number |
| `ratingCounts` | Rating Counts | object |
| `boughtSinceYesterday` | Bought Since Yesterday | number |
| `isBestSeller` | Is Best Seller | boolean |
| `soldBy` | Sold By | text |
| `sellerId` | Seller ID | text |
| `soldByWalmart` | Sold By Walmart | boolean |
| `fulfillmentType` | Fulfillment Type | text |
| `additionalOfferCount` | Additional Offer Count | number |
| `searchRank` | Search Rank | number |
| `categoryPath` | Category Path | text |
| `upc` | Upc | text |
| `model` | Model | text |
| `condition` | Condition | text |
| `description` | Description | text |
| `mainImage` | Main Image | image |
| `images` | Images | array |
| `badges` | Badges | array |
| `labels` | Labels | array |
| `specifications` | Specifications | object\_array |
| `returnPolicy` | Return Policy | object |
| `priceZipCode` | Price Zip Code | text |

## Example response

Abridged: long text and lists are shortened.

```json theme={null}
{
  "job_id": "7f3a1c2e-0b9d-4c55-9a51-3f2e8d1b6a40",
  "agent": "walmart/products",
  "status": "completed",
  "row_count": 1,
  "truncated": false,
  "data": [
    {
      "rating": 4.4,
      "additionalOfferCount": 2,
      "savings": 50,
      "images": [
        "https://i5.walmartimages.com/seo/AirPods-Pro-3_bbf7d96e-0ea2-4adc-93cc-f2aefe9c9fad.5094bad5696a875c3e764810e9670083.jpeg",
        "https://i5.walmartimages.com/asr/bd0723a6-36c1-43f8-917c-bc9249339a75.84ff7119cef6edfb19258fc6ff9398dd.jpeg"
      ],
      "badges": [
        "SOCIAL_PROOF_PURCHASES_FLAG",
        "CUSTOMER_PICK"
      ],
      "condition": "New",
      "availability": "IN_STOCK",
      "brand": "Apple",
      "itemId": "17835006350",
      "mainImage": "https://i5.walmartimages.com/seo/AirPods-Pro-3_bbf7d96e-0ea2-4adc-93cc-f2aefe9c9fad.5094bad5696a875c3e764810e9670083.jpeg",
      "priceRangeMax": null,
      "model": "MFHP4LL/A",
      "ratingsCount": 19503,
      "inStock": true,
      "priceZipCode": "19143",
      "description": "Active Noise Cancellation that reduces up to 2x more unwanted noise than AirPods Pro 2, in an in-ear wireless Bluetooth design\nBuilt-in heart rate sensing tr...",
      "soldByWalmart": true,
      "isBestSeller": false,
      "returnPolicy": {
        "returnable": true,
        "freeReturns": true,
        "returnWindowDays": 30,
        "text": "Free Holiday returns until Jan 31"
      },
      "boughtSinceYesterday": 1000,
      "priceRangeMin": null,
      "labels": [
        "Save with Walmart plus",
        "Free shipping, arrives today"
      ],
      "unitPrice": null,
      "specifications": [
        {
          "name": "Battery life",
          "value": "10 h"
        },
        {
          "name": "Headphone style",
          "value": "In-Ear"
        }
      ],
      "sellerId": "F55CDC31AB754BB68FE0B39041159D63"
    }
  ]
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.