Product properties allow merchants to create and assign default properties that groupings of products should have. For example, all books have a ISBN and software has a version number. This area of the API allows you to manage how that is done.
The following pre-requisites will be necessary to accomplish the goals of this article:
- General understanding of REST and API’s
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 Properties
There are a handful of REST API endpoints that allow you to display or manage various aspects of product properties. Those endpoints are detailed below.
|ProductPropertiesCreate||ProductPropertyDTO||Allows you to create a new property to be used with product types.|
|ProductPropertiesDelete||Boolean||Permanently deletes the specified product property from the store.|
|ProductPropertiesFind||ProductPropertyDTO||Used to find a single product property.|
|ProductPropertiesFindAll||List of ProductPropertyDTO||This method allows you to return a listing of all product properties in the store.|
|ProductPropertiesFindByProduct||List of ProductPropertyDTO||This method allows you to return a listing of all product properties for a specific product in the store.|
|ProductPropertiesSetValueForProduct||Boolean||Allows you to set the value of a product property for a specific product.|
|ProductPropertiesUpdate||ProductPropertyDTO||Allows you to update an existing product property.|