R/product_recommendation.R

In Elkamao/walmartR: Client for the Walmart Open API

#' @title Product Recommendation
#'
#' @description This prouct recommendation function is an extension driven by the science that powers the recommended products container on Walmart.com and provides the top 10 recommended products for a certain item.
#'
#' @param apikey Your API access key authorized by Walmart API (Required)
#' @param itemId The item id associated with an item on Walmart.com. This can be generally seen in the last 8 digits of a URL string, but can also be acquired by using the product_lookup function (Required)
#'
#' @return Returns an RDS file named "product_recommendation_output.RDS".
#'
#' @references https://developer.walmartlabs.com/docs/read/Product_Recommendation_API
#'
#' @examples
#' apikey = "YOUR API KEY"
#' product_recommendation(apikey, "36904791")
#'
#' @export
#' @import jsonlite
#' @import httr

product_recommendation <- function(apikey = NULL, itemId){

  querys <-  list(apiKey = apikey,
                  itemId = itemId)
  resps <- GET(url = "http://api.walmartlabs.com/v1/nbp",
               query = querys)

  if (status_code(resps) == 200) {
    parsed <- jsonlite::fromJSON(content(resps, "text"))
    df <- data.frame(parsed)
    saveRDS(df, file = "store_locations_output.RDS")
  }
  else{
    warning("Walmart Open API request failed")
  }
}