Function ItemQuery

bmtools/tools/walmart/api.py:26–62

This API gather retail information about queried items at walmart :param item: product name presented as string. :param option_num: the number of items presented for each queried item. :return: a dict walmart retail information about queried items.

(
            item: str,
            option_num: Optional[int] = 3,
    )

    
    @tool.get("/ItemQuery")
    def ItemQuery(
            item: str,
            option_num: Optional[int] = 3,
    ):
        """
        This API gather retail information about queried items at walmart
        :param item: product name presented as string.
        :param option_num: the number of items presented for each queried item.
        :return: a dict walmart retail information about queried items.
        """
    
        try:
        
            params = {
                "engine": "walmart",
                "query": item,
                "api_key": SERPAPI_KEY,
            }
            search = GoogleSearch(params)
            results = search.get_dict()
            organic_results = results["organic_results"]
        
            item_res = []
            for idx in range(min(option_num, len(results["organic_results"]))):
                item_res.append({})
                item_res[idx]["name"] = organic_results[idx]["title"]
                item_res[idx]["description"] = organic_results[idx]["description"]
                item_res[idx]["price"] = organic_results[idx]["primary_offer"]["offer_price"]
                item_res[idx]["price_unit"] = organic_results[idx]["price_per_unit"]["unit"]
                item_res[idx]["url"] = organic_results[idx]["product_page_url"]
                item_res[idx]["rating"] = organic_results[idx]["rating"]
                item_res[idx]["seller_name"] = organic_results[idx]["seller_name"]
        
            return json.dumps(item_res)
    
        except Exception:  # Handle response error exceptions
            return {"error": "Response error."}

    return tool