modules [osCMax and osCommerce documentation]

Modules

osCommerce comes standard with several payment and shipping modules. This section of the administration tool allows you to enable, disable, and configure your modules. This is where you select what payment methods you will have at your store, and what shipping options are available.

If you would like an option that is not available, there are dozens of other options available in the contributions section at osCommerce.com . Payment

This is the main payment module section. On this page, you will see a list of all currently installed payment modules in your store. Next to the module name, you will see a green icon and a red icon. To activate a module, click the green icon next to it. To deactivate a module, click the red icon next to it.

Once a payment module is active, you may have to configure that module with certain required information. If this is needed, click the payment module, then click the 'edit' button in the right column. Now, you will see all the available options for that module. we have taken the time to detail the options for each payment module below.

Standard Payment Modules

Authorize.net :: This module allows you to use Authorize.Net as your payment gateway for real-time credit card processing in osCommerce. The following options must be filled out properly in order for this module to work.

o Do you want to accept Authorize.net payments? :: Set this option to 'True'

        o Login Username :: Your Authorize.net username
        o Transaction Key :: The transaction key you set in Authorize.net admin.
        o Transaction Mode :: Set this to 'Test' or 'Production' depending on whether you are processing live transactions or still testing.
        o Transaction Method :: Set this to eCheck or Credit Card depending on the method you use.
        o Customer Notifications :: When enabled Authorize.Net will e-mail a receipt to the customer in addition to osCommerce.
        o Payment Zone :: Allows you to limit the use of Authorize.net to a single zone.
        o Set Order Status :: You can set the default order status to the store default, or set it to one of these: Delivered, Pending, Processing
        o Sort order of display :: This is where you set the order of the payment modules display on the checkout_payment.php page. Set this to a NON ZERO amount.

Credit Card :: This is the basic offline credit card processor included in osCommerce. This is good for TESTING ONLY. It is not secure, and stores parts of credit card numbers in plain text in the database. It sends other parts of credit card numbers in plain text via non-encrypted email. Please do not use this for any other than testing options. If you are using the Authorize.Net module, disable this module. There are several other options for offline credit card processing that use GPG or PGP encryption that can be found HERE. Those should be used instead. To configure this module, see below:

o Enable Credit Card Module :: Set to 'True' to enable.

        o Split Credit Card E-Mail Address :: Enter an email address here to enable the minimal security on this module. It will split the CC#, and send part to the listed email, and store the other part in the database. DO NOT MISTAKE THIS FOR SECURITY- IT IS NOT SECURE.
        o Payment Zone :: Allows you to limit the use of this module to a single zone.
        o Set Order Status :: You can set the default order status to the store default, or set it to one of these: Delivered, Pending, Processing
        o Sort order of display :: This is where you set the order of the payment modules display on the checkout_payment.php page. Set this to a NON ZERO number.

Cash on Delivery :: This is the basic COD payment module if you want to use this type of payment option. This is also good for testing your store. Configuration options are below:

o Enable Cash On Delivery Module :: Set to 'True' to enable.

        o Payment Zone :: Allows you to limit the use of this module to a single zone.
        o Set Order Status :: You can set the default order status to the store default, or set it to one of these: Delivered, Pending, Processing
        o Sort order of display :: This is where you set the order of the payment modules display on the checkout_payment.php page. Set this to a NON ZERO number.

iPayment :: This module allows osCommerce to connect to iPayment to process orders. See the configuration info below:

o Enable iPayment Module :: Set this option to 'True'

        o Account Number :: Your iPayment account number
        o User ID :: Your iPayment user ID
        o User Password :: Your iPayment password.
        o Transaction Currency :: Set this to the currency you will be using. There are 4 options and you must pick one:
              + Always EUR
              + Always USD
              + Either EUR or USD, else EUR
              + Either EUR or USD, else USD
        o Payment Zone :: Allows you to limit the use of Authorize.net to a single zone.
        o Set Order Status :: You can set the default order status to the store default, or set it to one of these: Delivered, Pending, Processing
        o Sort order of display :: This is where you set the order of the payment modules display on the checkout_payment.php page. Set this to a NON ZERO amount.

Check/Money Order :: If you would like to accept checks and money orders via snail mail, enable this module. This module gets the address information from the adress configured under 'My Store' in the Configuration section of the admin. The configuration options for this module are below:

o Enable Check/Money Order Module :: Set to 'True' to enable.

        o Payment Zone :: Allows you to limit the use of this module to a single zone.
        o Set Order Status :: You can set the default order status to the store default, or set it to one of these: Delivered, Pending, Processing
        o Sort order of display :: This is where you set the order of the payment modules display on the checkout_payment.php page. Set this to a NON ZERO number.
        o Make Payable To :: Enter the name that checks should be made out to

NOCHEX :: Enable this module to accept payment through NOCHEX. This module requires the GBP currency. Learn more about this at the NOCHEX website. Below are the configuration options for this module:

o Enable NOCHEX module :: Set to 'True' to enable.

        o E-Mail Address :: The e-mail address to use for the NOCHEX service
        o Payment Zone :: Allows you to limit the use of this module to a single zone.
        o Set Order Status :: You can set the default order status to the store default, or set it to one of these: Delivered, Pending, Processing
        o Sort order of display :: This is where you set the order of the payment modules display on the checkout_payment.php page. Set this to a NON ZERO number.

