PriceGroupsCreate Endpoint

Overview

In some stores it is a convenient or very customer service friendly thing to create price groups.  This endpoint allows you to create as many price groups as you need for your store.

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
  • Visual Studio 2012 or newer

Getting Started

You should already have a project open and ready to accept code to allow you to use this REST API endpoint.  You should also have some kind of idea what attributes that you want your price group to have before you create it.

PriceGroupsCreate

This REST API endpoint allows you to create a price group for your store. 

Example URL

This is what the REST endpoint will look like if you are calling it using JavaScript.  See our REST API URL documentation for more information.

http://example.com/DesktopModules/Hotcakes/API/rest/v1/pricegroups

HTTP Method

POST

Parameters

This method only requires that you pass an instance of the PriceGroupDTO object to the endpoint.

Returns

If successful, this endpoint will return a PriceGroupDTO object in JSON format.  Otherwise, you will have one or more errors returned.

Example Code

The following code will allow you to successfully call this endpoint, provided that you have enabled it.

Project References

  • Hotcakes.CommerceDTO

Import Namespaces

  • Hotcakes.CommerceDTO.v1
  • Hotcakes.CommerceDTO.v1.Client
  • Hotcakes.CommerceDTO.v1.Contacts

 

string url = "http://example.com";
string key = "YOUR-API-KEY";

Api proxy = new Api(url, key);

// create a new price group with populate properties
var priceGroup = new PriceGroupDTO();
priceGroup.AdjustmentAmount = 10.00m;
priceGroup.Name = "VIP Customers";
priceGroup.PricingType = PricingTypesDTO.PercentageOffSitePrice;

// create the new price group
ApiResponse<PriceGroupDTO> response = proxy.PriceGroupsCreate(priceGroup);
// your domain name
var url = "http://example.com"; 
// the path where the API is
var apiPath = "/DesktopModules/Hotcakes/API/rest/v1/";  
// endpoint as shown in the documentation
var endPoint = "pricegroups";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // put together a JSON object with the price group properties
    var priceGroup = {
        "AdjustmentAmount": 10.00,
        "Name": "VIP Customers",
        "PricingType": 4
    };

    // create your new price group
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "?key=" + apiKey,
        data: JSON.stringify(priceGroup),
        type: 'POST',
        success: function (data) {
            // do something
        },
        error: function(jqXHR, textStatus) {
            // do something else
        }
    });

});
{
   "Errors":[

   ],
   "Content":{
      "StoreId":1,
      "Bvin":"bf08d11e-54c4-4f22-9a31-c6329f42f92f",
      "LastUpdated":"/Date(1396341259517)/",
      "Name":"VIP Customers",
      "PricingType":4,
      "AdjustmentAmount":10
   }
}
Have more questions? Submit a request

Need More Help?

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