CategoriesFindAll Endpoint

Overview

This endpoint allows you to find all of the categories that are in your store.  This allows you to list them and parse them for any number of reasons or purposes.

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 them.

CategoriesFindAll

This REST API endpoint allows you to find all of the categories 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/categories

HTTP Method

GET

Parameters

There are no parameters for this endpoint.

Returns

If successful, this endpoint will return a populated list of the CategorySnapshotDTO 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);

// find all categories in the store
ApiResponse<List<CategorySnapshotDTO>> response = proxy.CategoriesFindAll();
// 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() {

    // find all categories
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "?key=" + apiKey,
        type: 'GET',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
           // do something else
        }
    });

});
{
   "Errors":[

   ],
   "Content":[
      {
         "Bvin":"da66d19c-cc4a-4406-96a4-b9fa977a3fd2",
         "StoreId":1,
         "ParentId":"",
         "Name":"Sample Products",
         "Description":"This is a sample category",
         "SourceType":0,
         "ImageUrl":"",
         "BannerImageUrl":"",
         "CustomPageUrl":"",
         "CustomPageOpenInNewWindow":false,
         "ShowInTopMenu":false,
         "Hidden":false,
         "RewriteUrl":"sample-products",
         "SortOrder":2,
         "MetaTitle":"Sample Products",
         "Operations":[

         ]
      },
      {
         "Bvin":"582c1bb5-a2fa-427d-ac0f-2ada35cb976f",
         "StoreId":1,
         "ParentId":"",
         "Name":"More Sample Products",
         "Description":"",
         "SourceType":0,
         "ImageUrl":"",
         "BannerImageUrl":"",
         "CustomPageUrl":"",
         "CustomPageOpenInNewWindow":false,
         "ShowInTopMenu":true,
         "Hidden":false,
         "RewriteUrl":"more-sample",
         "SortOrder":3,
         "MetaTitle":"More Sample Products",
         "Operations":[

         ]
      },
      {
         "Bvin":"df233158-67e7-414d-a62b-0502b145b721",
         "StoreId":1,
         "ParentId":"",
         "Name":"Demo Category",
         "Description":"",
         "SourceType":0,
         "ImageUrl":"",
         "BannerImageUrl":"",
         "CustomPageUrl":"",
         "CustomPageOpenInNewWindow":false,
         "ShowInTopMenu":true,
         "Hidden":false,
         "RewriteUrl":"demo-category",
         "SortOrder":4,
         "MetaTitle":"Demo Category",
         "Operations":[

         ]
      }
   ]
}
Have more questions? Submit a request

Need More Help?

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