CategoriesFind Endpoint


Sometimes you just need to find a category to do something unique with it.  This endpoint allows you to find a specific category in your store.


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 categories created so that you can successfully find one.


This REST API endpoint allows you to find a category 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.[BVIN]

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

HTTP Method



Parameter Description
bvin This is the unique ID of the category that you wish to find


If successful, this endpoint will return a populated CategoryDTO object in JSON format.  Otherwise, you should have one or more errors returned.  

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.Catalog
  • Hotcakes.CommerceDTO.v1.Client


string url = "";
string key = "YOUR-API-KEY";

Api proxy = new Api(url, key);

// the ID (bvin) of the category we are looking for
var categoryID = "da66d19c-cc4a-4406-96a4-b9fa977a3fd2";

// find the category in the store
ApiResponse<CategoryDTO> response = proxy.CategoriesFind(categoryID);
// your domain name
var url = ""; 
// the path where the API is
var apiPath = "/DesktopModules/Hotcakes/API/rest/v1/";  
// endpoint as shown in the documentation
var endPoint = "categories";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // specify the category ID to look for
    var categoryId = "da66d19c-cc4a-4406-96a4-b9fa977a3fd2";

    // execute the search
        dataType: "json",
        url: url + apiPath + endPoint + "/" + categoryId + "?key=" + apiKey,
        type: 'GET',
        success: function (data) {
            // do something
        error: function (jqXHR, textStatus) {
           // do something else


      "Name":"Sample Products",
      "Description":"This is a sample category",
      "MetaDescription":"This is a sample category",
      "MetaTitle":"Sample Products",
      "Keywords":"Sample Products",

Have more questions? Submit a request

Need More Help?

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