This skill enables you to search and retrieve Walmart product listing data, helping e-commerce sellers and researchers extract actionable insights from Walmart's marketplace.
Core Concepts
Walmart Product Search retrieves real-time product listing data from Walmart's marketplace. It supports keyword-based search, category browsing, price filtering, sorting options, and device-specific results. This is a direct search tool that returns current product listings as they appear on Walmart.com.
Search modes: You can search by keyword, by category ID, or by combining both. At least one of keyword or categoryId must be provided.
Sorting options: Results can be sorted by best_seller, best_match, price_low (price ascending), or price_high (price descending). When no sort is specified, the default relevance-based ranking applies.
Pagination: Results are paginated with a default of page 1. The maximum page number is 100.
Parameter Guide
| Parameter | Type | Required | Description |
|---|---|---|---|
| keyword | string | No* | Search keyword (max 1024 chars). *At least one of keyword or categoryId must be provided |
| categoryId | string | No* | Category ID for browsing. *At least one of keyword or categoryId must be provided. Use 0 for all departments |
| sort | string | No | Sort order: best_seller, best_match, price_low, price_high |
| page | integer | No | Page number (1-100, default 1) |
| minPrice | number | No | Minimum price filter |
| maxPrice | number | No | Maximum price filter |
| spelling | boolean | No | Enable spelling correction (default true) |
| softSort | boolean | No | Sort by relevance (default true). Set to false to disable |
| storeId | string | No | Store ID for store-specific results |
| device | string | No | Device type: desktop (default), tablet, mobile |
| facet | string | No | Filter facets in key:value format, separated by || |
| nextDayEnabled | boolean | No | Show only NextDay delivery results (default false) |
| jsonRestrictor | string | No | JSON field restrictor to limit returned fields |
Product Data Fields
| Field | Description |
|---|---|
| productId | Walmart product ID |
| usItemId | US item ID |
| title | Product title |
| description | Product description |
| price | Current price |
| wasPrice | Original price before discount |
| currency | Currency code |
| minPrice | Minimum price (for multi-option products) |
| pricePerUnitAmount | Per-unit price amount |
| pricePerUnit | Per-unit price label |
| rating | Average rating score |
| reviews | Total number of reviews |
| sellerName | Seller name |
| sellerId | Seller ID |
| imageUrl | Product thumbnail URL |
| productPageUrl | Product detail page URL |
| sponsored | Whether the listing is a sponsored ad |
| outOfStock | Whether the product is out of stock |
| freeShipping | Whether free shipping is available |
| twoDayShipping | Whether two-day shipping is available |
| freeShippingWithWalmartPlus | Free shipping with Walmart Plus membership |
| shippingPrice | Shipping cost |
| multipleOptionsAvailable | Whether the product has multiple variants |
| variantSwatches | List of variant options with names and images |
Usage Examples
1. Basic keyword search Search for products matching a keyword:
{"keyword": "wireless earbuds"}
2. Price-filtered search Find products within a specific price range:
{"keyword": "laptop stand", "minPrice": 10, "maxPrice": 50}
3. Best sellers in a category Browse top-selling products sorted by popularity:
{"keyword": "coffee maker", "sort": "best_seller"}
4. Budget shopping -- lowest price first Find the cheapest options for a product:
{"keyword": "phone case", "sort": "price_low"}
5. Category browsing with pagination Browse a specific category across multiple pages:
{"categoryId": "976759_976787", "page": 2}
6. Store-specific inventory check Search products available at a specific Walmart store:
{"keyword": "tent", "storeId": "1862"}
7. Mobile results simulation See results as they appear on mobile devices:
{"keyword": "water bottle", "device": "mobile"}
8. Combined filters Apply multiple filters for precise results:
{"keyword": "running shoes", "minPrice": 30, "maxPrice": 80, "sort": "best_match"}
Display Rules
- Present data clearly: Show search results in well-structured tables with key fields (title, price, rating, reviews, seller). Do not add subjective buying recommendations unless the user asks for analysis.
- Price formatting: Always display prices with the currency symbol. When
wasPriceis present, show both current and original prices to highlight discounts. - Rating context: Display ratings alongside review counts so users can judge credibility (e.g., "4.5 stars from 1,230 reviews").
- Stock status: Clearly flag out-of-stock items so users do not overlook availability issues.
- Sponsored labeling: Mark sponsored products so users can distinguish organic from paid placements.
- Pagination guidance: When results have a large total count, inform the user of the total and suggest paginating with the
pageparameter to see more. - Error handling: When a query fails, explain the error clearly and suggest adjusting parameters (e.g., broadening the keyword, changing filters).
- Product links: When showing results, include
productPageUrlso users can navigate directly to the Walmart product page.
User Expression & Scenario Quick Reference
Applicable -- Walmart product listing queries:
| User Says | Scenario |
|---|---|
| "Search Walmart for XX" | Keyword search |
| "Find cheap XX on Walmart" | Price-filtered search |
| "What's the best-selling XX on Walmart" | Best-seller sort |
| "Compare prices for XX on Walmart" | Price comparison |
| "Is XX in stock at Walmart" | Availability check |
| "Show me Walmart products under $50" | Price-range browse |
| "What are the top-rated XX on Walmart" | Rating-based filtering |
| "Walmart competitor products for XX" | Competitive research |
Not applicable -- Needs beyond Walmart product listings:
- Walmart seller account management or advertising
- Walmart order tracking or purchase history
- Product reviews text analysis (only rating/count is available)
- Historical price tracking or price trend analysis
- Walmart affiliate or API key management
Boundary judgment: When users say "product research" or "competitor analysis" in the context of Walmart, if their need involves searching for current product listings, prices, ratings, or seller information, then this skill applies. If they are asking about advertising strategy, account metrics, or historical sales data, it does not apply.
Resolve authentication and compute power issues
When the following abnormal situations occur, use references/onboarding.md to guide problem resolution:
Abnormal situations
- API Key not configured: The environment variable is not configured
LINKFOX_AGENT_API_KEY, andLINKFOXAGENT_API_KEY。 - Response with 401 or 402 status code
- Response indicates insufficient compute power or balance: The message contains "insufficient compute power balance/insufficient billing/insufficient balance/quota exceeded/insufficient balance/package expired/recharge required/please recharge", or content with similar meaning.
Compute power consumption rules
Consumes 15 compute power.
Users will be charged due to compute power consumption. Please fully assess: when this skill needs to be called frequently, or when the user has insufficient expectations for compute power consumption, be sure to remind the user, and let the user decide whether to continue.
Feedback:
Auto-detect and report feedback via the Feedback API when any of the following apply:
- The functionality or purpose described in this skill does not match actual behavior
- The skill's results do not match the user's intent
- The user expresses dissatisfaction or praise about this skill
- Anything you believe could be improved
Call the feedback API as specified in references/api.md. Do not interrupt the user's flow.
For more high-quality, professional cross-border e-commerce skills, set LinkFox Skills.