Vendor Administration

Written by Peter Osipof. Posted in User Guide

{typography icon type="storno" boxstyle="float: none; margin: 5px;"}THIS PART OF VirtueMart STILL IS NOT COMPLETE. IT'S NOT RECOMMENDED TO USE THIS FEATURE.

Vendors and Vendor Categories represent the top most tier of VirtueMart administration. Through vendor administration, the store keeper is able to manage products, users, and orders by vendor or supplier.

[TODO - heirarchial drawing]

For simple stores where there are only a few products offered, vendor administration is not necessarily needed, but for larger more complex stores, such as an online mall, vendor administration can be essential.

Since all products, product categories, users, and orders are associated to the vendor record, establishing the vendor and vendor category structure is the first step to building the online store.

Note that it is not necessary to create the vendor categories first. Vendors can be re-associated to vendor categories after all the vendor records have been created. However, creating the vendor category records first can save some extra work if you already know how you want to categorize your vendors.

Vendor Categories

Vendor categories are a way to classify the types of goods and services that vendors offer on your site. For example, you may have an online mall for buying and selling furniture. You may want to create vendor categories such as "Antiques", "Office Furniture", and "Patio Furniture".

Note that a vendor on your site can only be associated with a single vendor category, so it is important to use categories that are broad enough to represent the shopper's choice of storefronts. For example, "Antique Furniture" and "Vintage Clothing" would not be broad enough categories if you have a vendor that sells both types of items. In this case, you might want to use "Antiques" as your vendor category.

VirtueMart creates the vendor category name "-default-" upon installation. It is not necessary to change this unless you choose to fully utilize the vendor category functionality.

Browsing Vendor Categories

The Vendor Category List can be accessed in the Vendor Menu ("Vendor" ⇒ "List Vendor Categories"). You may easily navigate to the vendor list by clicking on the linked text "list" in the "Vendors" column of the Vendor Category List.

VirtueMart Administration: Vendor List for a Category

Figure 4.71. VirtueMart Administration: Vendor List for a Category


This will open the Vendor List page.

Adding Vendor Categories

To create a new vendor category, select "Vendor | Add Vendor Category" from the VirtueMart admin interface.

This will bring up the Vendor Category Form.

VirtueMart Administration: Vendor Category Form

Figure 4.72. VirtueMart Administration: Vendor Category Form


Vendor Category Form

Vendor Category Form Fields
Vendor Category Name

The name used to identify the vendor category.

Vendor Category Description

The description of the vendor category.

Click on the "Save" button.

You will be redirected to the "Vendor Category List" page, showing the "-default-" category, and the new category you just entered.

VirtueMart Administration: Vendor Category List

Figure 4.73. VirtueMart Administration: Vendor Category List


Vendor Category List

You may also add a new vendor category with the Vendor Category Form by clicking on the "New" button in the toolbar.

4.9.1.3. Editing Vendor Categories

To edit an existing vendor category, select "Vendor | List Vendor Categories" in the VirtueMart admin menu. This will return the Vendor Category List screen (shown above). Click on the linked text showing the name of the vendor category you would like to edit to bring up the Vendor Category Form.

When you have finished making changes, click on the "Save" button. You will be redirected back to the "Vendor Category List" screen.

4.9.1.4. Deleting Vendor Categories

If you remove a vendor category all vendors in that category will be reassigned to the "-default-" vendor category that was created upon installation. You can then re-associate the affected vendors if needed, as described below under "Vendors".

To delete a vendor category just go to the Vendor Category List screen. Click on the trash can icon in the "Remove" column next to the name of the vendor category you would like to delete.

VirtueMart Administration: Vendor Category Deletion

Figure 4.74. VirtueMart Administration: Vendor Category Deletion


Vendor Category Deletion

Click 'OK' to confirm deletion of this category.

Vendors

Vendors are the main organizational factor in VirtueMart. Products and product categories, billing options, etc. are all configured per-vendor.

Upon installation, a global, default vendor is created. This special case cannot be deleted, and is managed separately via the "Store | Edit Store" menu option.

If you are running a shopping site for a single vendor (for example, if you are the only vendor that will be offering products in your store) then there is no need to create additional vendors. If, however, you will be running an online mall site that will be host to several vendors, then create one vendor account for each storefront owner.

