Details

Written by: Administrator

Category: HikaShop

Published: 01 August 2013

Hits: 29856

Description

This screen enables you to manage all your shipping or payment plugins. The interface is the same so the documentation is the same on this screen, but the shipping plugins and payment plugins are accessible by two different HikaShop menus.

Toolbar

• Copy: Select one or several plugins and click on this button to copy them all.
• Generate Copies: (Shipping only) Select one or several shipping methods and click this button to open the Shipping Method Generator. This tool allows you to bulk create duplicates of the selected methods with specific modifications, such as different zones, weights, volumes, post codes, warehouses, quantities, prices, or currencies. This is useful for creating rate tables or variations efficiently.
• Publish: Select one or several plugins and click on this button to publish them all.
• Unpublish: Select one or several plugins and click on this button to unpublish them all.
• Export: (Shipping/Payment only) Export the list of methods to a CSV file. The columns can be configured in the main configuration.
• Import: (Shipping/Payment only) Import methods from a CSV file.
• New: Click to create a new plugin instance.
• Help: This button enables you to turn ON/OFF the help section.
• Dashboard: You can go back to the control panel using this button.

Column Headers

• #: An indexing number automatically assigned for ease of reference.
• Checkbox: Check this box to select one or more plugins. To select all items, check the box in the column heading. After one or more boxes are checked, click on the toolbar buttons to perform actions on the selected items.
• Name: Name of the plugin. You can click on it to edit it.
• Type: The type of plugin, for example:
  • Payment plugins: e.g., HikaShop PayPal payment plugin
  • Shipping plugins: e.g., HikaShop FedEx shipping plugin
• Order: Enables you to reorder your plugins within the current level.
• Delete: Click on the trash icon to remove the instance.
• Published: If a plugin is published, it can be used by customers during checkout.

Shipping Method Generator

The Shipping Method Generator is a powerful tool designed to help you quickly create multiple variations of a shipping method. This is particularly useful when you need to set up complex rate tables based on weight, zone, or other criteria without manually creating each method one by one.

How to use:

1. Go to the Shipping Methods listing (System -> Shipping Methods).
2. Select one or more existing shipping methods to serve as the "Source" (template).
3. Click the Generate Copies button in the toolbar.
4. In the popup window, select the Restriction Type you want to base your variations on (e.g., Weight, Zone, Price).
5. Add rows for each variation you need. For each row, you can define:
   • The restriction values (e.g., Min Weight 0 to Max Weight 5).
   • The Price for this specific variation.
   • A Percentage increase/decrease.
   • A Formula (e.g., {price} + ({weight} * 0.5)).
6. Click Generate. The system will create copies of your source method(s) with the specific restrictions and prices applied.

Supported Restriction Types:

• Zone: Create methods restricted to specific geographical zones.
• Product Weight: Define minimum and maximum weight limits.
• Product Volume: Define minimum and maximum volume limits.
• Shipping Zip Regex: Use Regular Expressions for advanced post code matching.
• Warehouse: Restrict methods to products from a specific warehouse.
• Product Quantity: Define minimum and maximum quantity of items in the cart.
• Price: Restrict based on the order total price (with option to include tax).
• Currency: Restrict the method to specific currencies.

FAQ

• I don't see any payment methods during checkout, or I don't see some of them. What is the problem?

  There are several things you might have missed:

  1. Check that the payment plugins are installed and published.
  2. Check that you have configured your payment plugins (edit and save the configuration).
  3. Check that your template is able to display error messages: Documentation.
  4. Check that you have the "payment" view in the checkout workflow option of the configuration.
  5. If you restricted your payment methods to certain zones, check that the customer's address belongs to those zones.
  6. Check that the currency you are using is supported by the payment plugin. Some gateways only support specific currencies.
  7. Ensure you haven't changed the currency code. Payment plugins rely on standard ISO codes. Use the "format" option to change the display symbol instead.
  8. If you selected a currency or shipping method restriction within the payment method options, ensure they match the selection during checkout. In most cases, these should be left unselected (use Ctrl+Click to deselect).
  9. Check that the plugin access level (via Joomla Plugin Manager) is set to Public.
  10. Sometimes the plugin access level is not set properly in the database. Open the plugin in the Joomla Plugin Manager and save it to reset the access level.
