Export HikaShop order after an order is created

This document explains how to export an order immediately after an order has been created in HikaShop. 

Required fields

The following is needed to export an order after it has been created in HikaShop:

  • A HikaShop order export template must exist in RO CSVI
  • The HikaShop RO CSVI Export plugin must be installed, active and the HikaShop order export template selected
  • A Mass Action trigger for "After an order is created" needs to be created

HikaShop order export template

The first step is to create a HikaShop order export template in CSVI. Follow these steps:

  1. Go to Components -> RO CSVI
  2. Click on Templates -> Templates
  3. Click on New to create the new template
  4. Give the template a name
  5. Set the Enabled field to Yes
  6. Set the Enable front-end/cron field to Yes
  7. Set a Secret key, this is needed to run all automated import/export
  8. Set the Operations to:
    HikaShop Order operations
  9. Fill in the rest of the template settings per your needs
  10. Save the template settings
  11. Go to Templates -> Fields
  12. Add the needed fields to your order export template

The destination of an export can be set to multiple locations:

  • Download
  • Save on server
  • Save on FTP server
  • Email

It will be good to know that the Download option cannot be used here because of the way the system works. It will not be much use either as you don't want the customer to get an export of the order.

 HikaShop CSVI Export plugin

This plugin is needed because this picks up the trigger by HikaShop and calls RO CSVI to run the export. The plugin can be downloaded from the Download -> CSVI Extensions page.

After the plugin is downloaded it needs to be installed and configured following these steps:

  1. Go to Extensions -> Manage
  2. Install the HikaShop CSVI export plugin
  3. Once the installation is finished, go to Extensions -> Plugins
  4. Filter the list on csvi export
  5. Click on the HikaShop CSVI Export name to edit the plugin
  6. Select the HikaShop order template created earlier from the list
    HikaShop RO CSVI Export plugin settings
  7. Enter the secret key that was set in the template in step 7
  8. Set the Status to Enabled
  9. Optionally set also if you want to use the order ID as filename
  10. Optionally set a file extension
  11. Save the plugin settings

Mass Action trigger

To ensure that an export is run after an order is created in HikaShop, a mass action needs to be created.

  1. Go to Components -> HikaShop
  2. Click on System -> Mass actions
  3. Click on New to create a new mass action rule
  4. Fill in the details as below. The name can be anything you like.
    Mass action after an order is created
  5. The other settings on the page are not needed.
  6. Save the Mass action

Ready for use

Now that everything is configured, the system is ready for use. The procedure that is being followed is this:

  1. Customer places an order in HikaShop
  2. HikaShop triggers the mass action "After on order is created"
  3. The trigger is picked up by the HikaShop CSVI Export plugin
  4. The plugin will trigger the RO CSVI template selected in the plugin
  5. The template will export the order placed by the customer