REST API Endpoints for Product Types

Overview

Product types allow merchants to group products of various types together to allow for easier management of how they're displayed, as well as to apply common attributes across a large section of your catalog.  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 Product Types

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

Endpoint Return Type Description
ProductTypesAddProperty Boolean Allows you to associate a product property to a property type.
ProductTypesCreate ProductTypeDTO Allows you to create a new product type for products to use in your store.
ProductTypesDelete Boolean Permanently deletes the specified product type from the store.
ProductTypesFind ProductTypeDTO Useful to find a single product type in the store.
ProductTypesFindAll List of ProductTypeDTO Used to allow you to find all instances of product types in the store.
ProductTypesRemoveProperty Boolean When called, this method will remove the association of the product property from the product type.
ProductTypesUpdate ProductTypeDTO Updates an existing product type using the product type information given.

 

Have more questions? Submit a request

Need More Help?

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