• I don't see any shipping methods during checkout. What is the problem?

  There are several things you might have missed:

  1. Check that the shipping plugin (e.g., Manual Shipping) is installed and published.
  2. Check that you have defined shipping methods in System -> Shipping methods.
  3. If using restrictions (weight, price, etc.), ensure your methods cover all possible scenarios (e.g., no gap between 10kg and 20kg if an order is 15kg).
  4. Check that your template is able to display error messages: Documentation.
  5. Check that your products have a weight. Without weight, products may be considered valid for shipping calculation or treated as virtual goods depending on settings.
  6. Check that you have the "shipping" view in the checkout workflow option of the configuration.
  7. If restricting to zones, verify the customer address matches the zones.
  8. Ensure you have valid units configured in the main configuration. Documentation.
  9. Use consistent usage of units. If your main unit is 'm' but you input dimensions in 'mm', ensure HikaShop can convert properly or change the main unit options to match your input preference (e.g., mm,m,cm).
  10. If using price restrictions, check the "Include virtual product prices" setting if you have virtual goods in the cart.
  11. Check that the plugin access level (via Joomla Plugin Manager) is set to Public.
  12. Re-save the plugin in Joomla Plugin Manager to ensure access levels are correct in the database.

Details

Written by: Xavier

Category: HikaShop

Published: 03 July 2013

Hits: 8210

Description

This screen enables you to manage the waitlist of your shop. You can see the information and edit them.

To enable the waitlist, you have to activate the waitlist plugin in the main configuration of HikaShop.

Toolbar

• Save & Close: Save the current waitlist entry and go to the waitlists listing
• Save & New: Save the current waitlist entry and create a new one.
• Save: Save the current waitlist entry.
• Cancel : Cancel the changes and go back to the waitlist listing.
• Help : This button enables you to turn ON/OFF the help section, this screen will appear or disappear.

Main information

• Name : The name set by the customer when subscribing to the waitlist.

• Email : The email of the customer, the notifications will be sent to this email address.
• Product : The product which is no longer in stock and required by the user who subscribed to this waitlist.
• Menu : Set the menu to use to display the product when clicking on the product link from the waitlist.
• Date : The date when the customer subscribed to the waitlist.

Details

Written by: Eliot

Category: HikaShop

Published: 01 July 2013

Hits: 19401

The mass action system included in Hikashop allows developers to write their own plugin very easily in order to process data the way they want. This documentation will give you the basis to create a mass action plugin in order to exploit the capacities of the mass action system.

Two options are offered in this tutorial, you can either create an Hikashop plugin as explained in this tutorial (and then, in this plugin, add functions as explained in the following example=) or you can download our example plugin here, including the needed element to make a usable mass action plugin. We also highly encourage you to look at the existing mass action plugins that are already by default in HikaShop and which handle all the mass actions triggers, filters and actions for products, categories, orders, users and addresses that are available when you install HikaShop.

Template

Here is a  template example, a template allow you to display a new option in the triggers, filters or actions.

In this example we used the function "onMassactionTableFiltersLoad" so it will add an option in the filters.

To add an option in the triggers you have to use "onMassactionTableTriggersLoad", and "onMassactionTableActionsLoad" to add an action.

// Add a dropdown filter for the product type
function onMassactionTableFiltersLoad(&$table,&$filters,&$filters_html,&$loadedData){
	$type = 'filter';
	$massactionClass = hikashop_get('class.massaction');
	if(empty($loadedData->massaction_filters)){
		$loadedData->massaction_filters = array();
	}
	// Add the entry in the filters listing
	$filters['productType']=JText::_('PRODUCT_TYPE');
	// Set the default values here
	$loadedData->massaction_filters['__num__'] = new stdClass();
	$loadedData->massaction_filters['__num__']->type = 'product';
	$loadedData->massaction_filters['__num__']->data = array();
	$loadedData->massaction_filters['__num__']->name = 'productType';
	$loadedData->massaction_filters['__num__']->data['type'] = 'all';
	$loadedData->massaction_filters['__num__']->html = '';
		foreach($loadedData->massaction_filters as $key => &$value) {
		if($value->name != 'productType' || ($table->table != $loadedData->massaction_table && is_int($key)))
			continue;
		$value->type = 'product';
		$product = hikashop_get('type.product');
		$product->onchange='countresults(\''.$table->table.'\','.$key.');';
		// add here the output, what will be displayed after selecting the filter
		$output = $product->display('filter['.$table->table.']['.$key.'][productType][type]',$value->data['type'], 'chzn-done not-processed');
		// call the "initDefaultDiv" function to format your content
		$filters_html[$value->name] = $massactionClass->initDefaultDiv($value, $key, $type, $table->table, $loadedData, $output);
	}
}

