CategoriesFindBySlug Endpoint

Overview

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 using the slug portion of the URL.

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

CategoriesFindBySlug

This REST API endpoint allows you to find a category in your store using the slug portion of the URL.  This is the portion of a category URL that follows the last slash.  

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/categories/ANY?key=[YOURKEY]&byslug=[SLUG]

SLUG is the slug portion of the URL as described in the parameters below.

HTTP Method

GET

Parameters

Parameter Description
byslug You should put the slug of the category that you are searching for here. For example, if your URL looks like this, http://example.com/categories/sample-category, then your slug is "sample-category".

Returns

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 = "http://example.com";
string key = "YOUR-API-KEY";

Api proxy = new Api(url, key);

// the slug to use to find the category
var slug = "sample-products";

// find the category in the store
ApiResponse<CategoryDTO> response = proxy.CategoriesFindBySlug(slug);
// 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 = "categories";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // define the slug you want to use for the search
    var slug = "sample-products";

    // find the category matching the slug
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/ANY?key=" + apiKey + "&byslug=" + slug,
        type: 'GET',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
           // do something else
        }
    });

});
{
   "Errors":[

   ],
   "Content":{
      "Bvin":"da66d19c-cc4a-4406-96a4-b9fa977a3fd2",
      "LastUpdatedUtc":"/Date(1395904257647)/",
      "StoreId":1,
      "ParentId":"",
      "Name":"Sample Products",
      "Description":"This is a sample category",
      "DisplaySortOrder":1,
      "SourceType":0,
      "SortOrder":2,
      "MetaKeywords":"",
      "MetaDescription":"This is a sample category",
      "MetaTitle":"Sample Products",
      "ImageUrl":"",
      "BannerImageUrl":"",
      "CustomPageUrl":"",
      "CustomPageOpenInNewWindow":false,
      "ShowInTopMenu":false,
      "Hidden":false,
      "TemplateName":"Grid",
      "PreContentColumnId":"",
      "PostContentColumnId":"",
      "ShowTitle":true,
      "Keywords":"Sample Products",
      "RewriteUrl":"sample-products",
      "Operations":[

      ]
   }
}
Have more questions? Submit a request

Need More Help?

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