Miva Merchant Database & Utility Functions Reference Manual

Miva Corporation

Chapter 1 About This Manual

Overview
Who Should Read This Guide
Guide Organization
Related Publications
Requirements
Receive Support

Chapter 2 Database Functions

Introduction
Administration Functions
AdminSession_Delete
AdminSession_Find_Session
AdminSession_Insert
AdminSession_Update
Attribute Functions
Attribute_Delete
Attribute_Find_Code
Attribute_Find_ID
Attribute_FindFirst_Product
Attribute_FindNext_Product
Attribute_Insert
Attribute_Update
Attribute_Update_Order
Availability Group Functions
AvailabilityGroup_Category_FindNext_Assigned
AvailabilityGroup_Category_FindNext_Unassigned
AvailabilityGroup_Category_FindOffset_Assigned
AvailabilityGroup_Category_FindOffset_Unassigned
AvailabilityGroup_Customer_FindNext_Assigned
AvailabilityGroup_Customer_FindNext_Unassigned
AvailabilityGroup_Customer_FindOffset_Assigned
AvailabilityGroup_Customer_FindOffset_Unassigned
AvailabilityGroup_Delete
AvailabilityGroup_Find_ID
AvailabilityGroup_Find_Name
AvailabilityGroup_FindFirst
AvailabilityGroup_FindFirst_Offset
AvailabilityGroup_FindNext
AvailabilityGroup_Insert
AvailabilityGroup_Product_FindNext_Assigned
AvailabilityGroup_Product_FindNext_Unassigned
AvailabilityGroup_Product_FindOffset_Assigned
AvailabilityGroup_Product_FindOffset_Unassigned
AvailabilityGroup_Update
AvailabilityGroupXCategory_Delete
AvailabilityGroupXCategory_Find
AvailabilityGroupXCategory_FindFirst_Category
AvailabilityGroupXCategory_FindNext_Category
AvailabilityGroupXCategory_Insert
AvailabilityGroupXCustomer_Delete
AvailabilityGroupXCustomer_Find
AvailabilityGroupXCustomer_FindFirst_AvailabilityGroup
AvailabilityGroupXCustomer_FindNext_AvailabilityGroup
AvailabilityGroupXCustomer_Insert
AvailabilityGroupXProduct_Delete
AvailabilityGroupXProduct_Find
AvailabilityGroupXProduct_Insert
Basket Functions
Basket_Delete
Basket_Delete_AllLines
Basket_Delete_Line
Basket_Find_Line
Basket_FindFirst_ID
Basket_FindNext_ID
Basket_Insert
Basket_Quantity
Basket_Total
Basket_TotalQuantity
Basket_Update_Quantity
Basket_Weight
BasketCharge_DeleteAll_Module
BasketCharge_Insert
BasketCharge_FindFirst_Charge
BasketCharge_FindFirst_Module
BasketCharge_FindFirst_Type
BasketCharge_FindNext_Charge
BasketCharge_FindNext_Module
BasketCharge_FindNext_Type
BasketCharges_Delete_Type
BasketList_FindFirst
BasketList_FindNext
BasketList_FindSession
BasketList_Free_Order
BasketList_MakeDirty
BasketList_Insert
BasketList_Save_Order_Info
BasketList_Update_Customer
BasketList_Update_LastUpdate
BasketList_Update_Payment
BasketList_Update_Shipping
BasketList_Update_Tax
BasketOption_FindFirst_Line
BasketOption_FindNext_Line
BasketOption_Insert
Batch Functions
Batch_Create
Batch_Delete
Batch_Find_ID
Batch_FindFirst
Batch_FindNext
Category Functions
Category_Delete
Category_Find_Code
Category_Find_ID
Category_FindFirst
Category_FindFirst_Offset
Category_FindOffset_Search
Category_FindFirst_Parent
Category_FindID_Parent
Category_FindNext
Category_FindNext_All
Category_FindNext_Parent
Category_FindOffset_All
Category_Insert
Category_Product_FindNext_Assigned
Category_Product_FindNext_Unassigned
Category_Product_FindOffset_Assigned
Category_Product_FindOffset_Unassigned
Category_Sort
Category_Update
Category_Update_Order
CategoryXProduct_Delete
CategoryXProduct_Find
CategoryXProduct_Insert
CategoryXProduct_Sort
CategoryXProduct_Update_Order
Country Functions
Country_Find_Alpha
Country_FindFirst
Country_FindNext
Country_Insert
Customer Functions
Customer_Category_Find_Code
Customer_Category_Find_ID
Customer_Category_FindFirst_Parent
Customer_Category_FindID_Parent
Customer_Category_FindNext_Parent
Customer_Category_FindFirst_Product
Customer_Category_FindNext_Product
Customer_Delete
Customer_Find_ID
Customer_Find_Login
Customer_FindFirst
Customer_FindFirst_Offset
Customer_FindNext
Customer_FindNext_All
Customer_FindNext_Words
Customer_FindOffset_All
Customer_Insert
Customer_Product_Find_Code
Customer_Product_Find_ID
Customer_Product_FindFirst
Customer_Product_FindNext
Customer_Product_FindFirst_Category
Customer_Product_FindNext_Category
Customer_Product_FindFirst_Offset
Customer_Product_FindNext_Words
Customer_Product_FindOffset_Category
Customer_Product_FindOffset_Words
Customer_Update
CustomerEmail_Load
CustomerEmail_Update
Group Functions
Group_Delete
Group_Find_Name
Group_FindFirst
Group_FindNext
Group_Insert
Group_Update
Group_User_FindNext_Assigned
Group_User_FindNext_Unassigned
Group_User_FindOffset_Assigned
Group_User_FindOffset_Unassigned
GroupPrivilege_Find
GroupPrivilege_Insert
GroupPrivilege_Update
Key Functions
Key_Delete
Key_Generate
Key_Insert
Module Functions
Module_Decrement_ReferenceCount
Module_Delete
Module_Find_Code
Module_Find_ID
Module_FindFirst
Module_FindFirst_Type
Module_FindNext
Module_FindNext_Type
Module_Increment_ReferenceCount
Module_Insert
Module_Update
OpenDataFiles
Option Functions
Option_Delete
Option_Find_Code
Option_Find_ID
Option_FindFirst_Attribute
Option_FindNext_Attribute
Option_Insert
Option_Update
Option_Update_Order
Order Functions
Order_Count_Batch
Order_Create_From_Basket
Order_Delete
Order_Find_ID
Order_FindFirst_Batch
Order_FindFirst_Batch_Unprocessed
Order_FindNext_Batch
Order_FindNext_Batch_Unprocessed
Order_Update
Order_Update_Payment
Order_Update_Processed
Order_Update_Shipping
OrderCharge_FindFirst_Charge
OrderCharge_FindFirst_Type
OrderCharge_FindNext_Charge
OrderCharge_FindNext_Type
OrderCharges_Delete
OrderItem_FindFirst_Order
OrderItem_FindNext_Order
OrderOption Functions
OrderOption_FindFirst_Line
OrderOption_FindNext_Line
Price Group Functions
PriceGroup_Customer_FindNext_Assigned
PriceGroup_Customer_FindNext_Unassigned
PriceGroup_Customer_FindOffset_Assigned
PriceGroup_Customer_FindOffset_Unassigned
PriceGroup_Delete
PriceGroup_Find_ID
PriceGroup_Find_Name
PriceGroup_FindFirst
PriceGroup_FindFirst_CustomerProduct
PriceGroup_FindFirst_Offset
PriceGroup_FindNext
PriceGroup_FindNext_CustomerProduct
PriceGroup_Insert
PriceGroup_Product_FindNext_Assigned
PriceGroup_Product_FindNext_Unassigned
PriceGroup_Product_FindOffset_Assigned
PriceGroup_Product_FindOffset_Unassigned
PriceGroup_Update
PriceGroupXCustomer_Delete
PriceGroupXCustomer_Find
PriceGroupXCustomer_Insert
PriceGroupXProduct_Delete
PriceGroupXProduct_Find
PriceGroupXProduct_Insert
Privilege Functions
Privilege_Delete
Privilege_Find
Privilege_FindFirst
Privilege_FindNext
Privilege_Insert
Product Functions
Product_Delete
Product_Find_Code
Product_Find_ID
Product_FindFirst
Product_FindFirst_AvailabilityGroup
Product_FindFirst_AvailabilityGroupCount
Product_FindFirst_Category
Product_FindFirst_CategoryCount
Product_FindFirst_Code_NonExact
Product_FindFirst_Offset
Product_FindFirst_PriceGroup
Product_FindNext
Product_FindNext_All
Product_FindNext_AvailabilityGroup
Product_FindNext_AvailabilityGroupCount
Product_FindNext_Category
Product_FindNext_CategoryCount
Product_FindNext_Code_NonExact
Product_FindNext_PriceGroup
Product_FindNext_Uncategorized
Product_FindNext_Words
Product_FindOffset_All
Product_FindOffset_Category
Product_FindOffset_Uncategorized
Product_FindOffset_Words
Product_Insert
Product_Sort
Product_Update
Product_Update_Order
Related Products
RelatedProduct_CheckAssigned
RelatedProduct_Customer_FindFirst_Product
RelatedProduct_Customer_FindNext_Product
RelatedProduct_Delete
RelatedProduct_Find_ID
RelatedProduct_FindNext_All
RelatedProduct_FindNext_Assigned
RelatedProduct_FindNext_Unassigned
RelatedProduct_Insert
State Functions
State_Delete
State_Empty
State_Find_Code
State_FindFirst
State_FindFirst_Offset
State_FindNext
State_FindNext_All
State_FindOffset_All
State_Insert
State_Update
Store Functions
Store_Close
Store_Count
Store_Create
Store_Delete
Store_ExpireBaskets
Store_Find_Code
Store_Find_ID
Store_FindFirst
Store_FindFirst_User
Store_FindNext
Store_FindNext_User
Store_License_In_Use
Store_Open
Store_Pack
Store_Update
StoreCountry_Country_FindOffset_Unassigned
StoreCountry_Country_FindNext_Unassigned
StoreCountry_Country_FindNext_Assigned
StoreCountry_Country_FindOffset_Assigned
StoreCountry_Delete
StoreCountry_Find
StoreCountry_Find_Alpha
StoreCountry_Find_ID
StoreCountry_FindFirst_Alpha
StoreCountry_FindNext_Alpha
StoreCountry_Insert
StoreKey_Delete
StoreKey_Generate
StoreKey_Insert
StoreModule_Decrement_ReferenceCount
StoreModule_Delete
StoreModule_Find_ID
StoreModule_FindFirst
StoreModule_FindFirst_Type
StoreModule_FindNext
StoreModule_FindNext_Type
StoreModule_Increment_ReferenceCount
StoreModule_Insert
StoreModule_Installed
Upsell Functions
Upsell_Delete
Upsell_Delete_UpsellProductInBasket
Upsell_Find_Eligable_Product
Upsell_Find_Eligible_Product
Upsell_Find_Product_ID
Upsell_FindFirst
Upsell_FindNext
Upsell_FindNext_All
Upsell_FindOffset_All
Upsell_Increment_Score
Upsell_Insert
Upsell_Product_FindNext_Assigned
Upsell_Product_FindNext_Unassigned
Upsell_Product_FindOffset_Assigned
Upsell_Product_FindOffset_Unassigned
Upsell_Required_FindFirst
Upsell_Required_FindNext
Upsell_RequiredProduct_Find
Upsell_Update
UpsellBatchEdit_Update
UpsellEdit_Delete
UpsellOptions_Update
UpsellOptions_Find
UpsellXProduct_Delete
UpsellXProduct_Find
UpsellXProduct_FindFirst
UpsellXProduct_FindNext
UpsellXProduct_Insert
User Functions
User_Check_Privileges
User_Count_Admin
User_Delete
User_Find_ID
User_Find_Name
User_FindFirst
User_FindFirst_Offset
User_FindNext
User_FindNext_All
User_FindOffset_All
User_Insert
User_Is_Admin
User_Is_Manager
User_Update
UserXGroup_Delete
UserXGroup_Find
UserXGroup_FindFirst_Group
UserXGroup_FindNext_Group
UserXGroup_Insert
UserXStore_Decrement_Groups
UserXStore_Delete_Store
UserXStore_Delete_User
UserXStore_Increment_Groups
UserXStore_Set_Manager
Miscellaneous Functions
CloseDataFiles
CreateDataFiles
DeleteDataFiles
Domain_Update
PackDataFiles

