REST API Endpoints for Price Groups

Overview

Price groups allow merchants to group customers together to give special pricing to one or more customers or groups of 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 Price Groups

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

Endpoint Return Type Description
PriceGroupsCreate PriceGroupDTO Allows you to create a new price group and returns a copy of the price group to you.
PriceGroupsDelete Boolean Deletes the specified price group and returns the status of the deletion to you.
PriceGroupsFind PriceGroupDTO Use this endpoint to find a specific price group.
PriceGroupsFindAll List of PriceGroupDTO This endpoint allows you to return all of the price groups for the store.
PriceGroupsUpdate PriceGroupDTO Returns a list of categories for the store sorted the same as you have sorted in the store admin area.

 

Have more questions? Submit a request

Need More Help?

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