To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Properties
| Name | Returns | Notes | Example |
|---|---|---|---|
| title | String | ||
| parent | CommonCollectionResource | ||
| name | String | ||
| productInReward | ProductInReward | ||
| description | String | ||
| brief | String | ||
| status | String | ||
| startDate | Date | ||
| endDate | Date | ||
| baseCost | BigDecimal | The base cost of the product, which is added to by any selected variations with non-null costs and multiplied by quantity | |
| freightCost | BigDecimal | ||
| imageHrefs | List | Get a list of product image hrefs | |
| primaryImageHref | String | ||
| variantImageHref | String | ||
| effectiveMargin | double | ||
| effectiveMultiplier | double | ||
| purchasePoints | Double | Calculate the purchase points for the base product, ie with no variant selections | |
| productDescription | String | ||
| productBrief | String | ||
| productImageHref | String | ||
| productTitle | String | ||
| productPurchaseCost | BigDecimal | ||
| currency | Currency | ||
| rewardStore | RewardStore | ||
| productItemId | Long | ||
| productItemEntityName | String | ||
| children | List | ||
| parameters | List | Returns the list of product parameters and their options (ie variants) as a list of ProductParameterBean A product parameter is something like color, size, etc. For each parameter there are usually some options, eg color=red or blue, and size=S,M,L,XL | |
| selectedParameterOptions | Map | Returns a map of selected parameter options, where the key is the product parameter name and the value is the selected option for that parameter. For example color=black; size=large This is a settable property, but by default it reads values from request parameters, where request parameters are in the form param-(parameter name)=option, eg param-color=black | |
| selectedOptions | List | ||
| memberBuyPrice | BigDecimal | ||
| invoiceCost | BigDecimal | ||
| effectiveGst | double | ||
| effectiveExternalMargin | double | ||
| effectiveInternalMargin | double | ||
| internalMargin | BigDecimal | ||
| buyPrice | BigDecimal | ||
| clientMargin | BigDecimal | ||
| sellPrice | BigDecimal | ||
| finalFreightCost | BigDecimal | ||
| orderFields | List | ||
| productSkus | List | ||
| productSku | ProductSku | Finds a product sku for the product and selected options | |
| product | Product | ||
| productLocations | List | Gets a list of ProductInLocation's for the current sku | |
| selectedPurchaseOptions | Map | ||
| sourceType | String | ||
| sourceId | String |
Methods
| Name | Returns | Notes | Example |
|---|---|---|---|
| getPurchasePoints ( selectedOptions ) | Double | Calculate the purchase points for the given selected variants | |
| addToCart ( c, quantity, selectedParams, session ) | ProductOrder | ||
| child ( childName ) | Resource | ||
| image ( id ) | ProductImageResource | ||
| getProductSku ( ) | ProductSku | Finds a product sku for the product and selected options | |
| productLocations ( sku ) | List | Gets a list of ProductInLocation's for the sku |
© 2025 Kademi Ltd