Skip to Content

Walmart Search

Description: Enable agents to search for products with Walmart.

Author: Arcade

Auth: API Key

PyPI VersionLicensePython VersionsWheel StatusDownloads

The Arcade Walmart Search Server provides a pre-built set of tools for interacting with Walmart. These tools make it easy to build and AI apps that can:

  • Search for products listed on Walmart stores;
  • Get details about a product.

Available Tools

Tool NameDescription
Walmart.SearchProductsSearch for products listed on Walmart stores.
Walmart.GetProductDetailsGet details about a product listed on Walmart.

If you need to perform an action that’s not listed here, you can get in touch with us to request a new , or create your own tools.

Walmart.SearchProducts


Search for products listed on Walmart stores.

Parameters

  • keywords (string, required) Keywords to search for. E.g. ‘apple iphone’ or ‘samsung galaxy’
  • sort_by (enum WalmartSortBy, optional, Defaults to WalmartSortBy.RELEVANCE) Sort the results by the specified criteria. Defaults to WalmartSortBy.RELEVANCE.
  • min_price (float, optional, Defaults to None) Minimum price to filter the results.
  • max_price (float, optional, Defaults to None) Maximum price to filter the results.
  • next_day_delivery (bool, optional, Defaults to False) Whether to filter the results by next day delivery. Defaults to False (returns all products, regardless of delivery status).
  • page (int, optional, Defaults to 1) Page number to fetch. Defaults to 1 (first page of results). The maximum page value is 100.

Walmart.GetProductDetails


Get details about a product listed on Walmart.

Parameters

  • item_id (string, required) Item ID. E.g. ‘414600577’. This can be retrieved from the search results of the SearchWalmartProducts .

Auth

The Arcade Walmart Search Sever uses the SerpAPI  to get product information from Walmart.

  • Secret:
    • SERP_API_KEY: Your SerpAPI .

      Setting the SERP_API_KEY secret is only required if you are self-hosting Arcade. If you’re using Arcade Cloud, the secret is already set for you. To manage your secrets, go to the Secrets page  in the Arcade Dashboard.


Reference

WalmartSortBy

  • RELEVANCE: 'relevance_according_to_keywords_searched' - Sort by relevance.
  • PRICE_LOW_TO_HIGH: 'lowest_price_first' - Sort by price from low to high.
  • PRICE_HIGH_TO_LOW: 'highest_price_first' - Sort by price from high to low.
  • BEST_SELLING: 'best_selling_products_first' - Sort by best selling.
  • RATING_HIGH: 'highest_rating_first' - Sort by rating from high to low.
  • NEW_ARRIVALS: 'new_arrivals_first' - Sort by new arrivals.
Last updated on