ProductVolumeDiscountsUpdate Endpoint

Overview

It wouldn't be unusual to need to update an existing product volume discount.  This endpoint allows you to update any specific volume discount for a product in 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 one or more product volume discounts created so that you can successfully find one to update.

ProductVolumeDiscountsUpdate

This REST API endpoint allows you to update a volume discount for a product in your store. This requires that you also have a product volume discount to update, which would mean that you should also call the ProductVolumeDiscountFind endpoint to get an existing volume discount.

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/productvolumediscounts/[BVIN]

BVIN is the product volume discount ID as described in the parameters below.

HTTP Method

POST

Parameters

Parameter Description
bvin This is the unique ID of the product volume discount that you wish to update
data You will need to pass an updated JSON version of the ProductVolumeDiscountDTO object in your post request

Returns

If successful, this endpoint will return a populated ProductVolumeDiscountDTO object in JSON format.  Otherwise, you should 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.Catalog
  • Hotcakes.CommerceDTO.v1.Client

 

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

Api proxy = new Api(url, key);

// specify the product volume discount ID to update
var discountId = "4bf08be8-a4c1-4c98-a10f-5dada713d5c8";

// call the API to find the product volume discount
var discount = proxy.ProductVolumeDiscountsFind(discountId).Content;

// update one or more properties of the product volume discount
discount.Amount = 15.5m;
discount.DiscountType = ProductVolumeDiscountTypeDTO.Percentage;

// call the API to update the product volume discount
ApiResponse<ProductVolumeDiscountDTO> response = proxy.ProductVolumeDiscountsUpdate(discount);
// 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 = "productvolumediscounts";  
// get this from the store admin
var apiKey = "YOUR-API-KEY";

$(document).ready(function() {

    // specify the product volume discount ID to find
    var discountId = "4bf08be8-a4c1-4c98-a10f-5dada713d5c8";

    // call the API to find the product volume discount
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + discountId + "?key=" + apiKey,
        type: 'GET',
        success: function (data) {
            // update the product volume discount in another method
            UpdateProductVolumeDiscount(data.Content);
        },
        error: function (jqXHR, textStatus) {
            // do something
        }
    });

});

function UpdateProductVolumeDiscount(discount) {
            
    // update one or more properties of the product volume discount
    discount.Amount = 15.5;
    discount.DiscountType = 1;

    // parse the date/time to make it safe to update
    discount.LastUpdated = ParseDateForSave(discount.LastUpdated);

    // call the API to update the product volume discount
    $.ajax({
        dataType: "json",
        url: url + apiPath + endPoint + "/" + discount.Bvin + "?key=" + apiKey,
        data: JSON.stringify(discount),
        type: 'POST',
        success: function (data) {
            // do something
        },
        error: function (jqXHR, textStatus) {
            // do something else
        }
    });

}

function ParseDateForSave(dateValue) {
    // create a new date object in UTC format
    var newDate = new Date(parseInt(dateValue.substr(6)));

    // return the UTC version of the date
    return newDate.toISOString();
}
{
   "Errors":[

   ],
   "Content":{
      "Bvin":"4bf08be8-a4c1-4c98-a10f-5dada713d5c8",
      "StoreId":1,
      "LastUpdated":"\/Date(1402105111524)\/",
      "ProductId":"dfcae0ee-8bcf-4321-8b31-7883b5434285",
      "Qty":20,
      "Amount":15.5,
      "DiscountType":1
   }
}
Have more questions? Submit a request

Need More Help?

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