Miva Merchant Module Functions Reference Manual

Miva Corporation

About This Manual

Overview
Who Should Read This Guide
Guide Organization
Related Publications

Introduction

Module Functions
Function Return Value
Requirement for Functions in the Module
Error Messages
Examples

Functions Required for All Modules

Introduction
Required Module Functions
Module_Type
Module_Code
Module_Name
Module_Provider
Module_API_Version
Module_Version
Module_Is_Wizardable
Module_Install
Module_Upgrade
Module_Upgrade_Store
Module_Uninstall
Module_Install_Store
Module_Uninstall_Store
Module_Pack_Store
Module_Is_Provisionable
Module_Provision
Module_Pack_Domain (4.1x)
Module_Domain_Tabs
Module_Domain_Content
Module_Domain_Validate
Module_Domain_Update

Configuration Functions

Introduction
Required Configuration Functions
Tabs
Content
Validate
Update
Delete
Category Functions
Module_Category_Tabs
Module_Category_Content
Module_Category_Validate
Module_Category_Update
Module_Category_Delete
Module_Category_BatchEdit_Validate (4.1x)
Module_Category_BatchEdit_Update (4.1x)
Product Functions
Module_Product_Tabs
Module_Product_Content
Module_Product_Validate
Module_Product_Update
Module_Product_Delete
Module_Product_BatchEdit_Validate (4.1x)
Module_Product_BatchEdit_Update (4.1x)
Store Functions
Module_Store_Tabs
Module_Store_Content
Module_Store_Validate
Module_Store_Update
Affiliates Functions
Module_Affiliates_Tabs
Module_Affiliates_Content
Module_Affiliates_Validate
Module_Affiliates_Update
Module_Affiliates_Delete (4.00 only)
Affiliate Functions (4.1x)
Module_Affiliate_Tabs (4.1x)
Module_Affiliate_Content (4.1x)
Module_Affiliate_Validate (4.1x)
Module_Affiliate_Update (4.1x)
Module_Affiliates_Delete (4.1x)
Module_Affiliate_BatchEdit_Validate (4.1x)
Module_Affiliate_BatchEdit_Update (4.1x)
Customer Functions (new in 4.14)
Module_Customer_Tabs (4.14)
Module_Customer_Content (4.14)
Module_Customer_Validate (4.14)
Module_Customer_Update (4.14)
Module_Customer_Delete (4.14)
Module_Customer_BatchEdit_Validate (new in 4.14)
Module_Customer_BatchEdit_Update (new in 4.14)
Module_Customer_Validate_Runtime (4.14)
Module_Customer_Update_Runtime (4.14)

Batch Reporting

Introduction
Required Functions
BatchReportModule_Report

Currency Modules

Introduction
Required Functions
CurrencyModule_AddFormatting
CurrencyModule_AddFormatPlainText
CurrencyModule_AddFormatPlainTextShort

Data Export Modules

Introduction
Required Functions
ExportModule_Validate
ExportModule_Export
ExportModule_Screen

Data Import Modules

Introduction
Required Functions
ImportModule_Validate
ImportModule_Import
ImportModule_Screen

Fulfillment Modules

Introduction
Required Functions
FulfillmentModule_ProcessOrder
FulfillmentModule_Invoice_Footer (4.1x)

Logging Modules

Introduction
Required Functions
Affiliate Login
Customer Login
Basket Information
Inventory
Order Information
Screens Displayed

Payment Processing Modules

Introduction
Required Functions
PaymentModule_Payment_Methods
PaymentModule_Payment_URL
PaymentModule_Payment_Description
PaymentModule_Payment_Message
PaymentModule_Payment_Hide_Additional_Fields
PaymentModule_Payment_Fields
PaymentModule_Payment_Prompt
PaymentModule_Payment_Invalid
PaymentModule_Payment_Field
PaymentModule_Payment_Validate
PaymentModule_Report_Description
PaymentModule_Report_Fields
PaymentModule_Report_Fields (4.14)
PaymentModule_Report_Label
PaymentModule_Report_Value
PaymentModule_Report_Value (4.14)
PaymentModule_Manipulate_Shipping
PaymentModule_Authorize
PaymentModule_Authorize (4.14)
PaymentModule_Process
PaymentModule_Process (4.14)
PaymentModule_Order_Validate
PaymentModule_Order_Delete
PaymentModule_Order_Delete (4.14)
PaymentModule_Order_Update
PaymentModule_Order_Update (4.14)
PaymentModule_Order_Tabs
PaymentModule_Order_Content
PaymentModule_Order_Content (4.14)
PaymentModule_Payment_Notice (4.1x)
PaymentModule_Payment_Icons (4.1x)
PaymentModule_Payment_Icon (4.1x)
PaymentModule_Invoice_Notice (4.1x)
PaymentModule_Invoice_Icon (4.1x)
PaymentModule_Invoice_Notice_PlainText_Formated (4.1x)
PaymentModule_Upgrade_Order (new in 4.14)
PaymentModule_LeftNavigation (new in 4.15)

Shipping Modules

