| QWK | QwkShip |
Documentation for version 1.061005.
Copyright © 2004-2005, QwkSoft.
QwkShip allows you to define any number of shipping methods and display them in any order. Each method can be configured to calculate shipping based on weight, purchase price or number of items in the basket.
Each method can be configured to ignore certain products ( electronic downloads, for example ) or to be unavailable if certain products are part of the order.
Each methods can be configured to be available only for orders shipped to certain countries or states, or mark unavailable to certain countries and states.
handling charges can be set on a per product basis either globally or on a per-method basis.
Additional custom fields can specified and those fields displayed at arbitrary points in processing
The QwkSoft QwkSoft Advanced Shipping distribution contains 5 files: qwkship.mvc, qwkship_s.mvc, qwkship_l.mvc, qwkship_sh.mvc and qwkship.html (this documentation file). Install the *.mvc files in your domain and store as usual for Miva Merchant modules. Please refer to the documentation for your version of Miva Merchant for more information.
note: if you are using a non-compiled version of Miva Merchant you will need the non-compiled version of this module. That distribution contains *-nc.mv files in place of *.mvc files.QwkSoft QwkSoft Advanced Shipping is a Store Utility module. It also uses System Extension, Logging and Shipping modules that must be installed in the store, but have no databases or settings of their own. Store Utilities Screen
This module places 18 tabs on the Store Utilities screen. This screen can be reached from the left navigation bar by selecting Stores->your store name-> and then selecting this module.
(Some tabs may not be visible at all times)
Lists Method records.
Click the [add] link on the right side of the header line to add a new record.
Click the [edit] link on the right side of a line to edit the record.
Check one or more boxes in the delete column on the left of the list and click the update button at the bottom of the list to delete the selected records.
Click the [up] or [down] link in the order column to move the record up or down in the list.
View, add or edit Method record.
Each shipping method describes a different option that the customer has for the delivery of their order. For example, you might have an option for overnight delivery that is fairly expensive, and a less expensive option for slower delivery.
You can sent limits to what methods are available to the customer. For example you can define an inexpensive option that is available to customers in the same country and a more expensive option that is only available to foreign customers, or define some methods as being unavailable if certain products are included in the order.
Displayed on lists and on reports for internal use
Displayed on in the select list during checkout
Displayed to customers during checkout and on the invoice
This determines how the shipping charge is calculated:
| Options | |
| Quantity |
The shipping charge is based on the total number of items in the order. |
| Weight |
The shipping charge is based on the total weight of items in the order. |
| Price |
The shipping charge is based on the total price of items in the order |
| Flat |
The shipping charge is fixed regardless of the items in the order |
For flat rate shipping methods, this is the total shipping charge. For other shipping methods this charge is added to the calculated charge. This can be useful if you have a shipping charge structure such as $5 dollars to ship the first item, plus $1 for each additional item, or if you need to quickly increase your shipping costs at all order levels.
Indicates which basket charges will be included when calculating shipping. This only applies to Price Based shipping methods.
| Options | |
| none |
Basket charges are not included |
| all |
All basket charges except tax and shipping are included |
| listed |
Only basket charges of the type(s) listed below are included |
| not listed |
All basket charges except tax, shipping and those listed below are included |
A comma delimited list of basket charge types to be included or excluded from the total when calculating shipping.
Defines which countries this shipping method works for, based on shipping address:
| Options | |
| Any Country |
Do not restrict shipping based on location. |
| Countries Listed |
Allow this method only for orders shipped to countries on the Countries Tab. |
| Countries Not Listed |
Do not allow this method for orders shipped to countries on the Countries Tab. |
Defines which states this shipping method works for, based on shipping address:
| Options | |
| Any State |
Do not restrict shipping based on location. |
| States Listed |
Allow this method only for orders shipped to states on the States Tab. |
| States Not Listed |
Do not allow this method for orders shipped to countries on the States Tab. |
Designates this method as a fallback method to be displayed only when the order qualifies for no non-fallback methods. You can specify multiple fallback methods and all normal criteria apply. This means that you can set a fallback method for domestic order and a separate fallback method for foreign orders.
If no fallback methods are specified, or the order fails to qualify for any of the fallback methods, then no methods will be returned by this module. This may or may not evoke Miva Merchant's handling of orders with no available shipping methods depending on what other shipping modules you have installed do.
Typically you would designate a single fallback method to act as a place-holder, give it a best-guess shipping calculation, and configure the description to indicate that the shipping was only an estimate.
Another possibility would be to define a single non-fallback method that kicks in under very specific circumstances ( e.g., a price-base method that gives free shipping for orders over $500 ) and define all other methods as fallbacks.
Lists Break records.
Check one or more boxes in the delete column on the left of the list and click the update button at the bottom of the list to delete the selected records.
Click <-prev or next-> in the footer to move backwards or forward a page. Enter a new value in the field label "page" to change the number of records per page.
Breaks define the boundaries at which various shipping charges apply, and what the those charges are.
Lists Global Product records.
Click the [add] link on the right side of the header line to add a new record.
Click the [edit] link on the right side of a line to edit the record.
Check one or more boxes in the delete column on the left of the list and click the update button at the bottom of the list to delete the selected records.
Click <-prev or next-> in the footer to move backwards or forward a page. Enter a new value in the field label "page" to change the number of records per page.
These are product settings which apply to all shipping methods.
View, add or edit Global Product record.
These are product settings which apply to all shipping methods.
self explanatory.
self explanatory.
Lists Global Charge records.
Click the [add] link on the right side of the header line to add a new record.
Click the [edit] link on the right side of a line to edit the record.
Check one or more boxes in the delete column on the left of the list and click the update button at the bottom of the list to delete the selected records.
Click the [up] or [down] link in the order column to move the record up or down in the list.
Click <-prev or next-> in the footer to move backwards or forward a page. Enter a new value in the field label "page" to change the number of records per page.
These are charges which apply to all shipping methods.
View, add or edit Global Charge record.
These are charges which apply to all shipping methods.
Internal identifier.
self explanatory.
| Options | |
| SHIPPING |
Applied only when a QwkShip Shipping Method is selected. |
| OTHER | |
self explanatory.
self explanatory.
self explanatory.
Lists Method Product records.
Click the [add] link on the right side of the header line to add a new record.
Click the [edit] link on the right side of a line to edit the record.
Check one or more boxes in the delete column on the left of the list and click the update button at the bottom of the list to delete the selected records.
Click <-prev or next-> in the footer to move backwards or forward a page. Enter a new value in the field label "page" to change the number of records per page.
These are product settings which apply to a single shipping method.
View, add or edit Method Product record.
These are product settings which apply to a single shipping method.
self explanatory.
self explanatory.
Lists Method Charge records.
Click the [add] link on the right side of the header line to add a new record.
Click the [edit] link on the right side of a line to edit the record.
Check one or more boxes in the delete column on the left of the list and click the update button at the bottom of the list to delete the selected records.
Click the [up] or [down] link in the order column to move the record up or down in the list.
Click <-prev or next-> in the footer to move backwards or forward a page. Enter a new value in the field label "page" to change the number of records per page.
These are Charges which apply to a single shipping method.
View, add or edit Method Charge record.
These are Charges which apply to a single shipping method.
Internal identifier.
self explanatory.
| Options | |
| SHIPPING |
Included in shipping total shown in checkout. |
| OTHER |
Not included in shipping total shown in checkout. |
self explanatory.
self explanatory.
self explanatory.
Lists Country records.
Check one or more boxes in the delete column on the left of the list and click the update button at the bottom of the list to delete the selected records.
Click <-prev or next-> in the footer to move backwards or forward a page. Enter a new value in the field label "page" to change the number of records per page.
The availability of this shipping method is limited based on the countries listed here. It may be limited to only the countries listed, or to only the countries not listed depending on the setting in the Allow Shipping To field on the Method Edit tab.
Lists State records.
Check one or more boxes in the delete column on the left of the list and click the update button at the bottom of the list to delete the selected records.
Click <-prev or next-> in the footer to move backwards or forward a page. Enter a new value in the field label "page" to change the number of records per page.
The availability of this shipping method is limited based on the states listed here. It may be limited to only the states listed, or to only the states not listed depending on the setting in the Allow Shipping To field on the Method Edit tab.
Lists Extra Fields records.
Click the [add] link on the right side of the header line to add a new record.
Click the [edit] link on the right side of a line to edit the record.
Check one or more boxes in the delete column on the left of the list and click the update button at the bottom of the list to delete the selected records.
Click the [up] or [down] link in the order column to move the record up or down in the list.
Click <-prev or next-> in the footer to move backwards or forward a page. Enter a new value in the field label "page" to change the number of records per page.
This list defines extra data to be collected at some point in the order process. Where the data is collected is defined on the Screens tab.
View, add or edit Extra Fields record.
This list defines extra data to be collected at some point in the order process. Where the data is collected is defined on the Screens tab.
This is used internally to name the field, and in the generated HTML as part of the field name. The full field name will be "QwkShip_Field:code".
The label appears in the first column of the display table.
Select the type of input field you want:
| Options | |
| memo |
A textarea field. |
| text |
A text field. |
| checkbox |
A check box |
| date |
A date entry field |
Designates that the customer must entered data for the field.
Used for text fields only, this specifies the size attribute of the input tag. If this is omitted, the size tag will also be omitted
CSS class for the input element. If omitted the input element will not have a class attribute. If you want to apply a class to a label, you should include that as part of the label text.
The note appears in the second column of the display table, immediately after the input field. You can use this as a trailing label to duplicate MMUI's convention for labeling checkboxes, or to include extra information for the user.
Lists Screen records.
Click the [add] link on the right side of the header line to add a new record.
Click the [edit] link on the right side of a line to edit the record.
Check one or more boxes in the delete column on the left of the list and click the update button at the bottom of the list to delete the selected records.
Click <-prev or next-> in the footer to move backwards or forward a page. Enter a new value in the field label "page" to change the number of records per page.
View, add or edit Screen record.
Each entry defines a screen for collecting extra data. The extra data fields are defined on the Extra Data tab.
The overall layout of the screen is in four parts. The first part is the standard page header as generated by the UI module. The second is the header as defined below. The third part is a two-column table with labels in the first column and input fields in the second column, and a submit button ( which can be suppressed ) in the last row of the table. The fourth part is the footer as defined below.
Screens can be generated at certain intercept points as specified below. You can also cause then to display semi-automatically by calling your store pathScreen=NEW&QwkShip_Screen=code. For example if you have described a screen with a code of "EXTRA" you might link to http://your.store.com/Merchant2/merchant.mvc?Store_code=test&Screen=NEW&QwkShip_Screen=EXTRA.
The Miva Merchant action code for the action you want to intercept to display this screen, or an arbitrary code that you will reference in an external link. Interception occurs after the indicated action. This field is case sensitive, and Miva Merchant action must be in all caps, as shown below:
| ALGI | Affiliate Login |
| UAFL | Affiliate Update |
| IAFL | Affiliate Insert |
| AFPW | Affiliate Email Lost Password |
| LOGN | Customer Login |
| EMPW | Customer Email Lost Password |
| UCST | Customer Update |
| ICST | Customer Insert |
| ADPR | Add Product To Basket |
| AUPR | Add Upsold Product To Basket |
| QNTY | Update Quantity |
| RPRD | Remove Product From Basket |
| ORDR | Save Order Information |
| CTAX | CalculateTax |
| SHIP | Calculate Shipping |
| AUTH | Authorize Payment |
An internal identifier for your use.
text or HTML code to be displayed at the top of the Screen
A comma delimited list of the code for fields you want to appear on this screen, in the order they should appear. Fields not defined on the Extra Fields tab will not be displayed. If you leave this blank, then by default all of the field defined on the Extra Fields tab will be displayed in the order specified on that screen.
Determines how the submit button will be displayed on the Screen
The text that will be displayed on the Submit Button, if it's a text style button.
The image to be displayed as the Submit Button, if it's an image style button.
text or HTML code to be displayed at the top of the Screen
Enter licensing information here. Please note that once you have entered your license information this tab will no longer be visible.
Enter the license number that you were issued when you purchased this software.
Check this box if you have read and and agree to the EULA. You must agree to the EULA to use this software.