It may be worth noting here that you should not confuse vendors with manufacturers. A single vendor may have a different manufacturer for each product that they offer. If the person supplying the products on your site will be managing their own shipping, etc., then they are a vendor. If you will be managing these aspects, then the supplier is a manufacturer. (See Manufacturer Administration for more information on that topic).

Adding a Vendor

To create a new vendor, select "Vendor | Add Vendor" in the VirtueMart admin menu.

Edit the following fields in the Vendor Information Form:

Full Image

Required

Displays the currently configured store logo.

Upload Image

Optional

Browse to the vendor's company logo. This will be uploaded when you click on the "Save" icon.

Currency

The vendor's global / default Currency

Minimum purchase order value

This is the amount which is the minimum Order Value for Checkout.

Minimum Amount for Free Shipping

This is the amount, from which on Shipping is free.

Currency symbol

This is the currency symbol which will be used when displaying prices.

Decimals

Number of decimals.

Decimal symbol

Can be somethin like . , or empty.

Thousands separator
Positive format

Display Order / Style for positive numbers.

Negative format

Display Order / Style for negative numbers.

Description

This is the Vendor Store's Description which is shown on the page shop.index.

Terms of Service

This is the complete text for your Terms of Service that is displayed to the customer.

Store Name

Required

The name of the Vendor Store.

Store Company Name

Required

The name of the vendor company.

URL

the vendor's Internet Address.

Address 1

Address Line 1

Address 2

Address Line 2

City

The City where the vendor is located.

State/Province/Region

The State / Region where the vendor is located.

Country

The Country where the vendor is located.

Zip/Postal Code

The ZIP of the vendor's location.

Phone

The Vendor's Phone Number

Last, First & Middle Name

The Name of the Vendor's Contact Person.

Title

The title of the Contact Person.

Phone 1 & 2

Vendor's contact's Phone number.

Fax

The Fax number for the Contact.

Email Address

Primary Vendor contact email address

Click the "Save" icon to create your new vendor.

Editing Vendors

To edit an existing vendor, select "Vendor | List Vendors" to see a list of all vendors. You may also get to this screen by clicking on the linked text, "list", in the Vendors column on the Vendor Category List screen.

Click on the name of the vendor you would like to edit, or click on the linked text "update" in the Admin column - either will take you to the same Vendor Add Information form. Make your changes in the Vendor "Add Information" form (described above), and click on the "Save" icon. You will be returned to the Vendor List screen.

Deleting Vendors

Since vendors represent the top most tier of site management, deletion of vendors should be avoided unless absolutely necessary.

Before deleting an existing vendor, all products, product categories, users, and orders associated to that vendor must be removed through either deletion or re-association to another vendor. VirtueMart will not allow the deletion of a vendor while these child records still exist for that vendor.

Once these child records have been removed, select "Vendor | List Vendors" to see a list of all vendors. Then click on the name of the vendor you would like to delete. In the Vendor Add Information form, click on the "Remove" icon. You will be returned to the Vendor List screen.

Once this vendor has been deleted, it is removed from the system. To recover this vendor, you must re-create the vendor information, and re-associate all appropriate product categories and products.

Shipping Modules

Written by Peter Osipof. Posted in User Guide

Standard Shipping
UPS Shipping Module
USPS Shipping Module
Intershipper Shipping
Zone Shipping

Standard Shipping

It is wise first of all to think about how you will charge for postage and packing. The easiest way is to have a fixed shipping price for all of your products, but this is not always practical – especially if your products vary greatly in size and/or weight.

Not only do you need to think about shipping rates, but also shipping methods. Will you offer more than one shipping method – eg. next day delivery as well as standard? DHL as well as Royal Mail?

Even if you decide to only use one company for all of your shipping, you still need to tell VirtueMart about it. To set up a new ‘shipper’, select ‘Create Shipper’ from the ‘Shipping’ menu. This takes you to shipper editor.

VirtueMart Administration: Shipper Form

Figure 4.75. VirtueMart Administration: Shipper Form

 

List order is just a numeric value which is used to sort the shipper names, so enter 1 for the shipper that you want to be listed 1st, 2 for the one you want to be listed 2nd, etc.