Introduction
Required Functions
ShippingModule_Description
ShippingModule_Report_Fields
ShippingModule_Report_Label
ShippingModule_Report_Value
ShippingModule_Shipping_Methods
ShippingModule_Calculate_Basket
ShippingModule_Order_Validate
ShippingModule_Order_Update
ShippingModule_Order_Delete
ShippingModule_Order_Tabs
ShippingModule_Order_Content
ShippingModule_Shipping_Notice (4.1x)
ShippingModule_Shipping_Icons (4.1x)
ShippingModule_Shipping_Icon (4.1x)
ShippingModule_Invoice_Notice (4.1x)
ShippingModule_Invoice_Icon (4.1x)
ShippingModule_Invoice_Notice_PlainText_Formated (4.1x)

System Extension Modules

Introduction
Required Functions
SystemModule_Action_Customer_Login
SystemModule_Action_Customer_EmailPassword
SystemModule_Action_Customer_Update
SystemModule_Action_Customer_Insert
SystemModule_Action_AddProductToBasket
SystemModule_Action_AddUpsoldProductToBasket
SystemModule_Action_UpdateQuantity
SystemModule_Action_RemoveProductFromBasket
SystemModule_Action_Save_OrderInformation
SystemModule_Action_CalculateTax
SystemModule_Action_CalculateShipping
SystemModule_Action_AuthorizePayment
SystemModule_Action_Affiliate_Login
SystemModule_Action_Affiliate_Update
SystemModule_Action_Affiliate_EmailPassword
SystemModule_Action_Affiliate_Insert
SystemModule_Action_New
SystemModule_Screens
SystemModule_Action_AdjustInventory

Tax Modules

Introduction
Required Functions
TaxModule_Order_Hide_Fields
TaxModule_Order_Fields
TaxModule_Order_Prompt
TaxModule_Order_Required
TaxModule_Order_Invalid
TaxModule_Order_Field
TaxModule_Order_Validate
TaxModule_Calculate_Basket

User Interface Modules

Introduction
Required Functions
UIModule_Product_Attributes
UIModule_Order_BasketChanged
UIModule_Upsell_Attributes
UIModule_Upsell_Multiple_Attributes
UIModule_Upsell_Selected_Too_Many
UIModule_Invalid_CustomerLogin
UIModule_Invalid_CustomerEmail
UIModule_CustomerEmail_Sent
UIModule_Invalid_InsertCustomerInformation
UIModule_Invalid_UpdateCustomerInformation
UIModule_Invalid_OrderInformation
UIModule_Invalid_Payment
UIModule_Authorization_Failure
UIModule_Invoice
UIModule_Dispatch
UIModule_StoreSelection_Thumbnail
UIModule_StoreSelection_Preview
UIModule_StoreSelection_Validate
UIModule_StoreSelection_Update
UIModule_StoreSelection_Tabs
UIModule_StoreSelection_Content
UIModule_Store_Thumbnail
UIModule_Store_Preview
UIModule_Store_Import_KoolCat
UIModule_Category_Import_KoolCat
UIModule_OrderAlreadyProcessed
UIModule_Store_Links
UIModule_Category_Links
UIModule_Product_Links
UIModule_Store_Offline
Functions Added in 4.0
UIModule_Product_Limited
UIModule_Product_Out
UIModule_AffiliateEmail_Sent
UIModule_AffiliateManage
UIModule_Invalid_AffiliateEmail
UIModule_Invalid_AffiliateLogin
UIModule_Invalid_InsertAffiliateInformation
UIModule_Invalid_UpdateAffiliateInformation
UIModule_ScreenURL
UIModule_NewStoreScreen_Begin
UIModule_NewStoreScreen_End

Store Utility Modules

Introduction
Required Functions
StoreUtilityModule_Action
StoreUtilityModule_Validate
StoreUtilityModule_Screen
StoreUtilityModule_LeftNavigation

Store Wizard and Wizard Modules

Introduction
Subordinate Modules
Required Functions
StoreWizard Module Functions
StoreWizardModule_Title
StoreWizardModule_Icon
StoreWizardModule_Logo
StoreWizardModule_Privileges
StoreWizardModule_Validate_Step
StoreWizardModule_Validate
StoreWizardModule_Content
StoreWizardModule_Action
Wizard Functions Used in Subordinate Modules
Module_Wizard_Predefined_Available
Module_Wizard_Predefined_Validate
Module_Wizard_Predefined_Action
Module_Wizard_Validate_Step
Module_Wizard_Validate
Module_Wizard_Action
Module_Wizard_Content
Module_Wizard_Summary_Fields
Module_Wizard_Summary_Prompt
Module_Wizard_Summary_Field
Javascript Functions
Wizard_Next()
Wizard_Previous()
[Store]Wizard_Finish()
Wizard_Skip(steps)
Wizard_Goto(step, validate)
Module_Wizard_Next()
Module_Wizard_Previous()
Module_Wizard_Finish()
[Store]WizardModule_Title()
[Store]WizardModule_Icon()
[Store]WizardModule_Logo()
[Store]WizardModule_Validate_Step(step)
[Store]WizardModule_Validate
[Store]WizardModule_Action
[Store]WizardModule_Content(step, load_fields)
Support Functions in admin.mv
Wizard_BeginScreen(logo, title)
Wizard_EndScreen()
Wizard_FieldError(step, field, message)
Wizard_Module_FieldError(step, field, message)
Wizard_Module_HideFields()
Functions Required for Wizard Modules
WizardModule_Title
WizardModule_Icon
WizardModule_Logo
WizardModule_Privileges
WizardModule_Validate_Step
WizardModule_Validate
WizardModule_Action
WizardModule_Content

Complete Functions List By Module

Introduction
Functions List