To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Properties
| Name | Returns | Notes | Example |
|---|---|---|---|
| ecomStores | List | Returns all stores in the account | |
| stores | List | Alias for getEcomStores | |
| categories | List | Returns all categories in the account | |
| inventoryLocations | List | ||
| parentOrgsWithProducts | List |
Methods
| Name | Returns | Notes | Example |
|---|---|---|---|
| addOrUpdateCategoryImage ( cat, imageHash ) | void | ||
| deleteSku ( sku ) | void | Delete the given SKU. Will soft delete if there are orders associated with it | |
| productCount ( store ) | long | ||
| findSkus ( p ) | List | ||
| findSku ( skuId ) | ProductSku | Find a ProductSku by its ID (numeric) | |
| findSku ( skuCode ) | ProductSku | Find a ProductSku by its SKU code (alpha-numeric) | |
| findProductByName ( productCode ) | Product | ||
| findProductById ( id ) | Product | ||
| findProductInStore ( name, store ) | ProductInEComStore | ||
| findProductInStoreById ( productId, store ) | ProductInEComStore | ||
| findProductInStore ( p, store ) | ProductInEComStore | ||
| findSkuInStore ( id, store ) | ProductSku | ||
| findProductByAssetId ( assetId ) | Product | ||
| findCategoryByAssetId ( assetId ) | Category | ||
| findProductsByCategory ( cat ) | List | ||
| createAssetForProduct ( p, type ) | Asset | ||
| createAssetForCategory ( cat, type ) | Asset | ||
| checkCreateStore ( title, storeName, websiteName ) | boolean | ||
| createStore ( storeName, title, website ) | ECommerceStore | ||
| addToStore ( productCode, storeName ) | ProductInEComStore | ||
| addToStore ( product, store ) | ProductInEComStore | ||
| checkCreateCategory ( name, title ) | boolean | ||
| checkCreateProduct ( name, title, category ) | boolean | ||
| fireProductUpdated ( p ) | void | ||
| fireProductDeleted ( p ) | void | ||
| searchProducts ( storeName, query, category, sortField, asc ) | List | ||
| searchProducts ( store, query, c, sortField, asc ) | List | ||
| searchProducts ( storeName, query, category, startPrice, endPrice, sortField, asc ) | List | ||
| searchProducts ( store, query, cat, startPrice, endPrice, sortField, asc ) | List | ||
| locations ( sku, store ) | List | Find all ProductInLocation records for the given SKU and store | |
| removeProductInLocation ( pil ) | void | Remove ProductInLocation record | |
| removeProductsFromStore ( pies ) | void | ||
| fireProductInLocationRemoved ( pil ) | void | Fire event when product in location removed | |
| attributeNames ( ) | List | Returns all attribute names, as a list of pairs of name/title, defined for the account. These are managed in ECommerce settings | |
| attributeTitle ( name ) | String | ||
| findStore ( name ) | ECommerceStore | Finds a store by its name | |
| findStore ( id ) | ECommerceStore | Find a store by its Kademi ID | |
| findStoresByWebsite ( website ) | List | ||
| findCategory ( code ) | Category | ||
| findCategory ( id ) | Category | ||
| findInventoryLocation ( code ) | InventoryLocation | ||
| createInventoryLocation ( name, title ) | InventoryLocation | ||
| addToLocation ( sku, loc ) | boolean | Add a SKU to an inventory location, unless its already in that location | |
| newProductBuilder ( productCode ) | ProductBuilder | ||
| newProductSkuBuilder ( product, skuCode ) | ProductSkuBuilder | ||
| countOfOrders ( pis, start, finish ) | Long | Find how many orders have been places for this product in store | |
| matchAndSaveProductImage ( newName, inputStream ) | MatchImageNameResult | ||
| deleteAllImages ( ) | int | Deletes all product related images in the entire account |
© 2025 Kademi Ltd