To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Holds the store-level pricing settings for an e-commerce store: currency, shipping and tax providers, points bucket names, inventory control, promotional availability windows and SEO field names. Persisted as XML (XStream alias "pricing-config") and stored as a website setting keyed on the store name, this is loaded and saved by PriceManager and combined with the store's pricing rules and checkout rules to build its full PricingRulesSet.
Group: E-commerce
Properties
| Property | Returns | Description |
|---|---|---|
| cashDivisor | Double | The divisor used to convert a points balance into a cash value for this store, so a customer's points can be shown or applied as an equivalent amount of money. |
| categorySeoAssetField | String | The name of the custom field on a category that holds its SEO asset, such as an image used for search engine or social sharing previews. |
| currencyCode | String | The currency code used for prices in this store, such as "AUD" or "NZD". |
| dataSeries | String | The name of the data series that this store's sales are recorded against. |
| inventoryLocationName | String | The name of the inventory location that stock levels for this store are checked and decremented against, when inventory control is enabled. |
| minimumPrices | BigDecimal | The minimum total cost a cart or product order line must have to be placed in this store. Falls back to one unit of currency when not set. |
| orderIdTemplate | String | The template used to generate order ids for this store, such as "ORDER-[COUNTER]". Falls back to "ORDER-[COUNTER]" when not set. |
| pointsBuckets | List<String> | The names of the points buckets that can be used to pay for products in this store. |
| productSeoAssetField | String | The name of the custom field on a product that holds its SEO asset, such as an image used for search engine or social sharing previews. |
| promotionalAvailabilities | List<PromotionalAvailability> | The promotional availability windows configured for the store, controlling when promotions are shown or active. |
| reasonCode | String | The default reason code recorded against a points debit when points are redeemed against a purchase in this store, such as "P" for purchase. |
| reasonMvel | String | An MVEL template used to generate the reason text recorded against a points debit when points are redeemed against a purchase in this store. |
| shippingProviders | List<ShippingProvider> | The shipping providers configured for the store. |
| taxProviders | List<TaxCalcProvider> | The tax calculation providers configured for the store. |
| useInventoryControl | Boolean | Whether this store checks and enforces stock levels from its inventory location before allowing a purchase. |
Methods
getShippingProviders() · getTaxProviders() · getPromotionalAvailabilities() · getCurrencyCode() · getPointsBuckets() · getReasonCode() · getReasonMvel() · getInventoryLocationName() · getUseInventoryControl() · getCashDivisor() · getCategorySeoAssetField() · getProductSeoAssetField() · getDataSeries() · getOrderIdTemplate() · getMinimumPrices() · withUseInventoryControl(Boolean useInventoryControl) · withInventoryLocationName(String inventoryLocationName)
getShippingProviders()
Returns: List<ShippingProvider>
The shipping providers configured for the store.
getTaxProviders()
Returns: List<TaxCalcProvider>
The tax calculation providers configured for the store.
getPromotionalAvailabilities()
Returns: List<PromotionalAvailability>
The promotional availability windows configured for the store, controlling when promotions are shown or active.
getCurrencyCode()
Returns: String
The currency code used for prices in this store, such as "AUD" or "NZD".
getPointsBuckets()
Returns: List<String>
The names of the points buckets that can be used to pay for products in this store.
getReasonCode()
Returns: String
The default reason code recorded against a points debit when points are redeemed against a purchase in this store, such as "P" for purchase.
getReasonMvel()
Returns: String
An MVEL template used to generate the reason text recorded against a points debit when points are redeemed against a purchase in this store.
getInventoryLocationName()
Returns: String
The name of the inventory location that stock levels for this store are checked and decremented against, when inventory control is enabled.
getUseInventoryControl()
Returns: Boolean
Whether this store checks and enforces stock levels from its inventory location before allowing a purchase.
getCashDivisor()
Returns: Double
The divisor used to convert a points balance into a cash value for this store, so a customer's points can be shown or applied as an equivalent amount of money.
getCategorySeoAssetField()
Returns: String
The name of the custom field on a category that holds its SEO asset, such as an image used for search engine or social sharing previews.
getProductSeoAssetField()
Returns: String
The name of the custom field on a product that holds its SEO asset, such as an image used for search engine or social sharing previews.
getDataSeries()
Returns: String
The name of the data series that this store's sales are recorded against.
getOrderIdTemplate()
Returns: String
The template used to generate order ids for this store, such as "ORDER-[COUNTER]". Falls back to "ORDER-[COUNTER]" when not set.
getMinimumPrices()
Returns: BigDecimal
The minimum total cost a cart or product order line must have to be placed in this store. Falls back to one unit of currency when not set.
withUseInventoryControl(Boolean useInventoryControl)
Returns: PricingConfiguration
Returns a copy of this pricing configuration with a different inventory control setting; all other fields are carried over unchanged.
| Parameter | Description |
|---|---|
useInventoryControl | the inventory control setting for the returned configuration |
withInventoryLocationName(String inventoryLocationName)
Returns: PricingConfiguration
Returns a copy of this pricing configuration with a different inventory location name; all other fields are carried over unchanged.
| Parameter | Description |
|---|---|
inventoryLocationName | the inventory location name for the returned configuration |
© 2025 Kademi Ltd