When you have added the shipping companies you want to use, you need to configure the shipping rates. You can set up different rates for different service levels (eg. next day, two day, first class etc.) or according to the weight of the shipment. You can also select whether to add VAT to the shipping rate or not. All of this takes place in the Shipping Rate Editor – see next figure.

To edit or delete existing shipping rates, select ‘Shipping Rates’ from the ‘Shipping’ menu.

VirtueMart Administration: Shipping Rate List

Figure 4.76. VirtueMart Administration: Shipping Rate List

 

By clicking on the name of a shipping rate in this list, you can access the shipping rate form to edit this shipping rate. To add a new shipping rate, click the "New" button in the toolbar.

VirtueMart Administration: Shipping Rate Form

Figure 4.77. VirtueMart Administration: Shipping Rate Form

 

In this form you can specify the details of the shipping rate.

Shipping Rate Description

This is the name of the Shipping Rate, displayed to the customer in the checkout.

List Order

The order of this shipping rate in the list of all other shipping rates (numeric value).

Shipper

Select the carrier for this shipping rate.

Country

The country/countries this shipping rate applies to. Shoppers from other countries won't be able to select this shipping rate.

ZIP Range Start

The lowest ZIP / Postcode this shipping rate is valid for. Leave empty if you're using non-numeric values!

ZIP Range End

The highest ZIP / Postcode this shipping rate is valid for. Leave empty if you're using non-numeric values!

Lowest Weight

The lowest total weight in cart this shipping rate is valid for.

Highest Weight

The highest total weight in cart this shipping rate is valid for.

Fee

The Fee for this shipping rate = the costs.

Package Fee

The package fee = additional costs for packaging.

Currency

The currency, which applies to the costs you have filled in above.

VAT ID

Here you can select a tax rate which is applied to this shipping rate. If you select "none", no tax will be applied.

Payment Methods

Written by Peter Osipof. Posted in User Guide

The area of payment processing can get a bit complicated, and it might be best to leave this to your web designer to sort out if possible. If you are able to use one of the payment processing companies that are already supported by VirtueMart, it will make life a lot easier (you will need to sign-up with a payment processor yourself – the program won’t do that for you!). You can see the options available by clicking on the List Payment Methods icon on the store summary, or by selecting List Payment Methods from the Store menu.

Payment Method Management
Add and Edit Payment Methods
Pre-Configured Payment Methods
PayPal
Worldpay
Authorize.net
2Checkout
 

Payment Method Management

VirtueMart Administration: Payment Method List

Figure 4.78. VirtueMart Administration: Payment Method List

 

It is possible to create a new payment method (there is a ‘New’ toolbar button), but you may to hack the VirtueMart code in order to make use of it (not for the faint-hearted!)

The configuration options for each payment method are different – depending on what is required by that payment service provider. Usually your payment service provider will give you some kind of code, key, or user name which needs to be entered in the Payment Method Editor.

The Payment Method Editor consists of 2 tabs – the first of which you will probably not need to touch. The next Figure shows the 2nd tab (‘Configuration’), which varies depending on the payment service provider, and the example shown here is for WorldPay.

Add and Edit Payment Methods

VirtueMart Administration: Payment Method Editor

Figure 4.79. VirtueMart Administration: Payment Method Editor

 

Some payment processors will allow you to specify a script to be run on successful completion of a payment. Such a script could be used to automatically update the order status in VirtueMart so that you don’t have to manually tie up all of your online receipts with your product orders.

Another advantage of this process is that when you're selling downloadable files, you don't have to set the Order Status that enables the Download (this sends out the Download-ID email) manually. This is done automatically by the script.

See the Section "Pre-Configured Payment Methods" for more details on specific payment gateways.

Other payment service providers may use different methods of automatically notifying you when a payment is received. Again, it is probably easiest to get your web designer to sort out the requirements for this, but if you need to do it yourself, check with your payment service provider as to what their requirements are. Often, automatic notification is referred to as ‘IPN’ or ‘Instant Payment Notification’.


Pre-Configured Payment Methods

VirtueMart already comes with several Payment Modules that allow accepting payments from customers after a short time for setting them up with your Account Details.

PayPal

www.paypal.com

PayPal integration is made using a Webform that transfers the customer to the PayPal site.

