REST API Endpoints for Category/Product Associations

Overview

Category/product associations allow merchants to add products to categories to display them in a logical way to customers.  This area of the API allows you to manage how that is done.

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

If you haven’t already done so, you should probably have a development environment ready to development against, complete with Hotcakes installed and configured.

REST API endpoints for Category/Product Associations

There are a handful of REST API endpoints that allow you to display or manage various aspects of category/product associations.  Those endpoints are detailed below.

endpoint Return Type Description
CategoryProductAssociationsCreate CategoryProductAssociationDTO Adds the specified product to the specified category using an instance of the CategoryProductAssociationDTO object.
CategoryProductAssociationsFind CategoryProductAssociationDTO Allows you to find a specific category/product association.
CategoryProductAssociationsUnrelate Boolean Permanently removes the association between the product and the category.
CategoryProductAssociationsUpdate CategoryProductAssociationDTO Updates an existing product/category relationship or association.

 

Have more questions? Submit a request

Need More Help?

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