Miva Merchant 9 Module API Reference Guide version 4.5 MM9-103-4.5 6/3/19 © Copyright 2005–2019, Miva®, Inc. Miva Merchant® and Miva Central® are registered trademarks of Miva®, Inc. UPS, THE UPS SHIELD TRADEMARK, THE UPS READY MARK, THE UPS DEVELOPER KIT MARK AND THE COLOR BROWN ARE TRADEMARKS OF UNITED PARCEL SERVICE OF AMERICA, INC. ALL RIGHTS RESERVED. All rights reserved. The information and intellectual property contained herein is confidential between Miva® Inc and the client and remains the exclusive property of Miva® Inc. If you find any problems in the documentation, please report them to us in writing. Miva® Inc does not guarantee that this document is error free. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording or otherwise without the prior written permission of Miva® Inc. This document, and all materials, products and postings are made available on an “as is” and “as available” basis, without any representation or warranty of any kind, express or implied, or any guaranty or assurance the document will be available for use, or that all products, features, functions or operations will be available or perform as described. Without limiting the foregoing, Miva® Inc is not responsible or liable for any malicious code, delays, inaccuracies, errors, or omissions arising out of your use of the document. As between you and Miva® Inc, you are assuming the entire risk as to the quality, accuracy, performance, timeliness, adequacy, completeness, correctness, authenticity, security and validity of any and all features and functions of the document. The Miva Merchant® logo, all product names, all custom graphics, page headers, button icons, trademarks, service marks and logos appearing in this document, unless otherwise noted, are trademarks, service marks, and/or trade dress of Miva® Inc (the “Marks”). All other trademarks, company names, product names, logos, service marks and/or trade dress displayed, mentioned or otherwise indicated on the Web Site are the property of their respective owners. These Marks shall not be displayed or used by you or anyone else, in any manner, without the prior written permission of Miva® Inc. You agree not to display or use trademarks, company names, product names, logos, service marks and/or trade dress of other owners without the prior written permission of such owners. The use or misuse of the Marks or other trademarks, company names, product names, logos, service marks and/or trade dress or any other materials contained herein, except as what shall be permitted herein, is expressly prohibited. © Copyright 2005–2019, Miva®, Inc. All Rights Reserved. Miva Merchant 9 Module API Reference Guide Table of Contents CHAPTER 1 Introduction 7 About Miva Merchant API ..............................................................7 Intended Audience ...........................................................................8 Purpose of This Guide .....................................................................8 Requirements ...................................................................................8 Development Accounts ...................................................................9 Document Conventions ...................................................................9 Terminology ....................................................................................9 Recommended Reading .................................................................10 Training Videos ............................................................................. 11 Technical Support .......................................................................... 11 CHAPTER 2 API Overview 13 Miva Merchant Limited Source Kit ..............................................14 Implementing a Module API Feature ............................................15 The “.mv” File .....................................................................................15 Creating a New Function .....................................................................17 Calling a Function From the API .........................................................17 Global Variables ...................................................................................17 Uploading a Module to Miva Merchant ...............................................18 Building a New Module — the Easy Way ....................................18 CHAPTER 3 Module API 21 All Modules ...................................................................................22 Batch Report Feature (batchreport) ...............................................23 Box Packing Feature (boxpacking) ...............................................26 Clean Up Store Feature (cleanup_store) .......................................32 Client Side Feature (clientside) .....................................................33 Component Feature (component) ..................................................33 Component Module Provisioning Feature (component_prov) ......41 Currency Formatting Feature (currency) .......................................42 Shopping Interface Customer Actions Feature (custrt) .................44 Domain-level Module Data Support Feature (data_domain) ........46 Store-level Module Data Support Feature (data_store) .................48 3 Table of Contents Designer Feature (designer) ..........................................................49 Discount Feature (discount) ..........................................................52 Data Export Feature (export) .........................................................61 External Requirement Verification Feature (externalreq) .............63 Feed Feature (feed) ........................................................................64 Box Custom Fields Feature (fields_box) .......................................69 Category Custom Fields Feature (fields_cat) ................................76 Multiple Category Custom Fields Feature (fields_cat_map) ........83 Customer Custom Fields Feature (fields_cust) .............................84 Custom Fields Map Feature (fields_cust_map) .............................91 Order Custom Fields Feature (fields_ordr) ...................................91 Multiple Order Custom Fields Feature (fields_ordr_map) ............98 Product Custom Fields Feature (fields_prod) ................................99 Multiple Product Custom Fields Feature (fields_prod_map) ......106 Order Fulfillment Feature (fulfill) ...............................................107 Data Import Feature (import) ......................................................108 JavaScript Object Notation Feature (json) ..................................122 JavaScript Object Notation Upload Feature (json_upload) .........123 Shopping Interface Activity Logging Feature (log) ....................125 Category Configuration Change Notification Feature (not_cat) .......................................................................................126 Customer Configuration Change Notification Feature (not_cust) .....................................................................................128 Digital Download Notification Feature (not_digital) ..................130 Customer Field Configuration Change Notification Feature (not_fields) ..................................................................................131 Gift Certificate Change Notification Feature (not_giftcert) ........133 Image Change Notification Feature (not_image) ........................135 Order Status Change Notification Feature (not_order) ...............136 OrderItem Status Change Notification Feature (not_orderitem) ............................................................................139 OrderReturn Status Change Notification Feature (not_orderreturn) .........................................................................141 OrderShipment Status Change Notification Feature (not_ordershpmnt) .......................................................................143 Payment Status Change Notification Feature (not_payment) .....145 Product Configuration Change Notification Feature (not_prod) ....................................................................................146 SEO Settings Change Notification Feature (not_seo) .................148 Subscription Settings Change Notification Feature (not_subscript) .............................................................................148 4 Miva Merchant 9 Module API Reference Guide URI Configuration Change Notification Feature (not_uri) .........150 Payment Processing Feature (payment) ......................................151 Product Facet Feature (prod_facet) .............................................176 Module Provisioning Feature (provision_store) .........................180 Report Feature (report) ................................................................180 Scheduled Task Feature (scheduledtask) .....................................194 Shipping Calculation Feature (shipping) .....................................200 Shipping Label Generation Feature (shipping_label) .................208 Framework Support Feature (skins) ............................................227 Store Selection Feature (storeselui) .............................................229 Shopping UI Feature (storeui) .....................................................232 Store Wizards Feature (storewizard) ...........................................238 System Extensions Feature (system)