PriceGroupDTO Object

Overview

The REST API makes extensive use of the PriceGroupDTO object whenever working with price groups.  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. 

PriceGroupDTO

The PriceGroupDTO object will contain all of the details of a single price group for your Hotcakes Commerce store.  On occasion, a collection of this object will be used as well.

Members

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

Member Default Description
Adjustment 0.0 or 0m Depending on the pricing type, this amount is used to adjust the pricing for the customer.
Bvin (empty string) This is the ID of the price group.
LastUpdated UtcNow The last updated date is used for auditing purposes to know when the category was last updated.
Name (empty string) The name is used primarily for administrative purposes to give a meaningful label to the created groups which makes for easier management.
PricingType PricingTypeDTO The pricing type determines how the pricing is adjusted for customers.   The possible values are:
  • PercentageOffListPrice = 0
  • AmountOffListPrice = 1
  • PercentageAboveCost = 2
  • AmountAboveCost = 3
  • PercentageOffSitePrice = 4
  • AmountOffSitePrice = 5
StoreId 0 This is the ID of the Hotcakes store. Typically, this is 1, except in multi-tenant environments.

 

Example of PriceGroupDTO

{
   "Errors":[

   ],
   "Content":{
      "Adjustment":10.00,
      "Bvin":"w908e98f-120a-42ca-89e4-410ab26efb69",
      "LastUpdatedUtc":"/Date(1395782131104)/",
      "Name":"VIP Customers",
      "PricingType":0,
      "StoreId":1
   }
}
Have more questions? Submit a request

Need More Help?

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