Once you have your template, you have to create the filter, you have to create the function "onProcessProductMassFilterproductType", where "Product" is corresponding to the data, "Filter" is the type of the added functionality (it could be "trigger" or "action"), and "productType" is the name of your filter.

// Create the function	
function onProcessProductMassFilterproductType(&$elements,&$query,$filter,$num){
	if(empty($filter['type']) || $filter['type']=='all') return;
	// If there is an element given, generally used when coming from a trigger
	if(count($elements)){
		foreach($elements as $k => $element){
			if($element->product_type!=$filter['type']) unset($elements[$k]);
		}
	}
	// Else there is no elements, so we get them from a request
	else{
		$db = JFactory::getDBO();
		$query->where[] = 'hk_product.product_type='.$db->Quote($filter['type']);
	 }
}

The following function count the number of results, it's displayed next to the selected filter. You have to name it "onCountProductMassFilterproductType", it's the same thing as before except that it's an onCount and not onProcess

function onCountProductMassFilterproductType(&$query,$filter,$num){
	$elements = array();
	// Call the main function to get the elements
	$this->onProcessProductMassFilterproductType($elements,$query,$filter,$num);
	return JText::sprintf('SELECTED_PRODUCTS',$query->count('hk_product.product_id'));
}

If you need to add an action or a trigger, it's working the same way.

You will just have to use the Trigger or Action functions instead of the Filter one.

To add a new data type, if you want to do mass actions on, for example, the discounts you can use the following code in your plugin:

	function onMassactionTableLoad(&$externalValues){
		$obj = new stdClass();
		$obj->table ='discount';
		$obj->value ='discount';
		$obj->text =JText::_('DISCOUNT');
		$externalValues[] = $obj;
	}

Details

Written by: Majri

Category: HikaShop

Published: 23 June 2013

Hits: 17613

Main Information

If you use one of our commercial versions, you will be able to enter the name and description in different languages. This feature requires to have JoomFish installed and can be activated in the configuration page, in the display tab. The languages available will be the ones in JoomFish. If you don't enter something for a translation, it will just use the default information in the Main information tab instead. After you click on save or apply an additional publish icon will appear next to the fields where you entered something in the languages tabs so that you can easily enable or disable them.

Additional Information

• Zone : You can restrict the Amazon payment method to a zone. By clicking on the edit icon, a popup will open enabling you to select a zone. You can also remove this limitation by clicking on the delete icon.
• Images : You can click on the edit icon to select one or several images to display next to the name of the Amazon payment method during the checkout process. Those images are stored in the folder media/com_hikashop/images/payment so you can easily add more of them by uploading your images to this folder via FTP.
• Shipping method : With this option you can select the shipping method for which this payment method will be available. For example, if you choose UPS, this payment method will only be usable if UPS is selected as shipping method. If another shipping method is selected, this payment method will not be displayed. Note: if you selected "None" or don't select any shipping method, this payment method will always be available.
• Currency : This option allows you to restrict Amazon to only some currencies. Note that on top of that, the Amazon method won't display for any currency not supported by Amazon.
• Access Key ID : Your Amazon access key ID that you'll find through your Amazon configuration pages.
• Secret Access Key : Your Amazon secret access key that you'll find through your Amazon configuration pages.
• Environment : The Sandbox environment is used for testing. Once you have tested the plugin, you can pass to a production phase and set the Environment option to Production.
• Debug : You can activate the debug mode of the Amazon payment plugin. If you do so, information about each notification received from Amazon will be logged in the payment log file. You can see and modify the location of this file in the configuration page of HikaShop
• Cancel URL : The URL you want your users to be redirected to when they cancel the order from the Amazon interface. By default, they will be redirected to the first step of the checkout process.
• Return URL : The URL you want your users to be redirected to when they finish their payment on the Amazon interface. By default, they will be redirected to the after_end page of the checkout process which will thank them for their order.
• Invalid status : Here, you can select the status to set to an order if the plugin receives a notification from Amazon for an order with an amount different from the order total or in a different currency. In that case, we highly recommend you to check your Amazon account, the order information, and maybe contact your customer, and decide yourself what to do with the order.
• Pending status : Here, you can select the status to set to an order if the plugin receives a pending notification from Amazon for an order. A pending notification means that the customer entered his payment information but that Amazon could not yet receive the funds. In that case, we highly recommend you to check your Amazon account, the order information, and maybe contact your customer, and decide yourself what to do with the order.
• Verified status : Here, you can select the status to set to an order if the plugin receives a successful completion notification from Amazon for an order.