VirtueMart Administration: Paypal Configuration Screen

Figure 4.80. VirtueMart Administration: Paypal Configuration Screen


This payment method allows automatic Order Status Updates. There's a file in /administrator/components/com_virtuemart/ which is called notify.php. You will need to enter the appropriate URL (web address) for the script file in PayPal’s control panel. When a customer finishes the Payment, the PayPal server connects to this script on your server. When the transaction AND the payment have been successful, the order status is automatically updated to the status you have set in the PayPal configuration form.

4.12.3.2. Worldpay

www.worldpay.com

Worldpay integration is made using a Webform that transfers the customer to the Worldpay site.

Allows automatic Order Status Updates. There's a file in /administrator/components/com_virtuemart/ which is called worldpay_notify.php. You will need to enter the appropriate URL (web address) for the script file in WorldPay’s control panel. When a customer finishes the Payment, Worldpay copnnects to this script on your server and when the transaction AND the payment have been successful, updates the order status.

4.12.3.3. authorize.net

www.authorize.net

This payment module uses the authorize.net AIM method, which means that the customers stay on your site and enter all Credit Card details. When the order is being completed, the Payment Module connects with authorize.net and tries to initiate the Money Transfer using the Payment Details of the buyer and your account details that you have set up in the configuration panel for authorize.net.

4.12.3.4. 2Checkout

http://www.2checkout.com

This payment module acts very similar to the PayPal Payment Module: It transfers the customer to www.2Checkout.com where all payment details can be entered. After that the customer is directed back to your site. But before you must make the following steps:

  1. Fill in your details for 2Checkout in your Shop, "Store" ⇒ "Payment List" ⇒ "2Checkout".

    For the field Secret word just choose a secret word (without spaces!! max. 16 characters), fill it in and keep it in mind.

  2. Login to your 2Checkout account at www.2checkout.com.

  3. Go to the section called "Look and Feel".

  4. Fill in "https://YOUR_JOOMLA_URL/2checkout_notify.php" into the fields Approved URL and Pending URL

  5. Fill in the secret word from Step 1 into the Field Secret Word.

  6. Move the file YOUR_JOOMLA_PATH/administrator/components/com_virtuemart/2checkout_notify.php to

    YOUR_JOOMLA_PATH/2checkout_notify.php

    (means into the Mambo root)

When those steps have been completed, you can use 2Checkout with automatic Order Status updates on your site.

4.12.3.5. eWay

www.eway.com.au

This payment module implements the eWAY XML Payment Solution.

The customers stay on your site and enter all Credit Card details. When the order is being completed, the Payment Module connects with the eWay gateway and tries to initiate the Money Transfer using the Payment Details of the buyer.

4.12.3.6. Paymate

TODO

4.12.3.7. eProcessingNetwork.com

www.eProcessingNetwork.com

See section "authorize.net".

4.12.3.8. NoChex

TODO

4.12.3.9. PayMeNow

TODO

Reports

Written by Peter Osipof. Posted in User Guide

VirtueMart comes with a basic and self-explaining Report Module. It allows you to view the product sales of a specific time range.

Coupon Administration

Written by Peter Osipof. Posted in User Guide

You can access the list of coupons from the menu: "Coupons" ⇒ "Coupon List".

VirtueMart Administration: Coupon List

Figure 4.81. VirtueMart Administration: Coupon List

 

Here is where you can add, modify or remove existing coupons.

To add a new coupon, click the "new" button in the toolbar. The coupon form shows up.

VirtueMart Administration: Coupon Form

Figure 4.82. VirtueMart Administration: Coupon Form

 

Now you need to fill in the necessary value for the new coupon:

Coupon Code

This is the "code" a customer needs to fill in to redeem this coupon. This can be a simple word or a secret string with numbers and characters.

Percent or Total

Here you can choose wether the coupon value is a percentage of the cart total or a fixed total value.

Coupon Type

There are two types of coupons: Gift Coupons and Permanent Coupons. Gift Coupons are removed from the database once they have been used to place an order. Permanent Coupons can be used for campaigns, because they can be used again and again until you remove them from the coupon list.

Value

This is the numeric discount value of this coupon.

Don't forget to save your changes and you're done!