ClearProductsData Object

Overview

The REST API makes exclusive use of the ClearProductsData object whenever deleting all products from the catalog.  This article will help you to know the various members of this object.

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

Getting Started

There are no tasks needed to get started with understanding this object. 

ClearProductsData

The ClearProductsData object will contain all of the details of the results of attempting to delete all products from your catalog.

Members

The following table gives you details on the various members of the ClearProductsData object.  The descriptions are based upon default functionality and the default Viewset included with Hotcakes.

Member Default Description
ProductsCleared Integer Reports back the number of products that were successfully destroyed.
ProductsRemaining Integer Lets you know how many products still need to be removed.  If -1 is reported than something is wrong - most likely, the API is not accepting "clear all" requests.

 

Examples of ClearProductsData

{
   "Errors":[

   ],
   "Content":{
      "ProductsCleared":7,
      "ProductsRemaining":0
   }
}
{
   "Errors":[

   ],
   "Content":{
      "ProductsCleared":0,
      "ProductsRemaining":-1
   }
}

 

Have more questions? Submit a request

Need More Help?

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