SearchManagerIndexProduct Endpoint

Overview

Every store needs to make it as easy as possible to find their products.  This endpoint allows you to manually initiate the indexing of any specific product in your store.  This is useful if you've updated the product by non-standard means.  It will happen automatically for most update processes already.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of REST and API’s
  • Understanding of C# and/or JavaScript
  • Visual Studio 2012 or newer

Getting Started

You should already have a project open and ready to accept code to allow you to use this REST API endpoint.  You should also have one or more product created so that you can successfully index one.

SearchManagerIndexProduct

This REST API endpoint allows you to index a product in your store. 

Example URL

This is what the REST endpoint will look like if you are calling it using JavaScript.  See our REST API URL documentation for more information.

http://example.com/DesktopModules/Hotcakes/API/rest/v1/searchmanager/products/[BVIN]

BVIN is the product ID as described in the parameters below.

HTTP Method

POST

Parameters

Parameter Description
bvin This is the unique ID of the product that you wish to re-index

Returns

If successful, this endpoint will return True in the ApiResponse.Content object.  Otherwise, you should have one or more errors returned.  If you receive a False response with no error, either the product ID doesn't exist, or the REST call was improperly formatted.

Example Code

The following code will allow you to successfully call this endpoint, provided that you have enabled it.

Project References

  • Hotcakes.CommerceDTO

Import Namespaces

  • Hotcakes.CommerceDTO.v1
  • Hotcakes.CommerceDTO.v1.Client

 

string url = "http://example.com";
string key = "YOUR-API-KEY";

Api proxy = new Api(url, key);

// specify the product to index
var productId = "dfcae0ee-8bcf-4321-8b31-7883b5434285";

// call the API to index the specified product
ApiResponse<bool> response = proxy.SearchManagerIndexProduct(productId);
// your domain name
var url = "http://example.com"; 
// the path where the API is
var apiPath = "/DesktopModules/Hotcakes/API/rest/v1/";  
// endpoint as shown in the documentation
var endPoint = "searchmanager";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // specify the product to index
    var productId = "dfcae0ee-8bcf-4321-8b31-7883b5434285";

    // call the API to index the specified product
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/products/" + productId + "?key=" + apiKey,
        type: 'POST',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
            // do something else
        }
    });

});
{
   "Errors":[

   ],
   "Content":true
}
Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.