ProductVolumeDiscountDTO Object

Overview

The REST API makes extensive use of the ProductVolumeDiscountDTO object whenever working with a single product volume discount.  This article will help you to know the various members of this object.

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

There are no tasks needed to get started with understanding this object. 

ProductVolumeDiscountDTO

The ProductVolumeDiscountDTO object will contain all of the details of a single volume discount for products in your Hotcakes Commerce store.

Members

The following table gives you details on the various members of the ProductVolumeDiscountDTO object.  The descriptions are based upon default functionality and the default Viewset included with Hotcakes.

Member Default Description
Amount 0 This property should hold the new product price or the discount percentage for the product.
Bvin (empty string) The unique ID or primary key of the product volume discount.
DiscountType 0 Specifies the type of discount that the amount is, decimal amount or percentage. The possible values are:
  • None = 0
  • Percentage = 1
  • Amount = 2
LastUpdated UtcNow The last updated date is used for auditing purposes to know when the product volume discount was last updated.
ProductId (empty string) The unique ID or Bvin of the product that this discount applies to.
Qty 0 The minimum number of products that must be in the cart to qualify for this volume discount.
StoreId 0 This is the ID of the Hotcakes store. Typically, this is 1, except in multi-tenant environments.

Example of ProductVolumeDiscountDTO

{
   "Errors":[

   ],
   "Content":{
      "Bvin":"507d2459-701c-440b-9789-0bd723e6b9ce",
      "StoreId":1,
      "LastUpdated":"\/Date(1402101206656)\/",
      "ProductId":"dfcae0ee-8bcf-4321-8b31-7883b5434285",
      "Qty":10,
      "Amount":10,
      "DiscountType":1
   }
}
Have more questions? Submit a request

Need More Help?

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