MultiMerch 8.x Developer Reference

This reference is intended to provide MultiMerch developers with information on core MultiMerch structures and systems.

For a more detailed reference, see MultiMerch code comments.

Updated in April, 2018 for MultiMerch 8.14.3.

MultiMerch application directory structure

MultiMerch follows OpenCart's regular MVC system with a number of additional files and directories.

+---admin < Admin-area MultiMerch MVC
|   +---controller < Admin-area MultiMerch controllers 
|   |   +---module < Module controllers
|   |   |       multimerch.php < Core MultiMerch controller (setup & setting management)
|   |   |       multimerch_newsellers.php < New sellers module controller
|   |   |       multimerch_topsellers.php < Top sellers module controller
|   |   |       
|   |   +---multimerch < Interface controllers (admin-area MultiMerch pages) 
|   |   |   |   attribute.php < Attribute management
|   |   |   |   badge.php < Badge management
|   |   |   |   base.php
|   |   |   |   category.php < Category management
|   |   |   |   conversation.php < Conversation management
|   |   |   |   coupon.php < Coupon management
|   |   |   |   custom-field.php < Custom fields
|   |   |   |   dashboard.php < Dashboards
|   |   |   |   debug.php < Debug info
|   |   |   |   event.php < Events
|   |   |   |   import.php < Import management
|   |   |   |   option.php < Options
|   |   |   |   order.php < Orders
|   |   |   |   payment-gateway.php < Payment gateways
|   |   |   |   payment-request.php < Payment requests
|   |   |   |   payment.php < Payments
|   |   |   |   payout.php < Payouts
|   |   |   |   product.php < Products
|   |   |   |   question.php < Product questions
|   |   |   |   reportbase.php < Report base controller
|   |   |   |   review.php < Reviews
|   |   |   |   seller-group.php < Seller groups
|   |   |   |   seller.php < Sellers
|   |   |   |   settings.php < Settings
|   |   |   |   shipping-method.php < Shipping methods
|   |   |   |   social_link.php < Social media links
|   |   |   |   suborder-status.php < Suborders
|   |   |   |   transaction.php < Transactions
|   |   |   |   
|   |   |   +---payment < MultiMerch payment method controllers
|   |   |   |       bank_transfer.php < BT
|   |   |   |       paypal.php < PayPal
|   |   |   |       
|   |   |   \---report < Individual report controllers
|   |   |           finances-payment.php < Payment reports
|   |   |           finances-payout.php < Payout reports
|   |   |           finances-seller.php < Seller reports
|   |   |           finances-transaction.php < Transaction reports
|   |   |           sales-customer.php < Sales reports
|   |   |           sales-day.php
|   |   |           sales-month.php
|   |   |           sales-product.php
|   |   |           sales-seller.php
|   |   |           sales.php
|   |   |           
|   |   +---payment < MultiMerch payment extensions for OpenCart
|   |   |       ms_pp_adaptive.php < MultiMerch PayPal Adaptive payment gateway controller
|   |   |       
|   |   \---total < MultiMerch order totals
|   |           mm_shipping_total.php
|   |           ms_coupon.php
|   |           
|   +---language < Admin-area MultiMerch language files
|   |   \---en-gb
|   |       +---module
|   |       |       multimerch.php
|   |       |       multimerch_newsellers.php
|   |       |       multimerch_topsellers.php
|   |       |       
|   |       +---multimerch
|   |       |   \---payment
|   |       |           bank_transfer.php
|   |       |           paypal.php
|   |       |           
|   |       +---multiseller
|   |       |       multiseller.php < Core admin-area MultiMerch language file
|   |       |       
|   |       +---payment
|   |       |       ms_pp_adaptive.php
|   |       |       
|   |       \---total
|   |               mm_shipping_total.php
|   |               ms_coupon.php
|   |               
|   +---model < Admin-area MultiMerch models
|   |   \---multimerch
|   |           install.php < MultiMerch setup routines
|   |           upgrade.php < MultiMerch upgrade routines
|   |           
|   \---view < Admin-area MultiMerch views and scripts
|       +---image <..> < Various MultiMerch images
|       |   |   
|       |   \---multiseller <..>
|       |       |   
|       |       \---payment <..>
|       |               
|       +---javascript < Admin-area MultiMerch JavaScripts
|       |   \---multimerch
|       |       |   attribute.js < Attribute listing
|       |       |   category-form.js < Single category edit form
|       |       |   category.js < Category listing
|       |       |   common.js < Common MultiMerch scripts
|       |       |   coupon.js < Coupon listing
|       |       |   custom-field-form.js < Single custom field edit form
|       |       |   custom-field.js < Custom field listing
|       |       |   dashboard.js < Dashboard scripts
|       |       |   moment.min.js
|       |       |   option.js < Option listing
|       |       |   payment-form.js < Payment execution form (payouts)
|       |       |   payment-request.js < Invoice listing
|       |       |   payment.js < Payment listing
|       |       |   payout-confirm.js < Payout confirmation form
|       |       |   payout-view.js < Single payout views
|       |       |   payout.js < Payout listing
|       |       |   question.js < Question listing
|       |       |   review.js < Review listing
|       |       |   settings.js < MultiMerch settings
|       |       |   
|       |       +---chartjs <..>
|       |       |       
|       |       +---datatables <..>
|       |       |           
|       |       +---daterangepicker <..>
|       |       |       
|       |       +---report < Individual MultiMerch report scripts
|       |       |       date_ranges.js
|       |       |       finances-payment.js
|       |       |       finances-payout.js
|       |       |       finances-seller.js
|       |       |       finances-transaction.js
|       |       |       report_datatables.js
|       |       |       sales-customer.js
|       |       |       sales-day.js
|       |       |       sales-month.js
|       |       |       sales-product.js
|       |       |       sales-seller.js
|       |       |       sales.js
|       |       |       
|       |       \---tag-editor <..>
|       |               
|       +---stylesheet < Admin-area MultiMerch styles
|       |   \---multimerch
|       |       |   dashboard.css < Dashboard styles
|       |       |   multiseller.css < Core styles
|       |       |   
|       |       \---payment
|       |               bank_transfer.css
|       |               
|       \---template < Admin-area MultiMerch templates
|           +---module < Module templates (new/top sellers)
|           |       multimerch_newsellers.tpl
|           |       multimerch_topsellers.tpl
|           |       
|           +---multimerch < MultiMerch core templates (new structure)
|           |   |   dashboard.tpl < Dashboard page
|           |   |   settings.tpl < Setting page
|           |   |   
|           |   +---payment < MultiMerch payment method templates
|           |   |       bank_transfer.tpl < Bank Transfer module configuration form
|           |   |       bank_transfer_payment_form.tpl< Bank Transfer payment form
|           |   |       bank_transfer_settings_form.tpl < Bank Transfer setting form
|           |   |       paypal.tpl < PayPal module configuration form
|           |   |       paypal_payment_form.tpl < PayPal MassPay payment form
|           |   |       paypal_settings_form.tpl < PayPal setting form
|           |   |       paypal_standard_payment_form.tpl < PayPal Standard payment form
|           |   |       
|           |   \---report < MultiMerch report templates
|           |           finances-payment.tpl
|           |           finances-payout.tpl
|           |           finances-seller.tpl
|           |           finances-transaction.tpl
|           |           sales-customer.tpl
|           |           sales-day.tpl
|           |           sales-month.tpl
|           |           sales-product.tpl
|           |           sales-seller.tpl
|           |           sales.tpl
|           |           
|           +---multiseller < MultiMerch core templates (old structure)
|           |       attribute.tpl
|           |       badge-form.tpl
|           |       badge.tpl
|           |       category-form.tpl
|           |       category.tpl
|           |       conversation.tpl
|           |       conversation_view.tpl
|           |       coupon.tpl
|           |       custom-field-form.tpl
|           |       custom-field-group-form.tpl
|           |       custom-field.tpl
|           |       debug.tpl
|           |       dialog-withdrawal-markpaid.tpl
|           |       event.tpl
|           |       import-list.tpl
|           |       option.tpl
|           |       order.tpl
|           |       payment-form.tpl
|           |       payment-gateway.tpl
|           |       payment-request.tpl
|           |       payment.tpl
|           |       payout-confirm.tpl
|           |       payout-view.tpl
|           |       payout.tpl
|           |       product.tpl
|           |       question-form.tpl
|           |       question.tpl
|           |       review-form.tpl
|           |       review.tpl
|           |       seller-form.tpl
|           |       seller-group-form.tpl
|           |       seller-group.tpl
|           |       seller.tpl
|           |       shipping-method-form.tpl
|           |       shipping-method.tpl
|           |       social_link.tpl
|           |       social_link_form.tpl
|           |       suborder-status-form.tpl
|           |       suborder-status.tpl
|           |       transaction-form.tpl
|           |       transaction.tpl
|           |       
|           +---payment < PayPal Adaptive settings
|           |       ms_pp_adaptive.tpl
|           |       
|           \---total < Order total settings
|                   mm_shipping_total.tpl
|                   ms_coupon.tpl
|                   
+---catalog < Catalog-area MultiMerch MVC
|   +---controller < Catalog-area MultiMerch controllers
|   |   +---account < Customer account / common account MultiMerch controllers
|   |   |       msconversation.php < Conversation management controller (My conversations)
|   |   |       msmessage.php < Individual message management controller (View conversation)
|   |   |       register-seller.php < Register seller Step 1 controller
|   |   |       
|   |   +---catalog < Front autocomplete controllers
|   |   |       filter.php < Filter autocomplete
|   |   |       product.php < Related product autocomplete
|   |   |       
|   |   +---customer < Customer review management
|   |   |       review.php
|   |   |       
|   |   +---module < Front module controllers (new/top sellers)
|   |   |       multimerch_newsellers.php
|   |   |       multimerch_topsellers.php
|   |   |       
|   |   +---multimerch 
|   |   |   |   account_account.php < OpenCart customer account controller override
|   |   |   |   account_order.php < OpenCart customer order list controller override
|   |   |   |   cart_coupon.php < Cart coupon controller
|   |   |   |   checkout_shipping_method.php < MultiMerch shipping method controller (Step 4 checkout)
|   |   |   |   module_account.php < OpenCart account sidebar controller override
|   |   |   |   product_question.php < Product question tab (product page)
|   |   |   |   product_review.php < Product review tab (product page)
|   |   |   |   product_shipping.php < Product shipping tab (product page)
|   |   |   |   
|   |   |   \---payment < MultiMerch payment method controllers (front)
|   |   |           bank_transfer.php
|   |   |           paypal.php
|   |   |           
|   |   +---payment < PayPal Adaptive controller (front)
|   |   |       ms_pp_adaptive.php
|   |   |       
|   |   +---seller < Core MultiMerch seller account controllers
|   |   |   |   account-attribute.php < Attribute management
|   |   |   |   account-category.php < Category management
|   |   |   |   account-coupon.php < Coupon management
|   |   |   |   account-dashboard.php < Seller's dashboard
|   |   |   |   account-import.php < Mass product imports
|   |   |   |   account-option.php < Option management
|   |   |   |   account-order.php < Order management
|   |   |   |   account-payment-request.php < Invoice management
|   |   |   |   account-payment.php < Payment management
|   |   |   |   account-product.php < Product management
|   |   |   |   account-profile.php < Seller's profile edit form
|   |   |   |   account-question.php < Product question management
|   |   |   |   account-review.php < Product review management
|   |   |   |   account-setting.php < Seller's settings
|   |   |   |   account-stats.php < Seller stats
|   |   |   |   account-transaction.php < Transactions
|   |   |   |   account.php < Base account controller (common routines)
|   |   |   |   catalog-seller.php < Catalog controller (list of sellers, seller's profile and store)
|   |   |   |   catalog.php < Base catalog controller (common routines)
|   |   |   |   report.php < Base report controller (common routines)
|   |   |   |   
|   |   |   \---report < Seller report controllers (Account > Reports)
|   |   |           finances-payment.php
|   |   |           finances-payout.php
|   |   |           finances-transaction.php
|   |   |           sales-day.php
|   |   |           sales-month.php
|   |   |           sales-product.php
|   |   |           sales.php
|   |   |           
|   |   \---startup < MultiMerch core startup controllers
|   |           multimerch_seo_microdata.php < SEO microdata controller
|   |           multimerch_seo_url.php < MultiMerch SEO core controller
|   |           
|   +---language < MultiMerch catalog language files
|   |   \---en-gb
|   |       +---multimerch
|   |       |   |   import-export.php
|   |       |   |   
|   |       |   \---payment
|   |       |           bank_transfer.php
|   |       |           paypal.php
|   |       |           
|   |       +---multiseller
|   |       |       multiseller.php < Core MultiMerch catalog language file
|   |       |       
|   |       \---payment
|   |               ms_pp_adaptive.php
|   |               
|   +---model < MultiMerch catalog models (OC compatibility + shipping totals)
|   |   +---catalog
|   |   |       option.php
|   |   |       
|   |   +---localisation
|   |   |       length_class.php
|   |   |       order_status.php
|   |   |       weight_class.php
|   |   |       
|   |   +---payment
|   |   |       ms_pp_adaptive.php
|   |   |       
|   |   \---total
|   |           mm_shipping_total.php
|   |           ms_coupon.php
|   |           
|   \---view < Catalog-area MultiMerch views and scripts
|       +---javascript < MultiMerch JavaScripts
|       |   |   account-product-form.js < Seller's product listing form scripts
|       |   |   account-seller-profile.js < Seller's profile edit form scripts
|       |   |   account-settings.js < Seller settings
|       |   |   dialog-sellercontact.js < Contact seller dialog
|       |   |   ms-common.js < Common scripts
|       |   |   ms-question.js
|       |   |   ms-review.js
|       |   |   pagination.min.js
|       |   |   star-rating.js
|       |   |   
|       |   +---multimerch < Core MultiMerch JavaScripts (new structure)
|       |   |   |   account-attribute.js
|       |   |   |   account-category-form.js
|       |   |   |   account-category.js
|       |   |   |   account-coupon-form.js
|       |   |   |   account-coupon.js
|       |   |   |   account-customer-product-review.js
|       |   |   |   account-dashboard.js
|       |   |   |   account-import.js
|       |   |   |   account-message.js
|       |   |   |   account-option.js
|       |   |   |   account-payment-form.js
|       |   |   |   account-product-form-options.js
|       |   |   |   account-question.js
|       |   |   |   account-register-seller.js
|       |   |   |   account-review.js
|       |   |   |   account-seller-setting.js
|       |   |   |   common.js
|       |   |   |   moment.min.js
|       |   |   |   ms-google-map.js
|       |   |   |   Sortable.js
|       |   |   |   
|       |   |   +---chartjs <..>     
|       |   |   +---ckeditor <..>                   
|       |   |   +---datatables <..>    
|       |   |   +---daterangepicker <..>
|       |   |   +---googlemap <..>
|       |   |   |               
|       |   |   +---report < MultiMerch report scripts (Account > Reports)
|       |   |   |       date_ranges.js
|       |   |   |       finances-payment.js
|       |   |   |       finances-payout.js
|       |   |   |       finances-transaction.js
|       |   |   |       report_datatables.js
|       |   |   |       sales-day.js
|       |   |   |       sales-month.js
|       |   |   |       sales-product.js
|       |   |   |       sales.js
|       |   |   |       
|       |   |   +---selectize <..>   
|       |   |   \---summernote <..>
|       |   |           
|       |   \---plupload <..>
|       |                   
|       \---theme < MultiMerch catalog template files
|           \---default
|               +---image <..>
|               |       
|               +---stylesheet < MultiMerch catalog-area styles
|               |   |   multimerch_messaging.css
|               |   |   multimerch_social_links.css
|               |   |   multiseller.css < Core MultiMerch stylesheet
|               |   |   pagination.css
|               |   |   star-rating.css
|               |   |   
|               |   \---multimerch
|               |       |   account-dashboard.css < MultiMerch seller's dashboard styles
|               |       |   account.css
|               |       |   bootstrap-nav-wizard.css
|               |       |   flags.css
|               |       |   import.css
|               |       |   
|               |       \---invoice
|               |               default.css
|               |               
|               \---template < MultiMerch catalog-area templates
|                   +---account
|                   |       register-seller.tpl < Register seller Step 1 form
|                   |       
|                   +---customer
|                   |       review.tpl < Customer account > Leave a review form
|                   |       
|                   +---module
|                   |       multimerch_newsellers.tpl
|                   |       multimerch_topsellers.tpl
|                   |       
|                   +---multimerch < Core MultiMerch templates (new structure)
|                   |   +---account < OpenCart template overrides
|                   |   |       account.tpl < New customer account page
|                   |   |       order.tpl < New customer order history page
|                   |   |       order_info.tpl < Order info > Order details by seller block
|                   |   |       
|                   |   +---checkout < MultiMerch checkout templates
|                   |   |       cart_coupon.tpl
|                   |   |       shipping_method.tpl < Vendor shipping Step 4
|                   |   |       
|                   |   +---module
|                   |   |       account.tpl < MultiMerch account sidebar template
|                   |   |       
|                   |   +---payment < MultiMerch payment method templates (catalog-area)
|                   |   |       bank_transfer.tpl < Bank Transfer settings (seller account)
|                   |   |       bank_transfer_payment_form.tpl < Bank Transfer payment form (seller payments)
|                   |   |       paypal.tpl < PayPal settings (seller account)
|                   |   |       paypal_payment_form.tpl < PayPal MassPay payment form (seller payments)
|                   |   |       paypal_standard_payment_form.tpl < PayPal Standard payment form (seller payments)
|                   |   |       
|                   |   \---seo < MultiMerch SEO microdata templates
|                   |       \---microdata
|                   |               product.tpl
|                   |               
|                   +---multiseller < Core MultiMerch templates (old structure), account-* indicate seller account templates
|                   |   |   account-attribute-form.tpl
|                   |   |   account-attribute-group-form.tpl
|                   |   |   account-attribute.tpl
|                   |   |   account-category-form.tpl
|                   |   |   account-category.tpl
|                   |   |   account-conversation.tpl
|                   |   |   account-coupon-form.tpl
|                   |   |   account-coupon.tpl 
|                   |   |   account-dashboard.tpl
|                   |   |   account-message.tpl
|                   |   |   account-option-form.tpl
|                   |   |   account-option.tpl
|                   |   |   account-order-info-conversation.tpl < Conversation block within order details
|                   |   |   account-order-info.tpl
|                   |   |   account-order.tpl
|                   |   |   account-payment-form.tpl < Payment form (e.g. fee payments)
|                   |   |   account-payment-request.tpl
|                   |   |   account-payment.tpl
|                   |   |   account-product-form-options-values.tpl
|                   |   |   account-product-form-options.tpl
|                   |   |   account-product-form.tpl
|                   |   |   account-product.tpl
|                   |   |   account-profile.tpl
|                   |   |   account-question-form.tpl
|                   |   |   account-question.tpl
|                   |   |   account-review-form.tpl
|                   |   |   account-review.tpl
|                   |   |   account-stats.tpl
|                   |   |   account-transaction.tpl
|                   |   |   catalog-seller-products.tpl < Seller's store page
|                   |   |   catalog-seller-profile.tpl < Seller's profile page
|                   |   |   catalog-seller.tpl < List of sellers page
|                   |   |   dialog-sellercontact.tpl
|                   |   |   
|                   |   +---import < Mass product import templates
|                   |   |       account-import.tpl
|                   |   |       prepare.tpl
|                   |   |       step1.tpl
|                   |   |       step2.tpl
|                   |   |       step3.tpl
|                   |   |       step4.tpl
|                   |   |       
|                   |   +---invoice < Seller invoice templates
|                   |   |       body-default.tpl
|                   |   |       footer.tpl
|                   |   |       header.tpl
|                   |   |       
|                   |   +---report < Seller report templates
|                   |   |       finances-payment.tpl
|                   |   |       finances-payout.tpl
|                   |   |       finances-transaction.tpl
|                   |   |       sales-day.tpl
|                   |   |       sales-month.tpl
|                   |   |       sales-product.tpl
|                   |   |       sales.tpl
|                   |   |       
|                   |   \---settings < Seller settings
|                   |           default.tpl
|                   |           
|                   +---payment
|                   |       ms_pp_adaptive.tpl
|                   |       
|                   \---product < Product page templates (tabs)
|                           mm_question.tpl
|                           mm_question_answer.tpl
|                           mm_review.tpl
|                           mm_review_comment.tpl
|                           mm_shipping.tpl
|                           
+---image <..> < Various MultiMerch catalog-area images
|                       
+---system < MultiMerch system files
|   +---config < MultiMerch config files
|   |   \---multimerch
|   |           ms_import-export-system_full.php
|   |           
|   +---library < Core MultiMerch models used by both catalog and admin-area controllers
|   |   |   msattribute.php < Product attribute management routines
|   |   |   msbadge.php < Seller badge management routines
|   |   |   msbalance.php < Seller balance management routines
|   |   |   mscategory.php
|   |   |   mscommission.php
|   |   |   msconversation.php
|   |   |   mscoupon.php
|   |   |   mscustomfield.php
|   |   |   msfile.php < MultiMerch file management (uploads)
|   |   |   msfilter.php
|   |   |   mshelper.php  < MultiMerch helper finctions
|   |   |   msloader.php < Core MultiMerch loader
|   |   |   msmail.php < Core MultiMerch mailer
|   |   |   msmessage.php
|   |   |   msoption.php
|   |   |   msorderdata.php
|   |   |   mspayout.php
|   |   |   mspgpayment.php
|   |   |   mspgrequest.php
|   |   |   msproduct.php
|   |   |   msquestion.php
|   |   |   msreport.php
|   |   |   msreturn.php
|   |   |   msreview.php
|   |   |   msseller.php
|   |   |   mssellergroup.php
|   |   |   mssetting.php
|   |   |   msshippingmethod.php
|   |   |   msstatistic.php
|   |   |   mssuborder.php
|   |   |   mssuborderstatus.php
|   |   |   mstransaction.php
|   |   |   msvalidator.php < MultiMerch form validator
|   |   |   
|   |   \---multimerch < Core MultiMerch models (new structure)
|   |       |   msimportexportdata.php < Import/Export data manager
|   |       |   msimportexportfile.php < Import/Export file manager
|   |       |   mssociallink.php
|   |       |   
|   |       \---payment
|   |               paypal.php < PayPal class
|   |               
|   \---vendor 
|       \---multimerchlib < MultiMerch libraries (new structure, late 8.x versions)
|           +---config < MultiMerch configs
|           |       config.php
|           |       factory.php
|           |       
|           +---core < Core MultiMerch libraries
|           |   |   hook.php < MultiMerch hook system
|           |   |   
|           |   \---event  < MultiMerch event system
|           |       |   eventmanager.php
|           |       |   handler.php
|           |       |   
|           |       \---handlers
|           |               log.php
|           |               mail.php
|           |               marketplaceactivity.php
|           |               
|           +---event < MultiMerch event system (old)
|           |       event.php
|           |       eventcollection.php
|           |       eventmanager.php
|           |       
|           +---logger < MultiMerch logger
|           |   |   logger.php
|           |   |   loggerinterface.php
|           |   |   
|           |   \---handler
|           |           filehandler.php
|           |           handlerinterface.php
|           |           
|           +---mail < MultiMerch mail handlers (deprecated)
|           |   +---exception
|           |   |       transport.php
|           |   |       
|           |   +---message < Core message library
|           |   |   |   message.php
|           |   |   |   messagecollection.php
|           |   |   |   
|           |   |   +---admin < Admin emails
|           |   |   |       editproductawaitingmoderation.php
|           |   |   |       newproductawaitingmoderation.php
|           |   |   |       productcreated.php
|           |   |   |       selleraccountcreated.php
|           |   |   |       sellerawaitingmoderation.php
|           |   |   |       withdrawrequestsubmitted.php
|           |   |   |       
|           |   |   +---catalog < Catalog emails
|           |   |   |       attributeconvertedtoglobal.php
|           |   |   |       attributecreated.php
|           |   |   |       attributegroupcreated.php
|           |   |   |       attributegroupstatuschanged.php
|           |   |   |       attributesellerchanged.php
|           |   |   |       attributestatuschanged.php
|           |   |   |       categorycreated.php
|           |   |   |       categorystatuschanged.php
|           |   |   |       optionconvertedtoglobal.php
|           |   |   |       optioncreated.php
|           |   |   |       optionsellerchanged.php
|           |   |   |       optionstatuschanged.php
|           |   |   |       
|           |   |   +---orders
|           |   |   |       updated.php
|           |   |   |       
|           |   |   +---product < Product-related emails
|           |   |   |       awaitingmoderation.php
|           |   |   |       modified.php
|           |   |   |       purchased.php
|           |   |   |       returned.php
|           |   |   |       reviewed.php
|           |   |   |       
|           |   |   +---seller
|           |   |   |       accountcreated.php
|           |   |   |       accountmodified.php
|           |   |   |       awaitingmoderation.php
|           |   |   |       privatemessage.php
|           |   |   |       remindlisting.php
|           |   |   |       
|           |   |   +---transaction
|           |   |   |       performed.php
|           |   |   |       
|           |   |   \---withdraw
|           |   |           requestcompleted.php
|           |   |           requestdeclined.php
|           |   |           requestsubmitted.php
|           |   |           
|           |   \---transport < Mail transport libraries
|           |           factory.php
|           |           multimerchmail.php
|           |           sendmail.php
|           |           smtp.php
|           |           
|           +---module
|           |   |   multimerch.php
|           |   |   
|           |   +---catalog < MultiMerch mail templates (deprecated)
|           |   |   \---view
|           |   |       \---theme
|           |   |           \---default
|           |   |               \---msmail
|           |   |                   +---admin
|           |   |                   |       edit_product_awaiting_moderation.tpl
|           |   |                   |       new_product_awaiting_moderation.tpl
|           |   |                   |       product_created.tpl
|           |   |                   |       seller_account_created.tpl
|           |   |                   |       seller_awaiting_moderation.tpl
|           |   |                   |       withdraw_request_submitted.tpl
|           |   |                   |       
|           |   |                   +---catalog
|           |   |                   |       attribute_converted_to_global.tpl
|           |   |                   |       attribute_created.tpl
|           |   |                   |       attribute_group_created.tpl
|           |   |                   |       attribute_group_status_changed.tpl
|           |   |                   |       attribute_seller_changed.tpl
|           |   |                   |       attribute_status_changed.tpl
|           |   |                   |       category_created.tpl
|           |   |                   |       category_status_changed.tpl
|           |   |                   |       option_converted_to_global.tpl
|           |   |                   |       option_created.tpl
|           |   |                   |       option_seller_changed.tpl
|           |   |                   |       option_status_changed.tpl
|           |   |                   |       
|           |   |                   +---orders
|           |   |                   |       updated.tpl
|           |   |                   |       
|           |   |                   +---partials
|           |   |                   |       footer.tpl
|           |   |                   |       header.tpl
|           |   |                   |       layout.tpl
|           |   |                   |       
|           |   |                   +---product
|           |   |                   |       awaiting_moderation.tpl
|           |   |                   |       modified.tpl
|           |   |                   |       purchased.tpl
|           |   |                   |       returned.tpl
|           |   |                   |       reviewed.tpl
|           |   |                   |       
|           |   |                   +---seller
|           |   |                   |       account_created.tpl
|           |   |                   |       account_modified.tpl
|           |   |                   |       awaiting_moderation.tpl
|           |   |                   |       private_message.tpl
|           |   |                   |       remind_listing.tpl
|           |   |                   |       
|           |   |                   +---transaction
|           |   |                   |       performed.tpl
|           |   |                   |       
|           |   |                   \---withdraw
|           |   |                           request_completed.tpl
|           |   |                           request_declined.tpl
|           |   |                           request_submitted.tpl
|           |   |                           
|           |   \---config < MultiMerch config files
|           |           config.php
|           |           hash_file.json
|           |           multimerch.php
|           |           oc_version.php
|           |           
|           +---servicelocator
|           |   |   factoryinterface.php
|           |   |   servicelocator.php
|           |   |   servicelocatorawareinterface.php
|           |   |   servicelocatorawaretrait.php
|           |   |   servicelocatorinterface.php
|           |   |   
|           |   \---exception
|           |           servicelocatorexception.php
|           |           
|           +---stdlib
|           |       arrayutils.php
|           |       cli.php
|           |       cname.php
|           |       files.php
|           |       
|           +---translator
|           |       factory.php
|           |       translator.php
|           |       translatorinterface.php
|           |       
|           \---view
|               |   variables.php
|               |   
|               \---renderer
|                       factory.php
|                       phprenderer.php
|                       
\---vqmod
\---xml < Core MultiMerch vQmod xml files
multimerch_core.xml < Core modifications
multimerch_core_admin.xml < Admin-area modifications
multimerch_core_overrides.xml < OpenCart template overrides
multimerch_core_productpage.xml < Product page modifications
multimerch_core_sellerinfos.xml < Modifications related to seller information throughout OpenCart
multimerch_core_sellermenu.xml < Seller menus
multimerch_core_seo.xml < MultiMerch SEO system hook
multimerch_core_seourl.xml < MultiMerch SEO system hook (legacy, deprecated)
multimerch_core_transactions.xml < Modifications related to generating seller transactions for orders
multimerch_c_hooks.xml < MultiMerch template hooks for theme compatibility
multimerch_oc21x_controllerfix.xml_ < OpenCart 2.1 compatibility modifications (deprecated)
multimerch_oc23_compatibility_fixes.xml < OpenCart 2.3 compatibility modifications
multimerch_pre_oc23_fixes.xml_ < OpenCart 2.0/2.2 compatibility modifications (deprecated)

MultiMerch database structure description

// MultiMerch database version/schema changes (used for upgrades)
CREATE TABLE ms_db_schema (
schema_change_id int(11) NOT NULL AUTO_INCREMENT,
major TINYINT NOT NULL,
minor TINYINT NOT NULL,
build TINYINT NOT NULL,
revision SMALLINT NOT NULL,
date_applied DATETIME NOT NULL,
PRIMARY KEY (schema_change_id))
// Commissions (fees)
CREATE TABLE ms_commission (
commission_id int(11) NOT NULL AUTO_INCREMENT,
PRIMARY KEY (commission_id))
// Commission (fee) rates
CREATE TABLE ms_commission_rate (
rate_id int(11) NOT NULL AUTO_INCREMENT,
rate_type int(11) NOT NULL,
commission_id int(11) NOT NULL,
flat DECIMAL(15,4),
percent DECIMAL(15,2),
payment_method TINYINT DEFAULT NULL,
PRIMARY KEY (rate_id))
// Seller groups
CREATE TABLE ms_seller_group (
seller_group_id int(11) NOT NULL AUTO_INCREMENT,
commission_id int(11) DEFAULT NULL,
product_period int(5) DEFAULT 0,
product_quantity int(5) DEFAULT 0,
PRIMARY KEY (seller_group_id))
// Seller group descriptions
CREATE TABLE ms_seller_group_description (
seller_group_description_id int(11) NOT NULL AUTO_INCREMENT,
seller_group_id int(11) NOT NULL,
name VARCHAR(32) NOT NULL DEFAULT '',
description TEXT NOT NULL DEFAULT '',
language_id int(11) DEFAULT NULL,
PRIMARY KEY (seller_group_description_id))
// MultiMerch product data (complements OpenCart's product table)
CREATE TABLE ms_product (
product_id int(11) NOT NULL,
seller_id int(11) DEFAULT NULL,
product_status TINYINT NOT NULL,
product_approved TINYINT NOT NULL,
list_until DATE DEFAULT NULL,
commission_id int(11) DEFAULT NULL,
PRIMARY KEY (product_id))
// Sellers
CREATE TABLE ms_seller (
seller_id int(11) NOT NULL AUTO_INCREMENT,
nickname VARCHAR(32) NOT NULL DEFAULT '',
company VARCHAR(32) NOT NULL DEFAULT '',
website VARCHAR(2083) NOT NULL DEFAULT '',
description TEXT NOT NULL DEFAULT '',
country_id INT(11) NOT NULL DEFAULT '0',
zone_id INT(11) NOT NULL DEFAULT '0',
avatar VARCHAR(255) DEFAULT NULL,
banner VARCHAR(255) DEFAULT NULL,
date_created DATETIME NOT NULL,
seller_status TINYINT NOT NULL,
seller_approved TINYINT NOT NULL,
seller_group int(11) NOT NULL DEFAULT '1',
commission_id int(11) DEFAULT NULL,
PRIMARY KEY (seller_id))
// Seller descriptions
CREATE TABLE ms_seller_description (
seller_description_id int(11) NOT NULL AUTO_INCREMENT,
seller_id int(11) NOT NULL,
language_id int(11) NOT NULL,
description text DEFAULT '',
PRIMARY KEY (seller_description_id),
UNIQUE KEYseller_language_id (seller_id,language_id)) DEFAULT CHARSET=utf8");
// Seller balances (transactions)
CREATE TABLE ms_balance (
balance_id int(11) NOT NULL AUTO_INCREMENT,
seller_id int(11) NOT NULL,
order_id int(11) DEFAULT NULL,
product_id int(11) DEFAULT NULL,
order_product_id int(11) DEFAULT NULL,
withdrawal_id int(11) DEFAULT NULL,
balance_type int(11) DEFAULT NULL,
amount DECIMAL(15,4) NOT NULL,
balance DECIMAL(15,4) NOT NULL,
description TEXT NOT NULL DEFAULT '',
date_created DATETIME NOT NULL,
date_modified DATETIME DEFAULT NULL,
PRIMARY KEY (balance_id))
// MultiMerch order product data (complements OpenCart's order product data)
CREATE TABLE ms_order_product_data (
order_product_data_id int(11) NOT NULL AUTO_INCREMENT,
order_id int(11) NOT NULL,
product_id int(11) NOT NULL,
order_product_id int(11) DEFAULT NULL,
seller_id int(11) DEFAULT NULL,
store_commission_flat DECIMAL(15,4) NOT NULL,
store_commission_pct DECIMAL(15,4) NOT NULL,
seller_net_amt DECIMAL(15,4) NOT NULL,
suborder_id int(11) NOT NULL DEFAULT '0',
PRIMARY KEY (order_product_data_id))
// Deprecated
CREATE TABLE ms_criteria (
criteria_id int(11) NOT NULL AUTO_INCREMENT,
criteria_type TINYINT NOT NULL,
range_id int(11) NOT NULL,
PRIMARY KEY (criteria_id))
// Deprecated
CREATE TABLE ms_range_int (
range_id int(11) NOT NULL AUTO_INCREMENT,
from int(11) NOT NULL,
to int(11) NOT NULL,
PRIMARY KEY (range_id))
// Deprecated
CREATE TABLE ms_range_decimal (
range_id int(11) NOT NULL AUTO_INCREMENT,
from DECIMAL(15,4) NOT NULL,
to DECIMAL(15,4) NOT NULL,
PRIMARY KEY (range_id))
// Deprecated
CREATE TABLE ms_range_date (
range_id int(11) NOT NULL AUTO_INCREMENT,
from DATETIME,
to DATETIME NOT NULL,
PRIMARY KEY (range_id))
// Deprecated
CREATE TABLE ms_seller_group_criteria (
seller_group_criteria_id int(11) NOT NULL AUTO_INCREMENT,
commission_id int(11) NOT NULL,
criteria_id int(11) NOT NULL,
PRIMARY KEY (seller_group_criteria_id))
// Deprecated
CREATE TABLE ms_return (
return_id int(11) NOT NULL AUTO_INCREMENT,
order_id int(11) NOT NULL,
suborder_id int(11) NOT NULL,
seller_id int(11) NOT NULL,
customer_id int(11) DEFAULT 0 NOT NULL,
date_created DATETIME NOT NULL,
PRIMARY KEY (return_id))
// Deprecated
CREATE TABLE ms_return_product (
return_product_id int(11) NOT NULL AUTO_INCREMENT,
return_id int(11) NOT NULL,
product_id int(11) NOT NULL,
order_product_id int(11) NOT NULL,
product_quantity int(4) NOT NULL,
return_reason_id int(11) NOT NULL,
return_action_id int(11) NOT NULL,
PRIMARY KEY (return_product_id))
// Deprecated
CREATE TABLE ms_return_history (
return_history_id int(11) NOT NULL AUTO_INCREMENT,
return_id int(11) NOT NULL,
return_status_id int(11) NOT NULL,
seller_comment TEXT NULL DEFAULT '',
customer_comment TEXT NULL DEFAULT '',
date_created DATETIME NOT NULL,
PRIMARY KEY (return_history_id))
// Deprecated
CREATE TABLE ms_order_comment (
order_comment_id int(11) NOT NULL AUTO_INCREMENT,
order_id int(11) NOT NULL,
product_id int(11) NOT NULL,
seller_id int(11) NOT NULL,
comment text NOT NULL,
PRIMARY KEY (order_comment_id)
) DEFAULT CHARSET=utf8");
// Seller orders (suborders)
CREATE TABLE ms_suborder (
suborder_id int(11) NOT NULL AUTO_INCREMENT,
order_id int(11) NOT NULL,
seller_id int(11) NOT NULL,
invoice_no int(11) NOT NULL DEFAULT '0',
invoice_prefix varchar(26) NOT NULL DEFAULT '',
order_status_id int(11) NOT NULL,
date_added datetime NOT NULL,
date_modified datetime NOT NULL,
PRIMARY KEY (suborder_id)
) DEFAULT CHARSET=utf8");
// Seller order history (suborder history)
CREATE TABLE ms_suborder_history (
suborder_history_id int(5) NOT NULL AUTO_INCREMENT,
suborder_id int(5) NOT NULL,
order_status_id int(5) NOT NULL,
comment text NOT NULL DEFAULT '',
date_added datetime NOT NULL,
PRIMARY KEY (suborder_history_id)
) DEFAULT CHARSET=utf8");
// Seller order statuses
CREATE TABLE ms_suborder_status (
ms_suborder_status_id int(11) NOT NULL AUTO_INCREMENT,
PRIMARY KEY (ms_suborder_status_id))
// Seller order status names
CREATE TABLE ms_suborder_status_description (
ms_suborder_status_id int(11) NOT NULL,
language_id int(11) NOT NULL,
name varchar(256) NOT NULL DEFAULT '',
PRIMARY KEY (ms_suborder_status_id,language_id))
// Seller settings
CREATE TABLE ms_seller_setting (
id int(11) unsigned NOT NULL AUTO_INCREMENT,
seller_id int(11) unsigned DEFAULT NULL,
name varchar(50) DEFAULT NULL,
value varchar(250) DEFAULT NULL,
is_encoded smallint(1) unsigned DEFAULT NULL,
PRIMARY KEY (id)
) DEFAULT CHARSET=utf8;");
// Seller group settings
CREATE TABLE ms_seller_group_setting (
id int(11) unsigned NOT NULL AUTO_INCREMENT,
seller_group_id int(11) unsigned DEFAULT NULL,
name varchar(50) DEFAULT NULL,
value varchar(250) DEFAULT NULL,
is_encoded smallint(1) unsigned DEFAULT NULL,
PRIMARY KEY (id)
) DEFAULT CHARSET=utf8;");
// Seller badges
CREATE TABLE".DB_PREFIX."ms_badge (
badge_id int(11) NOT NULL AUTO_INCREMENT,
image varchar(255) DEFAULT NULL,
PRIMARY KEY (badge_id))
// Seller badge names and descriptions
CREATE TABLE".DB_PREFIX."ms_badge_description (
badge_id int(11) NOT NULL,
name varchar(32) NOT NULL DEFAULT '',
description text NOT NULL,
language_id int(11) NOT NULL,
PRIMARY KEY (badge_id,language_id))
// Seller group badges
CREATE TABLE".DB_PREFIX."ms_badge_seller_group (
badge_seller_group_id INT(11) NOT NULL AUTO_INCREMENT,
badge_id INT(11) NOT NULL,
seller_id int(11) DEFAULT NULL,
seller_group_id int(11) DEFAULT NULL,
PRIMARY KEY (badge_seller_group_id))
// Social media links
CREATE TABLE".DB_PREFIX."ms_channel (
channel_id int(11) NOT NULL AUTO_INCREMENT,
image varchar(255) DEFAULT NULL,
PRIMARY KEY (channel_id))
// Social media link names
CREATE TABLE".DB_PREFIX."ms_channel_description (
channel_id int(11) NOT NULL,
language_id int(11) NOT NULL,
name VARCHAR(32) NOT NULL DEFAULT '',
description TEXT NOT NULL DEFAULT '',
PRIMARY KEY (channel_id,language_id))
// Seller social media links
CREATE TABLE".DB_PREFIX."ms_seller_channel (
seller_id int(11) NOT NULL,
channel_id int(11) NOT NULL,
channel_value varchar(255) DEFAULT NULL,
PRIMARY KEY (seller_id,channel_id))
// Conversations
CREATE TABLE ms_conversation (
conversation_id int(11) NOT NULL AUTO_INCREMENT,
conversation_from int(11) DEFAULT NULL,
title varchar(256) NOT NULL DEFAULT '',
date_created DATETIME NOT NULL,
PRIMARY KEY (conversation_id))
// Conversation messages
CREATE TABLE ms_message (
message_id int(11) NOT NULL AUTO_INCREMENT,
conversation_id int(11) NOT NULL,
from int(11) DEFAULT NULL,
from_admin tinyint(1) NOT NULL DEFAULT 0,
message text NOT NULL DEFAULT '',
read tinyint(1) NOT NULL DEFAULT 0,
date_created DATETIME NOT NULL,
PRIMARY KEY (message_id))
// Product questions
CREATE TABLE" . DB_PREFIX ."ms_question (
question_id int(11) NOT NULL AUTO_INCREMENT,
author_id int(11) NOT NULL,
product_id int(11) NOT NULL,
text text NOT NULL DEFAULT '', 
date_created DATETIME NOT NULL,
PRIMARY KEY (question_id)) DEFAULT CHARSET=utf8");
// Answers to product questions
CREATE TABLE ms_answer (
answer_id int(11) NOT NULL AUTO_INCREMENT,
question_id int(11) NOT NULL,
author_id int(11) NOT NULL,
date_created DATETIME NOT NULL,
rating int(11) DEFAULT NULL,
text text NOT NULL DEFAULT '',
PRIMARY KEY (answer_id)) DEFAULT CHARSET=utf8");
// Deprecated
CREATE TABLE ms_user_vote (
answer_id int(11) NOT NULL,
user_id int(11) NOT NULL,
type tinyint(1) NOT NULL) DEFAULT CHARSET=utf8");
// Product reviews
CREATE TABLE ms_review (
review_id int(11) NOT NULL AUTO_INCREMENT,
author_id int(11) NOT NULL,
product_id int(11) NOT NULL,
order_product_id int(11) NOT NULL,
order_id int(11) DEFAULT NULL,
seller_id int(11) DEFAULT NULL,
rating int(1) NOT NULL,
title varchar(128) NOT NULL DEFAULT '',
comment text NOT NULL DEFAULT '',
helpful int(11) DEFAULT NULL,
unhelpful int(11) DEFAULT NULL,
date_created DATETIME NOT NULL,
date_updated DATETIME DEFAULT NULL,
status tinyint DEFAULT 0,
PRIMARY KEY (review_id))
// Review attachments
CREATE TABLE ms_review_attachment (
review_attachment_id int(11) NOT NULL AUTO_INCREMENT,
review_id int(11) NOT NULL,
attachment text NOT NULL,
PRIMARY KEY (review_attachment_id))
// Deprecated
CREATE TABLE ms_review_comment (
comment_id int(11) NOT NULL AUTO_INCREMENT,
review_id int(11) NOT NULL,
author_id int(11) NOT NULL,
text text NOT NULL,
rating int(11) NOT NULL,
date_created DATETIME NOT NULL,
date_updated DATETIME DEFAULT NULL,
PRIMARY KEY (comment_id))
// Shipping methods
CREATE TABLE ms_shipping_method (
shipping_method_id int(11) NOT NULL AUTO_INCREMENT,
logo TEXT DEFAULT '',
status tinyint(1) NOT NULL DEFAULT 0,
PRIMARY KEY (shipping_method_id))
// Shipping method descriptions
CREATE TABLE ms_shipping_method_description (
shipping_method_description_id int(11) NOT NULL AUTO_INCREMENT,
shipping_method_id int(11) NOT NULL,
name VARCHAR(32) NOT NULL DEFAULT '',
description TEXT DEFAULT '',
language_id int(11) DEFAULT NULL,
PRIMARY KEY (shipping_method_description_id))
// Shipping method delivery times
CREATE TABLE ms_shipping_delivery_time (
delivery_time_id int(11) NOT NULL AUTO_INCREMENT,
PRIMARY KEY (delivery_time_id))
// Delivery time names
CREATE TABLE ms_shipping_delivery_time_description (
delivery_time_desc_id int(11) NOT NULL AUTO_INCREMENT,
delivery_time_id int(11) NOT NULL,
name TEXT DEFAULT '',
language_id int(11) NOT NULL DEFAULT 1,
PRIMARY KEY (delivery_time_desc_id))
// Product shipping rates
CREATE TABLE ms_product_shipping (
product_shipping_id int(11) NOT NULL AUTO_INCREMENT,
product_id int(11) NOT NULL,
from_country int(11) NOT NULL DEFAULT 0,
free_shipping int(11) NOT NULL DEFAULT 0,
processing_time int(11) NOT NULL DEFAULT 0,
override int(11) DEFAULT 0,
PRIMARY KEY (product_shipping_id))
// Product shipping locations
CREATE TABLE ms_product_shipping_location (
product_shipping_location_id int(11) NOT NULL AUTO_INCREMENT,
product_id int(11) NOT NULL,
to_geo_zone_id int(11) NOT NULL,
shipping_method_id int(11) NOT NULL DEFAULT 0,
delivery_time_id int(11) NOT NULL DEFAULT 1,
cost DECIMAL(15,4) NOT NULL,
additional_cost DECIMAL(15,4) NOT NULL,
PRIMARY KEY (product_shipping_location_id))
// Order product shipping data (complements OpenCart's order product data)
CREATE TABLE ms_order_product_shipping_data (
order_product_shipping_id int(11) NOT NULL AUTO_INCREMENT,
order_id int(11) NOT NULL,
product_id int(11) NOT NULL,
order_product_id int(11) NOT NULL,
fixed_shipping_method_id int(11) DEFAULT NULL,
combined_shipping_method_id int(11) DEFAULT NULL,
shipping_cost DECIMAL(15,4) DEFAULT NULL,
PRIMARY KEY (order_product_shipping_id))
// Payments
CREATE TABLE ms_pg_payment (
payment_id int(11) NOT NULL AUTO_INCREMENT,
seller_id int(11) NOT NULL,
payment_type int(11) NOT NULL,
payment_code VARCHAR(128) NOT NULL,
payment_status int(11) NOT NULL,
amount DECIMAL(15,4) NOT NULL,
currency_id int(11) NOT NULL,
currency_code VARCHAR(3) NOT NULL,
sender_data TEXT NOT NULL,
receiver_data TEXT NOT NULL,
description TEXT NOT NULL,
date_created DATETIME NOT NULL,
PRIMARY KEY (payment_id))
// Invoices
CREATE TABLE ms_pg_request (
request_id int(11) NOT NULL AUTO_INCREMENT,
payment_id VARCHAR(128) DEFAULT NULL,
seller_id int(11) NOT NULL,
product_id int(11) DEFAULT NULL,
order_id int(11) DEFAULT NULL,
request_type int(11) NOT NULL,
request_status int(11) NOT NULL,
description TEXT NOT NULL,
amount DECIMAL(15,4) NOT NULL,
currency_id int(11) NOT NULL,
currency_code VARCHAR(3) NOT NULL,
date_created DATETIME NOT NULL,
date_modified DATETIME DEFAULT NULL,
PRIMARY KEY (request_id))
// Seller shipping rates (weight-based combined shipping)
CREATE TABLE ms_seller_shipping (
seller_shipping_id int(11) NOT NULL AUTO_INCREMENT,
seller_id int(11) NOT NULL,
from_country_id int(11) NOT NULL,
processing_time int(11) NOT NULL DEFAULT 0,
PRIMARY KEY (seller_shipping_id))
// Seller shipping locations (weight-based combined shipping)
CREATE TABLE ms_seller_shipping_location (
seller_shipping_location_id int(11) NOT NULL AUTO_INCREMENT,
seller_shipping_id int(11) NOT NULL,
shipping_method_id int(11) NOT NULL,
delivery_time_id int(11) NOT NULL,
to_geo_zone_id int(11) NOT NULL,
weight_from DECIMAL(15,4) NOT NULL,
weight_to DECIMAL(15,4) NOT NULL,
weight_class_id int(11) NOT NULL,
cost_fixed DECIMAL(15,4) NOT NULL,
cost_pwu DECIMAL(15,4) NOT NULL DEFAULT 0,
PRIMARY KEY (seller_shipping_location_id))
// Category commission rates (category-based sales fees)
CREATE TABLE ms_category_commission (
category_commission_id int(11) NOT NULL AUTO_INCREMENT,
category_id int(11) NOT NULL,
commission_id int(11) DEFAULT NULL,
PRIMARY KEY (category_commission_id))
// Seller product attributes
CREATE TABLE ms_attribute (
attribute_id int(11) NOT NULL AUTO_INCREMENT,
seller_id int(11) DEFAULT 0,
attribute_status int(11) NOT NULL,
PRIMARY KEY (attribute_id))
// Seller product attribute groups
CREATE TABLE ms_attribute_group (
attribute_group_id int(11) NOT NULL AUTO_INCREMENT,
seller_id int(11) DEFAULT 0,
attribute_group_status int(11) NOT NULL,
PRIMARY KEY (attribute_group_id))
// Seller product options
CREATE TABLE ms_option (
option_id int(11) NOT NULL AUTO_INCREMENT,
seller_id int(11) DEFAULT 0,
option_status int(11) NOT NULL,
PRIMARY KEY (option_id))
// Adaptive payment keys
CREATE TABLE ms_customer_ppakey (
customer_id int(11) NOT NULL,
preapprovalkey varchar(255) NOT NULL,
active smallint(1) NOT NULL DEFAULT '0',
PRIMARY KEY (customer_id)) DEFAULT CHARSET=utf8;");
// Seller product categories
CREATE TABLE ms_category (
category_id int(11) NOT NULL AUTO_INCREMENT,
parent_id int(11) NOT NULL DEFAULT 0,
seller_id int(11) NOT NULL DEFAULT 0,
image VARCHAR(255) DEFAULT NULL,
sort_order int(11) NOT NULL DEFAULT 0,
category_status int(11) NOT NULL,
PRIMARY KEY (category_id))
// Seller product category descriptions
CREATE TABLE ms_category_description (
category_id int(11) NOT NULL,
language_id int(11) NOT NULL,
name VARCHAR(255) NOT NULL DEFAULT '',
description TEXT NOT NULL DEFAULT '',
meta_title VARCHAR(255) NOT NULL DEFAULT '',
meta_description VARCHAR(255) NOT NULL DEFAULT '',
meta_keyword VARCHAR(255) NOT NULL DEFAULT '',
PRIMARY KEY (category_id,language_id))
// Seller category filters
CREATE TABLE ms_category_filter (
category_id int(11) NOT NULL,
oc_filter_id int(11) NOT NULL,
PRIMARY KEY (category_id,oc_filter_id))
// Seller categories linked to OpenCart stores
CREATE TABLE ms_category_to_store (
category_id int(11) NOT NULL,
store_id int(11) NOT NULL,
PRIMARY KEY (category_id,store_id))
// Category paths
CREATE TABLE ms_category_path (
category_id int(11) NOT NULL,
path_id int(11) NOT NULL,
level int(11) NOT NULL,
PRIMARY KEY (category_id,path_id))
// Products linked to categories
CREATE TABLE ms_product_to_category (
product_id int(11) NOT NULL,
ms_category_id int(11) NOT NULL,
PRIMARY KEY (product_id,ms_category_id))
// Conversations linked to orders
CREATE TABLE " . DB_PREFIX . "ms_conversation_to_order (
order_id int(11) NOT NULL,
suborder_id int(11) NOT NULL,
conversation_id int(11) NOT NULL,
PRIMARY KEY (order_id,suborder_id,conversation_id))
default CHARSET=utf8");
// Conversation participants
CREATE TABLE " . DB_PREFIX . "ms_conversation_participants (
conversation_id int(11) NOT NULL,
customer_id int(11) NOT NULL DEFAULT '0',
user_id int(11) NOT NULL DEFAULT '0',
PRIMARY KEY (conversation_id,customer_id,user_id))
default CHARSET=utf8");
// Conversations linked to products
CREATE TABLE " . DB_PREFIX . "ms_conversation_to_product (
product_id int(11) NOT NULL,
conversation_id int(11) NOT NULL,
PRIMARY KEY (product_id,conversation_id))
default CHARSET=utf8");
// Message attachments
CREATE TABLE " . DB_PREFIX . "ms_message_upload (
message_id int(11) NOT NULL,
upload_id int(11) NOT NULL,
PRIMARY KEY (message_id,upload_id))
default CHARSET=utf8");
// MultiMerch events
CREATE TABLE ms_event (
event_id int(11) NOT NULL AUTO_INCREMENT,
admin_id int(11) unsigned DEFAULT NULL,
customer_id int(11) unsigned DEFAULT NULL,
seller_id int(11) unsigned DEFAULT NULL,
event_type tinyint NOT NULL,
data text NOT NULL,
body text DEFAULT NULL,
date_created DATETIME NOT NULL,
PRIMARY KEY (event_id))
// Deprecated
CREATE TABLE ms_import_config (
config_id int(11) NOT NULL AUTO_INCREMENT,
customer_id int(11) NOT NULL,
config_name varchar(255) DEFAULT NULL,
import_type varchar(100) DEFAULT NULL,
attachment_code varchar(255) DEFAULT NULL,
mapping text,
start_row int(11) DEFAULT NULL,
finish_row int(11) DEFAULT NULL,
cell_container varchar(10) DEFAULT NULL,
cell_separator varchar(10) DEFAULT NULL,
update_key_id int(11) DEFAULT NULL,
file_encoding int(11) DEFAULT NULL,
date_added datetime NOT NULL,
date_modified datetime NOT NULL,
PRIMARY KEY (config_id)
)
// Import histories
CREATE TABLE ms_import_history (
import_id int(11) NOT NULL AUTO_INCREMENT,
seller_id int(11) NOT NULL,
name varchar(255) NOT NULL,
filename varchar(255) NOT NULL,
date_added datetime NOT NULL,
type varchar(100) NOT NULL,
processed int(11) NOT NULL,
added int(11) NOT NULL,
updated int(11) NOT NULL,
errors int(11) NOT NULL,
product_ids text DEFAULT NULL,
PRIMARY KEY (import_id)
)
// Custom field groups
CREATE TABLE ms_custom_field_group (
custom_field_group_id int(11) NOT NULL AUTO_INCREMENT,
admin_id int(11) NOT NULL DEFAULT 0,
status tinyint NOT NULL DEFAULT 0,
sort_order int(11) NOT NULL DEFAULT 0,
PRIMARY KEY (custom_field_group_id))
// Custom field group names
CREATE TABLE ms_custom_field_group_description (
custom_field_group_id int(11) NOT NULL,
language_id int(11) NOT NULL,
name text NOT NULL,
PRIMARY KEY (custom_field_group_id,language_id))
// Custom field links to locations (e.g. custom field to product)
CREATE TABLE ms_custom_field_group_to_location (
custom_field_group_id int(11) NOT NULL,
location_id int(11) NOT NULL DEFAULT 1,
PRIMARY KEY (custom_field_group_id,location_id))
// Custom field group descriptions
CREATE TABLE ms_custom_field_group_note (
custom_field_group_id int(11) NOT NULL,
language_id int(11) NOT NULL,
note text NOT NULL DEFAULT '',
PRIMARY KEY (custom_field_group_id,language_id))
// Custom fields
CREATE TABLE ms_custom_field (
custom_field_id int(11) NOT NULL AUTO_INCREMENT,
custom_field_group_id int(11) NOT NULL,
admin_id int(11) NOT NULL DEFAULT 0,
type varchar(100) NOT NULL DEFAULT '',
required tinyint NOT NULL DEFAULT 0,
validation text NOT NULL DEFAULT '',
status tinyint NOT NULL DEFAULT 0,
sort_order int(11) NOT NULL DEFAULT 0,
PRIMARY KEY (custom_field_id))
// Custom field names
CREATE TABLE ms_custom_field_description (
custom_field_id int(11) NOT NULL,
language_id int(11) NOT NULL,
name text NOT NULL,
PRIMARY KEY (custom_field_id,language_id))
// Custom field values
CREATE TABLE ms_custom_field_value (
custom_field_value_id int(11) NOT NULL AUTO_INCREMENT,
custom_field_id int(11) NOT NULL,
sort_order int(11) NOT NULL DEFAULT 0,
PRIMARY KEY (custom_field_value_id))
// Custom field 
CREATE TABLE ms_custom_field_value_description (
custom_field_value_id int(11) NOT NULL,
custom_field_id int(11) NOT NULL,
language_id int(11) NOT NULL,
name text NOT NULL,
PRIMARY KEY (custom_field_value_id,language_id))
// Custom field descriptions
CREATE TABLE ms_custom_field_note (
custom_field_id int(11) NOT NULL,
language_id int(11) NOT NULL,
note text NOT NULL DEFAULT '',
PRIMARY KEY (custom_field_id,language_id))
// Custom field values for products
CREATE TABLE ms_product_custom_field (
product_id int(11) NOT NULL,
custom_field_id int(11) NOT NULL,
value text NOT NULL DEFAULT '',
PRIMARY KEY (product_id,custom_field_id))
// Payouts
CREATE TABLE ms_payout (
payout_id int(11) NOT NULL AUTO_INCREMENT,
name text NOT NULL DEFAULT '',
date_created datetime NOT NULL,
date_payout_period datetime NOT NULL,
PRIMARY KEY (payout_id))
// Invoices linked to payouts
CREATE TABLE ms_payout_to_invoice (
payout_id int(11) NOT NULL,
invoice_id int(11) NOT NULL,
PRIMARY KEY (payout_id,invoice_id))
// Coupons
CREATE TABLE ms_coupon (
coupon_id int(11) NOT NULL AUTO_INCREMENT,
seller_id int(11) DEFAULT NULL,
name varchar(255) NOT NULL DEFAULT '',
description text NOT NULL DEFAULT '',
code varchar(255) NOT NULL DEFAULT '',
type tinyint NOT NULL DEFAULT 1,
value decimal(15,4) NOT NULL DEFAULT 0,
date_start datetime DEFAULT NULL,
date_end datetime DEFAULT NULL,
max_uses int(11) DEFAULT NULL,
max_uses_customer int(11) DEFAULT NULL,
total_uses int(11) NOT NULL DEFAULT 0,
min_order_total decimal(15,4) NOT NULL DEFAULT 0,
login_required tinyint NOT NULL DEFAULT 1,
status tinyint NOT NULL DEFAULT 1,
date_created datetime NOT NULL,
PRIMARY KEY (coupon_id))
// Coupon histories
CREATE TABLE ms_coupon_history (
coupon_history_id int(11) NOT NULL AUTO_INCREMENT,
coupon_id int(11) NOT NULL,
order_id int(11) NOT NULL,
suborder_id int(11) NOT NULL,
customer_id int(11) NOT NULL,
amount decimal(15,4) NOT NULL,
date_created datetime NOT NULL,
PRIMARY KEY (coupon_history_id))
// Coupon restrictions to customers
CREATE TABLE ms_coupon_customer (
coupon_customer_id int(11) NOT NULL AUTO_INCREMENT,
coupon_id int(11) NOT NULL,
customer_id int(11) NOT NULL,
exclude tinyint DEFAULT 0,
PRIMARY KEY (coupon_customer_id))
// Coupon restrictions to products
CREATE TABLE ms_coupon_product (
coupon_product_id int(11) NOT NULL AUTO_INCREMENT,
coupon_id int(11) NOT NULL,
product_id int(11) NOT NULL,
exclude tinyint DEFAULT 0,
PRIMARY KEY (coupon_product_id))
// Coupon restrictions to OpenCart categories
CREATE TABLE ms_coupon_oc_category (
coupon_oc_category_id int(11) NOT NULL AUTO_INCREMENT,
coupon_id int(11) NOT NULL,
oc_category_id int(11) NOT NULL,
exclude tinyint DEFAULT 0,
PRIMARY KEY (coupon_oc_category_id))
// Coupon restrictions to seller categories
CREATE TABLE ms_coupon_ms_category (
coupon_ms_category_id int(11) NOT NULL AUTO_INCREMENT,
coupon_id int(11) NOT NULL,
ms_category_id int(11) NOT NULL,
exclude tinyint DEFAULT 0,
PRIMARY KEY (coupon_ms_category_id))

MultiMerch class method description

system/library/paypal.php Paypal

decodePayPalIPN < Decode PayPal IPN response
preapproval_request < Send a PayPal preapproval request
request < Make an API request
validateIPN < Validate the IPN response

system/library/msimportexportdata.php MsImportExportData

_addCategory < Create a category during import
_addProduct < Create a product during import
_addProductCategories < Create product category links during import
_createHistory < Create an import history record
_savePath < Create a category path during import
_updateCategory < Update a category during import
_updateProduct < Update a product during import
addImportConfig < Create an import config
CSV_ENCLOSURE < CSV enclosure
CSV_SEPARATOR < CSV separator
deleteImport < Delete an import record
getFilename < Get the import file name
getImportConfigById < Get the import config by id
getImportConfigs < Get the list of import conigs
getImportHistory < Get the history of imports
getSellerAttributes < Get seller's attributes
getStockStatus < Get stock statuses
importCategory < Import a category
importProduct < Import a product
prepareImageByImageUrl < Prepare an image for import
updateImportConfig < Save an import config

system/library/msimportexportfile.php MsImportExportFile

getFieldCaption < Get field captions for the data to be imported
getSamplesData < Get a sample of the data to be imported (Step 4)

system/library/mssociallink.php MsSocialLink

createChannel < Create a social media channel
deleteChannel < Delete a social media channel
editChannel < Edit a channel
editSellerChannels < Edit seller's channels
getChannelDescriptions < Get channel descriptions
getChannels < Get the list of channels
getSellerChannels < Get seller's channels
getTotalSellersByChannelId < Get the total number of sellers linked to a channel

system/library/msattribute.php MsAttribute

createOrUpdateMsAttribute < Create/update seller's attribute
createOrUpdateMsAttributeGroup < Create/update seller's attribute group
deleteAttribute < Delete seller's attribute
deleteAttributeGroup < Delete seller's attribute group
getAttributeGroups < Get seller attribute groups
getAttributes < Get the list of seller attribbutes
getProductsByAttributeId < Get products linked to an attribute
isMsAttribute < Verify if an attribute is a MultiMerch attribute
isMsAttributeGroup < Verify if an attribute group is a MultiMerch attribute group
ocGetAttribute < Get an OpenCart attribute
ocGetAttributes < Get OpenCart attributes
ocGetProductAttributes < Get OpenCart product attribbutes
ocGetTotalAttributesByAttributeGroupId < Get the total number of OpenCart attributes linked to a product
ocGetTotalProductsByAttributeId < Get the total number of products linked to an OpenCart attribute
sellerCreateAttribute < Create a seller attribbute
sellerCreateAttributeGroup < Create seller's attribute group
sellerUpdateAttribute < Update seller's attribute
sellerUpdateAttributeGroup < Update seller's attribute group
STATUS_ACTIVE < Active attributes
STATUS_APPROVED < Approved attributes
STATUS_DISABLED < Disabled attributes
STATUS_INACTIVE < Deleted attributes

system/library/msbadge.php MsBadge

createBadge < Create a new badge
deleteBadge < Delete badge
editBadge < Edit badge
getBadgeDescriptions < Get badge descriptions (translated)
getBadges < Get badges
getSellerGroupsByBadgeId < Get seller groups by badge id
getSellersByBadgeId < Get sellers by badge id

system/library/msbalance.php MsBalance

addBalanceEntry < Create a new balance entry (transaction)
getAvailableSellerFunds < Get seller's available balance (non-reserved)
getBalanceEntries < Get balance entries
getBalanceEntry < Get a single balance entry
getReservedSellerFunds < Get the amount of seller's reserved funds
getSellerBalance < Get seller's balance
getSellerBalanceEntries < Get seller's balance entries
getTotalBalanceAmount < Get total across all balances
getTotalBalanceEntries < Get the total number of balance entries
getTotalSellerBalanceEntries < Get the total number of seller's transactions
getWaitingSellerFunds < Get reserved seller funds
MS_BALANCE_TYPE_GENERIC < Generic balance records
MS_BALANCE_TYPE_LISTING < Product listing balance records (fees)
MS_BALANCE_TYPE_MSCOUPON < Coupon balance records
MS_BALANCE_TYPE_RECURRING < Recurring balance records
MS_BALANCE_TYPE_REFUND < Refund balance records
MS_BALANCE_TYPE_SALE < Sale balance records 
MS_BALANCE_TYPE_SHIPPING  < Shipping balance records
MS_BALANCE_TYPE_SIGNUP < Sign up fee records
MS_BALANCE_TYPE_WITHDRAWAL < Payout records

system/library/mscategory.php MsCategory

_getDescriptions < Get category descriptions (translated)
_getFilters < Get category filters
_getStores < Get category to store relations
_saveDescriptions < Save category names and descriptions (translated)
_saveFilters < Save category filters
_saveKeyword < Save the SEO keyword of a category
_savePath < Save category hiearchies
_saveStores < Save category to store relations
changeSeller < Change the seller a category belongs to
changeStatus < Change category status
createCategory < Create a new seller category
deleteCategory < Delete a single seller category
getCategories < Get seller categories
getChildCategoriesByCategoryId
getMsCategoryName < Get MultiMerch category name (translated)
getMsCategoryPath < Get MultiMerch category hierarchy
getOcCategories < Get OpenCart categories
getOcCategoryCommission < Get OpenCart category commissions
getOcCategoryName < Get OpenCart category name (translated)
getOcCategoryPath < Get complete hiearchy of OpenCart categories
getProductsByCategoryId < Get products belonging to a specific category
isMsCategory < Check if MultiMerch seller category exists
saveCategoryCommission < Save OpenCart category commission
STATUS_ACTIVE < Active seller category status
STATUS_DISABLED < Disabled seller category status
STATUS_INACTIVE < Inactive seller category status
updateCategory < Update a seller category

system/library/mscommission.php MsCommission

calculateCommission < Calculate seller's commission (fee) rates (Default group > Group > Seller)
createCommission < Create a new commission rate
editCommission < Edit a commission rate
getCommissionRates < Fetch commission rates
RATE_LISTING < Listing fees
RATE_SALE < Sale fees
RATE_SIGNUP < Signup fees
TYPE_DATE_UNTIL < Deprecated
TYPE_PERIODIC < Deprecated
TYPE_SALES_AMOUNT < Deprecated
TYPE_SALES_QUANTITY < Deprecated

system/library/msconversation.php MsConversation

addConversationParticipants < Add a new participant to a conversation
createConversation < Create a new conversation
deleteConversation < Delete a conversation
getConversationParticipants < Fetch all conversation participants
getConversationParticipantsIds < Fetch all conversation participants (ids)
getConversations < Get all conversations
getOrderConversation < Get order-related conversation
getWith < Get the other party in a conversation
isParticipant < Validate conversation's participant
SENDER_TYPE_ADMIN < Admin-initiated conversations
SENDER_TYPE_CUSTOMER < Customer-initiated conversations
SENDER_TYPE_SELLER < Seller-initiated conversations
sendMailForParticipants < Notify conversation participants via email
updateConversation < Update a conversation

system/library/mscoupon.php MsCoupon

checkCouponBelongsToSeller < Verify if a coupon belongs to a seller
createCouponHistory < Create a coupon usage history entry
createOrUpdateCoupon < Create/update a coupon
deleteCoupon < Delete coupon
deleteCouponHistory < Delete a coupon history entry
getCouponHistory < Get coupon usage history entries
getCoupons < Get coupons
getCustomerByCouponId < Get the customer list for a coupon (restrictions)
getMsCategoryByCouponId < Get the seller category list for a coupon (restrictions)
getOcCategoryByCouponId < Get the OpenCart category list for a coupon (restrictions)
getProductByCouponId < Get products for a coupon (restrictions)
incrementTotalUses < Increment coupon's total use number
STATUS_ACTIVE < Active coupons
STATUS_DISABLED < Disabled coupons
TYPE_DISCOUNT_FIXED < Fixed (flat rate) coupons
TYPE_DISCOUNT_PERCENT < Percentage coupons

system/library/mscustomfield.php MsCustomField

createOrUpdateCustomField < Create/update a custom field
createOrUpdateCustomFieldGroup < Create/update a custom field gorup
createOrUpdateProductCustomField < Create/update field to product link
deleteCustomField < Delete a custom field
deleteCustomFieldGroup < Delete a custom field group
getCustomFieldGroups < Get custom field groups
getCustomFields < Get custom fields
getCustomFieldType < Get custom field type
getCustomFieldValidation < Get custom field validation status
getCustomFieldValueName < Get custom field value (translated)
getCustomFieldValues < Get custom field values
getProductCustomFields < Get custom field to product links
getProductsByCFId < Get products linked to a custom field
LOCATION_PRODUCT < Custom product fields
STATUS_ACTIVE < Active custom fields
STATUS_DISABLED < Disabled custom fields

system/library/msfile.php MsFile

_checkExistingFiles < Check if the file with this name already exists
_checkExistingFilesMd5 < Check if the file with this name already exists (MD5)
_checkExistingFilesSizes < Check if the file with this name already exists (file size)
_isNewUpload < Check if the file is a new upload
checkDownload < Run a set of security checks against a download file
checkFile < Run a set of security checks against an uploaded file
checkFileAgainstSession < Verify if the file being uploaded is present in a session
checkImage < Run a set of security checks against an image file
checkImportFile < Run a set of security checks against an import file
checkPostMax < Verify whether a file exceeds the maximum post size
deleteDownload < Delete a download
deleteImage < Delete an image
moveDownload < Move a file upload to the storage folder
moveImage < Move an image upload to the storage folder
resizeImage < Resize an image
uploadDownload < Upload a product/seller file
uploadImage < Upload a product/seller image
uploadImportFile < Upload an import file

system/library/msfilter.php MsFilter

getFilter < Get an OpenCart filter
getFilters < Get OpenCart filters
getProductFilters < Get OpenCart filters for a product

system/library/mshelper.php MsHelper

activePpreapprovalkey < Activate Adaptive preapproval key
addHttp < Add schema to a URL (deprecated)
addOcDownload < Insert a new OpenCart download record
addPpreapprovalkey < Create Adaptive preapproval key
addScheme < Add schema to a URL
addStyle < Add a new stylesheet to OpenCart's $styles arra
adminUrlLink < Create an admin-area URL
admLoadTemplate < Load an admin-area template 
admSetBreadcrumbs < Init admin-area breadcrumbs
ceiling < Ceil a number to the higher significance number
createOCSetting < Create an OpenCart setting DB entry
deleteOcDownload < Delete an OpenCart download file
deleteOCSetting < Delete OpenCart setting
generateAddressForGoogleGeoLocation < Format an address for Google's geolocation API
generateMetaDescription < Generate a meta description
getFilterParams < Get filter parameters
getIntegrationPackVersion < Get the version of the currently installed MultiMerch theme integration
getLanguageId < Get the current language id
getNumberOfSignificantDigits < Get the number of significant digits
getOcDownload < Fetch an OpenCart download
getPpreapprovalkey < Get Adaptive preapproval key
getSortParams < Get sort parameters for DataTables
getStatusName < Get the name of an order status (translated)
getStockStatuses < Get OpenCart stock statuses
getTaxClasses < Get OpenCart tax classes
isInstalled < Verify if MultiMerch is installed
isPowerOf < Verify if one number is power of another one
isUnsignedFloat < Verify if a number is an unsigned float
isValidUrl < Verify if a parameter is a valid URL
loadTemplate < Load a catalog-area template
renderPmDialog < Render a private message dialog
setBreadcrumbs < Init catalog-area breadcrumbs
setVqmod < Turn a vQmod modification file on/off
slugify < Create a SEO-friendly slug from a string
trueCurrencyFormat < Convert a number to a true currency format
uniformDecimalPoint < Replace all non-default decimal points in a number

system/library/msloader.php MsLoader

_autoloadController < Autoload MultiMerch controllers
_autoloadLibrary < Autoload MultiMerch models
_autoloadMultimerchlib < Autoload MultiMerch libraries
appVer < MultiMerch application version
dbVer < MultiMerch database schema version
getInstance < Get the Loader instancec
getRegistry < Get Registry
langVer < MultiMerch language file version
load < Load a MultiMerch class with namespace support
setRegistry < Set Registry

system/library/msmail.php MsMail

_getOrderProducts < Get products belonging to an order
_modelExists < Verify if a model exists (deprecated)
sendOrderMails < Send emails related to an order

system/library/msmessage.php MsMessage

createMessage < Create a new message in a conversation
createMessageAttachment < Create a new message attachment
deleteMessage < Delete a message
getMessageAttachments < Get message attachments
getMessages < Get conversation messages

system/library/msoption.php MsOption

createOrUpdateMsOption < Create/update an option
deleteOption < Delete an option
getOptions < Get options
getOptionValues < Get option values
getProductsByOptionId < Get products linked to an option
isMsOption < Verify if an id belongs to a valid MultiMerch seller option
ocGetTotalProductsByOptionId < Get the total number of products linked to an option
sellerActivateOption < Activate an option (seller account)
sellerCreateOption < Create a seller option
sellerDeactivateOption < Deactivate an option (seller account)
sellerUpdateOption < Update a seller option
STATUS_ACTIVE < Active options
STATUS_APPROVED < Approved options
STATUS_DISABLED < Disabled options
STATUS_INACTIVE < Inactive options

system/library/msorderdata.php MsOrderData

addOrderComment < Create a new order comment
addOrderProductData < Create a new order product data record (products linked to an order)
addOrderProductShippingData < Create a new order product shipping data record (vendor shipping data linked to an order)
getOrderComment < Get an order comment
getOrderData < Get order data records
getOrderMsCouponTotal < Get order coupon totals
getOrderProducts < Get order products
getOrderProductShippingCost < Get order shipping costs (vendor shipping)
getOrders < Get orders
getOrderStateByStatusId < Get order state by order status id
getOrderStateData < Get order state data (transalted)
getOrderTotal < Get the order total value
isOrderCreatedByCustomer < Verify if the order was created by a specific customer
STATE_CANCELLED < Cancelled orders
STATE_COMPLETED < Completed orders
STATE_FAILED < Failed orders
STATE_PENDING < Pending orders
STATE_PROCESSING < Processing orders

system/library/mspayout.php MsPayout

createPayout < Create a new payout
deletePayout < Delete a payout
getInvoiceIdByPayoutId < Get the invoice number for a payout
getPayoutIdByInvoiceId < Get the payout number for an invoice
getPayouts < Get payouts
getSellers < Get sellers within a payout
updatePayout < Update a payout

system/library/mspgpayment.php MsPgPayment

ADMIN_ID < Admin's DB id
ADMIN_SETTING_PREFIX < Prefox for admin settings
createPayment < Create a payment
deletePayment < Delete a payment
getPayments < Get payments
getPaymentStatus < Get payment's status
METHOD_BALANCE < Payments from seller's balance
METHOD_PG < Payments via MultiMerch payment methods
SELLER_SETTING_PREFIX < Prefix for seller settings
STATUS_COMPLETE < Complete payments
STATUS_INCOMPLETE < Incomplete payments
STATUS_WAITING_CONFIRMATION < Unconfirmed payments
TYPE_PAID_REQUESTS < Payouts
TYPE_SALE < Sale payments (Adaptive)
updatePayment < Update a payment

system/library/mspgrequest.php MsPgRequest

createRequest < Create an invoice (payment request)
deleteRequest < Delete an invoice
getRequests < Get invoices
getRequestType < Get invoice type
getTotalAmount < Get the total invoice amount
STATUS_PAID < Paid invoices
STATUS_REFUND_REQUESTED < Refund requests
STATUS_REFUNDED < Refund invoices
STATUS_UNPAID < Unpaid invoices
TYPE_LISTING < Listing invoices
TYPE_PAYOUT < Payout invoices
TYPE_PAYOUT_REQUEST < Payout request invoices (deprecated)
TYPE_RECURRING < Recurring invoices (deprecated)
TYPE_SALE < Sale invoices (Adaptive)
TYPE_SIGNUP < Signup fee invoices
updateRequest < Update an invoice

system/library/msproduct.php MsProduct

_createProduct < Create a new product record
_saveAttributes < Save product attributes
_saveCustomFields <  Save custom product fields
_saveDescriptions <  Save product descriptions (translated)
_saveDiscounts <  Save product discounts
_saveDownloads <  Save product downloads
_saveFilters < Save product filters
_saveImages < Save product images
_saveKeyword < Save product SEO slug
_saveMsCategories < Save product categories (MultiMerch seller categories)
_saveOcCategories < Save product categories (OpenCart)
_saveOptions < Save product options
_saveRelated < Save related products
_saveShipping < Save product shipping rates (vendor shipping)
_saveSpecials < Save product specials
_saveStores < Save product to store links
_updateDescriptions < Update product descriptions
_updateDownloads < Update product downloads
_updateImages < Update product images
_updateProduct < Update a product record
approve < Approve a product
changeSeller < Assign a product to a new seller
changeStatus < Change product's status
createRecord < Create a MultiMerch product record for an OpenCart product (ms_product)
deleteProduct < Delete a product
disapprove < Unapprove a product
editProduct < Edit a product
getDefaultStockStatus < Get the default OpenCart stock status
getDownload < Get a download
getManufacturers < Get OpenCart manufacturers
getProduct < Fetch a product record
getProductCommissionId < Get product commission records (fees)
getProductDiscounts < Get product discounts
getProductDownloads < Get product downloads
getProductImages < Get product images
getProductMsCategories < Get product categories (MultiMerch seller categories)
getProductOcCategories < Get product categories (OpenCart)
getProducts < Get products
getProductShipping < Get product shipping records (vendor shipping)
getProductSpecials < Get product specials
getProductStores < Get product to store links
getProductThumbnail < Get product's thumbnail
getSellerId < Get seller owning the product 
getStatus < Get product status
getTotalProducts < Get total products across the marketplace
getTotalProductViews < Get total product views across the marketplace
hasDownload < Verify if a download belongs to a product
isEnabled < Verify if a product is enabled
isShippableByOC < Verify if a product is shippable by OpenCart
MS_PRODUCT_VALIDATION_APPROVAL < Products requiring admin approval
MS_PRODUCT_VALIDATION_NONE < Products not requiring validation
productOwnedBySeller < Verify if a product is owned by a specific seller
saveProduct < Save a product record
STATUS_ACTIVE < Active products
STATUS_DELETED < Deleted products
STATUS_DISABLED < Disabled products
STATUS_IMPORTED < Imported products
STATUS_INACTIVE < Inactive products
STATUS_UNPAID < Unpaid products

system/library/msquestion.php MsQuestion

addAnswer  < Create an answer to a question
addQuestion < Create a question
deleteAnswer < Delete an answer
deleteQuestion < Delete a question
getAnswers < Get answers
getQuestions < Get questions
STATUS_DISABLED < Disabled questions
STATUS_ENABLED < Deleted questions

system/library/msreport.php MsReport

_calculateDateEnd < Get time period end date
_calculateDateStart < Get time period start date
_getAnalyticsData < Execute an SQL request and populate an array with sales analytics data
getCustomersCount < Get the total number of customers
getCustomersOnlineCount < Get the total number of customers online
getLastOrders < Get 5 latest orders
getOrdersCount < Get the total number of orders
getPaymentsData < Get the data for Payment report
getPayoutsData < Get the data for Payout report
getProductsCount < Get the number of products
getProductsViewCount < Get the number of product views
getSalesAnalytics < Get total orders and gross totals for each metric unit (week, month etc.) over a time period
getSalesByCustomerData < Get the data for Sales by customer report
getSalesByPeriodData < Get the data for Sales by period report
getSalesByProductData < Get the data for Sales by product report
getSalesBySellerData < Get the data for Sales by seller report
getSalesCount < Get the total number of sales
getSalesData < Get the data for Sales report
getSellerFinancesData < Get the data for Seller finances report
getSellerLastMessages < Get seller's last messages
getSellerLastOrders < Get seller's last orders
getSellersBalanceCount < Get the number of seller's balance records
getSellersCount < Get the number of sellers
getTopCountriesAnalytics < Get the data for Top countries dashboard block
getTopCustomersAnalytics < Get the data for Top customers dashboard block
getTopProductsAnalytics < Get the data for Top products dashboard block
getTopProductsByViewsAnalytics < Get the data for Top viewed products dashboard block
getTopSellersAnalytics < Get the data for Top sellers dashboard block
getTransactionsData < Get the data for Transactions report

system/library/msreturn.php (Deprecated)

MsReturn
_createReturnProduct
createReturn
createReturnHistory
getReturnData
getReturnHistory
getReturnsList
STATUS_CLOSED
STATUS_OPENED

system/library/msreview.php MsReview

addReviewComment < Create a new review comment (deprecated)
createOrUpdateReview < Create/update a review
createReviewAttachment < Create a review attachment
deleteReview < Delete a review
deleteReviewAttachment < Delete a review attachment
deleteReviewComment < Delete a review comment (deprecated)
getFeedbackHistory < Get a history of reviews
getReviewAttachments < Get the list of review attachments
getReviewComments < Get the list of review comments
getReviews < Get reviews
setHelpful < Increment the helpful counter (deprecated)
STATUS_ACTIVE < Active reviews
STATUS_INACTIVE < Inactive reviews

system/library/msseller.php MsSeller

_dupeSlug < Generate a suffixed SEO slug if one already exists
adminEditSeller < Edit seller (for admin-area use)
changeApproval < Approve/unapprove a seller
changeStatus < Change seller's status
createSeller < Create a seller account
deleteSeller < Delete a seller account
editSeller < Edit seller
getCompany < Get seller's company
getCountryId < Get seller's country id
getCustomers < Get customers
getDescription < Get seller's store description (translated)
getNickname < Get seller's nickname
getSalt < Get seller's DB salt
getSeller < Get seller data
getSellerAvatar < Get seller's avatar
getSellerBanner < Get seller's banner
getSellerCustomers < Get seller's customer list
getSellerDescriptions < Get seller descriptions in bulk (translated)
getSellerEmail < Get seller's email
getSellerFullName < Get seller's full name
getSellerGoogleGeoLocation < Get seller's geolocation data
getSellerMsCategories < Get seller's categories
getSellerName < Get seller's name
getSellerNickname < Get seller's nickname
getSellers < Get the list of sellers
getStatus < Get seller's status
getTotalEarnings < Get seller's total earnings
getTotalSellers < Get the total number of sellers
isCustomerSeller < Verify if the customer has a seller account
MS_SELLER_VALIDATION_ACTIVATION (deprecated)
MS_SELLER_VALIDATION_APPROVAL < Sellers requiring approval
MS_SELLER_VALIDATION_NONE < Sellers requiring no validation
nicknameTaken < Verify if the nickname is free
STATUS_ACTIVE < Active sellers
STATUS_DELETED < Deleted sellers
STATUS_DISABLED < Disabled sellers
STATUS_INACTIVE < Inactive sellers
STATUS_INCOMPLETE < Incomplete sellers
STATUS_UNPAID < Unpaid seller accounts
updateSellerPositions < Update seller geolocation positions

system/library/mssellergroup.php MsSellerGroup

createSellerGroup < Create a seller group
deleteSellerGroup < Delete a seller group
editSellerGroup < Edit a seller group
getSellerGroup < Get seller group
getSellerGroupBySellerId < Get specific seller's group
getSellerGroupDescriptions < Get seller group descriptions (translated)
getSellerGroups < Get seller groups
getTotalSellerGroups < Get the total number of seller groups

system/library/mssetting.php MsSetting

_slr_gr_settings < The array of default seller group settings
_slr_settings < The array of default seller settings
calculateSellerSettingValue < Calculate settings that apply to a specific seller
createSellerGroupSetting < Create seller group settings
createSellerSetting < Create seller settings
deleteSellerGroupSetting < Delete seller group settings
deleteSellerSetting < Delete seller settings
getSellerDefaults < Get seller's default settings
getSellerGroupDefaults < Get group's default settings
getSellerGroupSettings < Get settings for a seller group
getSellerSettings < Get settings for a seller

system/library/msshippingmethod.php MsShippingMethod

createShippingDeliveryTime < Create delivery times for a shipping method
createShippingMethod < Create a shipping method
deleteShippingDeliveryTime < Delete delivery times for a shipping method
deleteShippingMethod < Delete a shipping method
editShippingDeliveryTime < Edit delivery times for a shipping method
editShippingMethod < Edit a shipping method
getSellerShipping < Get seller's shipping settings
getShippingAvailability < Verify if a shipping method is available for a product
getShippingCompanies < Get the list of shipping companies
getShippingCountries < Get the list of shipping countries
getShippingDeliveryTimes < Get the list of shipping delivery times
getShippingGeoZones < Get the list of shipping geozones
getShippingMethods < Get the list of shipping methods
getTotalCombinedShippingRulesByMethodId < Get the total number of combined shipping rules for a specific method
getTotalProductShippingRulesByMethodId < Get the total number of product shipping rules for a specific method
saveSellerShipping < Save seller's shipping settings
shippingMethodExists < Verify if a shipping method exists
STATUS_DISABLED < Disabled shipping methods
STATUS_ENABLED < Enabled shipping methods

system/library/msstatistic.php MsStatistic (Deprecated)

_getConcatStatuses
getGrandTotalSales
getSalesByDay
getSalesByMonth
getSalesByYear
getStatsByProducts
getStatsByYears
getTotalByYear
getYearsOfOrdersBySeller

system/library/mssuborder.php MsSuborder

addSuborderHistory < Create a seller order history record
createSuborder < Create a new seller order
getOrders < Get the list of orders
getSuborderHistory < Get suborder's history
getSuborders < Get the list of suborders
getSuborderStatus < Get the status of a seller order
getSuborderTotals < Get the totals for a seller order
isValidSeller < Verify if a seller is valid
STATE_CANCELLED < Cancelled seller orders
STATE_COMPLETED < Completed seller orders
STATE_FAILED < Failed seller orders
STATE_PENDING < Pending seller orders
STATE_PROCESSING < Processing seller orders
updateSuborderStatus < Update the status of a seller order

system/library/mssuborderstatus.php MsSuborderStatus

addMsSuborderStatus < Create a new seller order status record
deleteMsSuborderStatus < Delete a seller order status
editMsSuborderStatus < Edit a seller order status
getMsSuborderStatuses < Get the list of seller order statuses
getOcOrderStatuses < Get the list of OpenCart order statuses
getSuborderStateByStatusId < Get the state of a specific seller order
getSuborderStateData < Get the data of a seller order state
getSubStatusName < Get the name of a seller order (Deprecated)

system/library/mstransaction.php MsTransaction

_getOrderProducts < Get the products belonging to an order
_getTotalSellerProductsInCart < Get the total number of seller's products in cart
adminUpdateMsOrderDataEntries < Update seller order data entries (for admin-area use)
createMsOrderBalanceEntries < Create seller order balance entries (transactions)
createMsOrderDataEntries < Create seller order data entries (seller order details)
getOrderCoupon < Get order coupon
processBalance < Seller's order balance processing routine (at order status change)
processCommission < Seller's commission processing routine (at order status change)
processMsCoupon < Process seller coupon discounts (at order status change)
processMsOrderData < Create order data entries for each order product (at order status change)
processShipping < Create order shipping entries for each order product (at order status change)
processSuborder < Create seller orders (at order status change)

system/library/msvalidator.php MsValidator

validate < Core validator method
validate_alpha_numeric < Validate alphanumeric values
validate_max_len < Validate maximum variable length
validate_min_len <  Validate minimum variable length
validate_numeric <  Validate numeric variables
validate_phone_number <  Validate phone numbers
validate_required <  Validate requireed fields
validate_valid_url < Validate URLs