PayPal :: Enable this module to accept payments using PayPal. Learn more about this at the PayPal website. Below are the configuration options for this module:

o Enable PayPal module :: Set to 'True' to enable.

        o E-Mail Address :: The e-mail address to use for the PayPal service.
        o Transaction Currency :: The currency to use for credit card transactions. The following curencies are supported:
              + Selected Currency :: The current selected currency in the catalog
              + Only USD
              + Only CAD
              + Only EUR
              + Only GBP
              + Only JPY
        o Payment Zone :: Allows you to limit the use of this module to a single zone.
        o Set Order Status :: You can set the default order status to the store default, or set it to one of these: Delivered, Pending, Processing
        o Sort order of display :: This is where you set the order of the payment modules display on the checkout_payment.php page. Set this to a NON ZERO number.

2CheckOut :: Enable this module to accept payments using 2CheckOut. Learn more about this payment method at the 2CheckOut web site. Below are the configuration options for this module:

o Enable 2CheckOut Module :: Set to 'True' to enable.

        o Login/Store Number :: Login/Store Number used for the 2CheckOut service
        o Transaction Mode :: Transaction mode used for the 2Checkout service. This can be set to Test or Production. To run in Test mode you must also login to your store configuration, at 2CheckOut Admin: sales parameters, and set all Demo Modes to Yes.
        o Merchant Notifications :: Should 2CheckOut e-mail a receipt to the store owner? This can be set to True or False.
        o Payment Zone :: Allows you to limit the use of this module to a single zone.
        o Set Order Status :: You can set the default order status to the store default, or set it to one of these: Delivered, Pending, Processing
        o Sort order of display :: This is where you set the order of the payment modules display on the checkout_payment.php page. Set this to a NON ZERO number.

PSiGate :: Enable this module to accept payments using PSiGate merchant account. Learn more about this method of accepting payments at the PSiGate web site. Below are the configuration options for this module:

o Enable PSiGate Module :: Set to 'True' to enable.

        o Merchant ID :: Merchant ID used for the PSiGate service
        o Transaction Mode :: Transaction mode to use for the PSiGate service. You have the following options when setting this:
              + Production :: Use this setting when your site is live and accepting orders.
              + Always Good :: This is a test mode
              + Always Duplicate :: This is a test mode
              + Always Decline :: This is a test mode
        o Transaction Type :: Transaction type to use for the PSiGate service. You have three options, Sale, PreAuth, PostAuth. See the PSiGate docs for explanation of these options.
        o Credit Card Collection :: Set whether the credit card details should be collected locally or remotely at PSiGate. This can be set to local or remote.
        o Transaction Currency :: The currency to use for credit card transactions. This can be set to CAD or USD.
        o Payment Zone :: Allows you to limit the use of this module to a single zone.
        o Set Order Status :: You can set the default order status to the store default, or set it to one of these: Delivered, Pending, Processing
        o Sort order of display :: This is where you set the order of the payment modules display on the checkout_payment.php page. Set this to a NON ZERO number.

SECPay :: Enable this module to accept payments using SECPay. To learn more about this payment option, go to the SECPay Website. Below are the configuration options for this module:

o Enable SECPay Module :: Set to 'True' to enable.

        o Merchant ID :: Merchant ID to use for the SECPay service.
        o Transaction Currency :: The currency to use for credit card transactions. You can set this to Any Currency or Default Currency.
        o Transaction Mode :: Transaction mode to use for the SECPay service. This can be set to Always Successful, Always Fail, or Production.
        o Payment Zone :: Allows you to limit the use of this module to a single zone.
        o Set Order Status :: You can set the default order status to the store default, or set it to one of these: Delivered, Pending, Processing
        o Sort order of display :: This is where you set the order of the payment modules display on the checkout_payment.php page. Set this to a NON ZERO number.

Shipping

This is the main shipping module section. On this page, you will see a list of all currently installed shipping modules in your store. Next to the module name, you will see a green icon and a red icon. To activate a module, click the green icon next to it. To deactivate a module, click the red icon next to it.

Once a shipping module is active, you may have to configure that module with certain required information. If this is needed, click the shipping module, then click the 'edit' button in the right column. Now, you will see all the available options for that module. we have taken the time to detail the options for each shipping module below.

Currently in ?OsCommerce 2.2MS2, the store configuration area does not give access to 2 variables which are used internally to calculate the final shipping weight of an order at checkout, SHIPPING_BOX_WEIGHT (defaults to 3 as in 3lbs) and SHIPPING_BOX_PADDING (defaults to 10 as in 10%). To edit these values, find the respective configuration_key fields in the configuration table and edit the configuration_value. For more information on their usage see the file /catalog/includes/classes/shipping.php, method quote().

Flat Rate :: Use this module if you want to use a flat rate shippng rate per order. The following configuration options must be set:

