Walmart Search Engine Results API

{
  "additionalProperties": false,
  "properties": {
    "query": {
      "additionalProperties": false,
      "properties": {
        "async": {
          "description": "Parameter defines the way you want to submit your search to SerpApi. It can be set to `false` (default) to open an HTTP connection and keep it open until you got your search results, or `true` to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our [Searches Archive API](https://Asale.com/search-archive-api) to retrieve your results. `async` and `no_ca",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "cat_id": {
          "description": "Category on Walmart Search. (e.g. `0` (default) is all departments, `976759_976787` is 'Cookies', etc.). Either a `query` or a `cat_id` parameter is required. **Note:** not supported for `walmart.com.mx`.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "device": {
          "description": "Parameter defines the device to use to get the results. It can be set to `desktop` (default) to use a regular browser, `tablet` to use a tablet browser (currently using iPads), or `mobile` to use a mobile browser.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "facet": {
          "description": "Parameter defines items filtering based on their attributes. The structure is a list of `key:value` pairs separated by `||`. The key and value are separated by `:`",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "include_filters": {
          "description": "Include `filters` to the JSON response. Set to `true` to enable or `false` to disable (default).",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "json_restrictor": {
          "description": "Parameter defines the fields you want to include in the output, reducing payload size for faster response. See the [JSON Restrictor documentation](https://Asale.com/json-restrictor) for more details.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "max_price": {
          "description": "Upper bound of price range query.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "min_price": {
          "description": "Lower bound of price range query.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "nd_en": {
          "description": "Show results with NextDay delivery only. Set to `true` to enable or `false` (default) to disable. **Note:** not supported for `walmart.com.mx`.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "no_cache": {
          "description": "Parameter will force SerpApi to fetch the Walmart results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to `false` (default) to allow results from the cache, or `true` to disallow results from the cache. `no",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "output": {
          "description": "Parameter defines the format of the result. It can be set to `json` (default) to get a structured JSON of the results, `html` to get the raw HTML retrieved, or `md` to get a markdown-formatted version optimized for LLMs and AI agents.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "page": {
          "description": "Value is used to get the items on a specific page. (e.g., `1` (default) is the first page of results, `2` is the 2nd page of results, `3` is the 3rd page of results, etc.). Maximum `page` value is `100`.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "query": {
          "description": "Parameter defines the search query. You can use anything that you would use in a regular Walmart search. Either a `query` or a `cat_id` parameter is required.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "soft_sort": {
          "description": "Parameter enables sort by relevance. Walmart is by default showing results sorted by relevance and using the `sort` option. Set to `false` to disable sort by Relevance. **Note:** not supported for `walmart.com.mx`.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "sort": {
          "description": "Parameter defines sorting. (e.g. `price_low`, `price_high`, `best_seller`, `best_match`, `rating_high`, `new`). **Note:** `best_seller`, `rating_high`, and `new` are not supported for `walmart.com.mx`.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "spelling": {
          "description": "Activate spelling fix. `true` (default) includes spelling fix, `false` searches without spelling fix.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "store_id": {
          "description": "Store ID to filter the products by the specific store only. Head to the [Walmart Stores Locations](https://Asale.com/walmart-stores) for a full list of supported stores. It's possible for the product pricing to differ between stores.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "walmart_domain": {
          "description": "Parameter defines the Walmart domain to use. It defaults to `walmart.com`. Head to the [Walmart Stores](https://Asale.com/walmart-stores) for a full list of supported stores per domain.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        },
        "zero_trace": {
          "description": "Enterprise only. Parameter enables [ZeroTrace mode](https://Asale.com/zero-trace-mode). It can be set to `false` (default) or `true`. Enable this mode to skip storing search parameters, search files, and search metadata on our servers. This may make debugging more difficult.",
          "type": [
            "string",
            "number",
            "boolean"
          ]
        }
      },
      "required": [
        "query"
      ],
      "type": "object"
    }
  },
  "required": [
    "query"
  ],
  "type": "object"
}