ProductsCountOfAll Endpoint

Overview

Probably one of the simplest things you may need to know is the total number of products that your store has, but getting a count of total records on your own would be expensive from a technical perspective.  This endpoint allows you to get the count of products in your catalog with a single call.

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.  

ProductsCountOfAll

This REST API endpoint allows you to get a count of the total number of products that are currently 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://yourdomain.com/DesktopModules/Hotcakes/API/rest/v1/products/?key=[YOURKEY]&countonly=1

HTTP Method

GET

Parameters

Parameter Description
countonly This is a simple parameter that will tell the API to return the count, if present.  While 1 is used in the example URL, any value for the querystring parameter will have the same effect.

Returns

If successful, this endpoint will return an integer value in the ApiResponse.Content object.  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://YOURDOMAIN.COM";
string key = "YOUR-API-KEY";

Api proxy = new Api(url, key);

// call the API to find the total product count
ApiResponse<long> response = proxy.ProductsCountOfAll();
// your domain name
var url = "http://YOURDOMAIN.COM"; 
// the path where the API is
var apiPath = "/DesktopModules/Hotcakes/API/rest/v1/";  
// endpoint as shown in the documentation
var endPoint = "products";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // call the API to find the product to update
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "?key=" + apiKey + "&countonly=1",
        type: 'GET',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
            // do something else
        }
    });

});
{
   "Errors":[

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

Need More Help?

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