Chapter 3 Utility Functions

General Utility Functions
Adjusted_Price
CanI
Category_Tree
Country_Select
DetermineSessionID
DrawCheckbox
DrawOption
DrawOption_SelectOne
DrawRadio
Email_Add_AngleBrackets
Email_Validate
Error
Format_Address
Format_Date
Format_Time
Format_Time_Short
Module_Select
OrderMinimumsMet
Phone_Validate
Screen_BasketChanged
State_Select
StoreCountry_Select
Zip_Validate
Log Action Functions
Log_Action_AddProductToBasket
Log_Action_AddUpsoldProductToBasket
Log_Action_AuthorizePayment
Log_Action_CalculateShipping
Log_Action_CalculateTax
Log_Action_Customer_EmailPassword
Log_Action_Customer_Insert
Log_Action_Customer_Login
Log_Action_Customer_Update
Log_Action_RemoveProductFromBasket
Log_Action_Save_OrderInformation
Log_Action_UpdateQuantity
Log Screen Functions
Log_Screen_BasketContents
Log_Screen_Category
Log_Screen_CustomerCreate
Log_Screen_CustomerEdit
Log_Screen_CustomerLogin
Log_Screen_Invoice
Log_Screen_Order_CustomerInformation
Log_Screen_Order_Payment
Log_Screen_Order_SelectShippingPayment
Log_Screen_Order_UpsoldProduct
Log_Screen_Product
Log_Screen_ProductAttributes
Log_Screen_ProductList
Log_Screen_Search
Log_Screen_StoreFront
Log_Screen_UpsoldProductAttributes