o Enable Flat Shipping :: Set this to true to enable this module.

        o Shipping Cost :: Set the rate you want to charge per order.
        o Tax Class :: Set this to the tax class you want to use for this shipping method, or leave it set to none if you do not want to tax the shipping charge.
        o Shipping Zone :: If you set this to a zone, this method will only be available to orders shipping to that zone.
        o Sort Order :: This sets the sort order of your shipping methods during checkout. If you have more than one shipping method, set this to a non zero quantity. Lower numbers defined here will appear higher/first on the checkout shipping page.
        o Update :: Always click this button to commit your changes to osCommerce.

Per Item :: Use this module to set a 'Per Item' shipping charge. Set a base shipping rate, and that rate will be mutiplied by the number of items that the customer has in their shopping cart. The following options must be set:

o Enable Item Shipping :: Set this to true to enable this module.

        o Shipping Cost :: Set the rate you want to charge per item purchased.
        o Handling Fee :: Set the amount you want to charge for handling. This can be set to zero to deactivate the handling fee.
        o Tax Class :: Set this to the tax class you want to use for this shipping method, or leave it set to none if you do not want to tax the shipping charge.
        o Shipping Zone :: If you set this to a zone, this method will only be available to orders shipping to that zone.
        o Sort Order :: This sets the sort order of your shipping methods during checkout. If you have more than one shipping method, set this to a non zero quantity. Lower numbers defined here will appear higher/first on the checkout shipping page.
        o Update :: Always click this button to commit your changes to osCommerce.

Table Rate :: This shipping method allows you to set so called table rate shipping. This module allows you to set whether shipping will be charged based on weight or quantity. Further, you define shipping price breaks based on weight or quantity amounts. The following options need to be set for this module:

o Enable Table Method :: Set this to true to enable this module.

        o Shipping Table :: Set this option by following the example provided below.
        o Table Method :: Set this to weight or price.
        o Handling Fee :: Set the amount you want to charge for handling. This can be set to zero to deactivate the handling fee.
        o Tax Class :: Set this to the tax class you want to use for this shipping method, or leave it set to none if you do not want to tax the shipping charge.
        o Shipping Zone :: If you set this to a zone, this method will only be available to orders shipping to that zone.
        o Sort Order :: This sets the sort order of your shipping methods during checkout. If you have more than one shipping method, set this to a non zero quantity. Lower numbers defined here will appear higher/first on the checkout shipping page.
        o Update :: Always click this button to commit your changes to osCommerce.

EXAMPLE for Table Rate ShippingA store owner wants to charge $10 for orders weighing up to 20 lbs. Any orders over 20 lbs, but under 40 lbs are charged $18. To set this up using the table rate shipping method, the following must be entered into the 'Shipping Table' field of this module: 25:10.00,40:18.00

United Parcel Service :: If you want to ship using UPS, enable this module. It is also important to note that in order for shipping calculations to be done correctly, you must set the zip/postal code of your store corectly in the configuration section of osCommerce. The following options must be set:

o Enable UPS Shipping :: Set this to true to enable this module.

        o UPS Pickup Method :: This should be set to however your UPS packages are picked up. Your options are : CC - Customer Counter, RDP - Daily Pickup, OTP - One Time Pickup, LC - Letter Center, OCA - On Call Air
        o UPS Packaging :: Set this to the UPS Packaging method that you use. The following options are available : CP - Your Packaging, ULE - UPS Letter, UT - UPS Tube, UBE - UPS Express Box
        o Residential Delivery :: Set this to either RES or COM to have the module quote a residential or commercial shipping rate.
        o Handling Fee :: Set the amount you want to charge for handling. This can be set to zero to deactivate the handling fee.
        o Tax Class :: Set this to the tax class you want to use for this shipping method, or leave it set to none if you do not want to tax the shipping charge.
        o Shipping Zone :: If you set this to a zone, this method will only be available to orders shipping to that zone.
        o Sort Order :: This sets the sort order of your shipping methods during checkout. If you have more than one shipping method, set this to a non zero quantity. Lower numbers defined here will appear higher/first on the checkout shipping page.
        o Update :: Always click this button to commit your changes to osCommerce.

United States Postal Service :: To use USPS module, you first need an account with the USPS. If you do not have an account, you cannot use this module. The following options must be configured:

o Enable USPS Shipping :: Set this to true to enable this module.

        o Enter the USPS User ID :: This should be set to your USPS user ID
        o Enter the USPS Password :: This should be set to your USPS password
        o Which server to use :: Set this to either 'test' or 'production'
        o Handling Fee :: Set the amount you want to charge for handling. This can be set to zero to deactivate the handling fee.
        o Tax Class :: Set this to the tax class you want to use for this shipping method, or leave it set to none if you do not want to tax the shipping charge.
        o Shipping Zone :: If you set this to a zone, this method will only be available to orders shipping to that zone.
        o Sort Order :: This sets the sort order of your shipping methods during checkout. If you have more than one shipping method, set this to a non zero quantity. Lower numbers defined here will appear higher/first on the checkout shipping page.
        o Update :: Always click this button to commit your changes to osCommerce.

Zone Rates ::

Order Total

Low Order Fee ::

Shipping ::

Sub-Total ::

Tax ::

Total ::