Miva Merchant Post Setup Provisioning

Note that Miva Merchant 4 is the previous version of Merchant.  We recommend using Miva Merchant 5.  This documentation is provided as a resource for users of the older version only.
 

Post Setup Provisioning

Related Products

Introduction

Simple Administration

Basic File Format

Upsell

Data Formatting

Module Codes and Data

Order of Data

Currency

Provisioners

Fulfillment

Who should use provide.dat?

Payment

Commands

Shipping Modules

Action Codes and Data

Tax Modules

Domain and Store Actions

User Interface Provisioning

Affiliates

MMUI

Attribute Templates

KCUI

Category

Samples

Customers, Availability Groups, and Price Groups

Store

Groups

Currency

Inventory

Tax

Mailing Lists (in 4.13)

Payment

Notifications

Shipping

Products and Attributes

 
 

Post Setup Provisioning

Provisioning allows an Web Host to customize certain parts of Miva Merchant and to preset data for a given Miva Merchant installation. There are these types of provisioning:

Note: Each reference to provide.dat is also applicable to pre-provide.dat. Except, the pre-provide.dat file processes before login.

- After Login

Occurs every time a user logs into the Miva Merchant Administration Interface.

The provide.dat and pre-provide.dat files may contain multiple records to add or change nearly any data, from store merchandise to configurations and settings. Therefore, only experienced Web Host and Administrators should use provisioning. This guide describes post-setup provisioning.

Introduction

Virtually all data the software reads can be added, modified, or deleted including, for example, Stores, Users, Groups, States, Categories, Products, Inventory, Availability Groups, Price Groups, Shipping Configuration, Payment Configuration, among many others. The Internet Host Provider must create a data file (provide.dat or preprovide.dat) containing the instructions and the data.

Caution: Only experienced and knowledgeable Web Host and Administrators should use Post Setup Provisioning.

Any errors that occur while the either of the Post-Setup Provisioning files are processed are logged to provide.log. By default, the Post-Setup Provisioning files are deleted after processing.

Provide.dat and preprovide.dat must be placed in the data directory.

Basic File Format

Each line in is an item that defines data and what the domain or store will do the data. The fields are:

product|version|store|type|code|delimiter|data

Field

Description

product

MERCHANT

version

blank, unless otherwise defined

store

The store code to which this item belongs.
Blank if this is a domain-level action.
If store code is invalid, an error occurs

type

COMMAND
causes the provisioning system to alter it's behavior, such as clear a
log.
ACTION
Updates core databases.
MODULE
Updates the specified module.

code

If type is action, code is the action code example: CREATE_STORE.
If type is Module, code is the module code, EXAMPLE: devat

delimiter

the character used to delimit the rest of the data

data

The data passed to the action or module. A series of field values
delimited by the character specified in delimiter. The contents of the
data fields vary, depending on the code.

Data Formatting

Delimiters
The sixth field in the provide.dat file identifies the delimiter for the seventh field. This delimiter should not be a space, tab, or line feed. Miva Merchant will remove these. Many of the Action Codes take data whose delimiter you define (in the sixth field), however, some Action/Module Codes use another delimiter to further identify the data. For example, the Action Code below uses the comma delimiter, but the privileges are separated with colons.

STORE_ADD_UPDATE_GROUP|,|group name,

privilege_code:view:add:modify:delete

Repetition
In certain cases a portion of the data is repeated to show the structure the data you enter should have. For example, the data for adding products to a category shows the category code, and the delimiter and product code enclosed in square brackets to show that you can repeat the product code as many times as required:

STORE_CATEGORY_ADD_PRODUCT|,|category_code, product_code[, product_code...]

Note: Do not use the square brackets when you enter the data.

Entering Data General Rules

Numbers
When the data calls for a number, do not use a symbol. For example, enter five percent as 5, not 5%; and enter ten dollars as 10, not $10.

Boolean
All Boolean fields take a Y (or y) for True, and an N (or n) for False. Although some Boolean fields may accept Yes or 1 for True, to be sure your data is valid, use Y or N for Booleans.

Keep Existing Data
If you want to keep the existing data for particular fields, in most cases you can leave that field empty. Put no data between the delimiters when defining the data.

Order of Data

The provide.dat file is read serially: the data at the beginning of the file is read first, and data at the end is read last. Some codes require that other data already exist. Therefore, remember to enter the data in this logical order. For example, the product data (STORE_ADD_UPDATE_PRODUCT), must appear before the product attribute data (STORE_ADD_UPDATE_ATTRIBUTE).

Provisioners

Who should use provide.dat?

Only experienced and knowledgeable Web Host and Administrators should use Post Setup Provisioning. Although the typical use may be to set up an initial store, this data can also be updated. The provide.dat file can contain multiple records to add or change nearly any data in a domain or store, thereby overwriting previous data on updates.

Caution: A store's products and other data, settings and configurations are overwritten when you use provide.dat. Therefore, when adding or updating a store, be sure to recheck which store is being updated.

Commands

Command

Description

CLEAR_LOG

Deletes the log file. Should be the first item in provide.dat.

SAVE_PROVIDE_DAT

By default provisioning deletes PROVIDE.dat. This command causes
the delete to be skipped.

INSERT_MESSAGE

In addition to the date/time stamp, inserts the specified data in the log
file.

MERCHANT|||COMMAND|INSERT_MESSAGE
MERCHANT|||COMMAND|INSERT_MESSAGE||The previous line was inserted using a blank insert message

Action Codes and Data

MERCHANT||StoreCode|ACTION|ACTION_CODE|DELIM|DATA

This section identifies the ACTION codes and the DATA associated with the corresponding ACTION code. The Actions are categorized, and the categories are in alphabetical order. Where necessary the data is defined.

Domain and Store Actions

Action Code

Data

ADD_UPDATE_STORE_SETTINGS

Use this Action Code to add a new
store and to update these settings for an existing store.

If you are adding a new store, do not enter a value for the 3rd field, store:

MERCHANT| | |ACTION|
ADD_UPDATE_STORE_SETTINGS|
delimiter|store data

You do not need to also use the Action Code STORE_INSTALL_MODULE
for the layout UI module, currency formatting and sales tax calculation modules. They are automatically installed using this action code.

NOTE: If you are using a third-party
module, first register it in the Domain, using DOMAIN_INSTALL_MODULE.

manager, store code, license #, store name, owner, email, company, address, city, state, zip, country, phone, fax, units of weight, basket time-out, price group overlap resolution, layout ui module, currency formatting, sales tax calculation, first order number, maintenance, no new customers, maintenance warning, maintenance message, order minimum quantity, order minimum price, order must meet both minimums, order minimum not met message

  1. manager

  2. store code

  3. license #

  4. store name

  5. owner

  6. email

  7. company*

  8. address

  9. city

  10. state

  11. zip

  12. country

  13. phone

  14. fax*

  15. weight units*

  16. basket time-out In minutes

  17. price group overlap resolutionHighest or lowest

  18. layout UI moduleMMUI or KCUI

  19. currency formattingusmoney, gencurr, eurocur

  20. sales tax calculationvat, shoptax, statetax, canvat,
    devat

  21. first order number

  22. maintenanceWhether or not to put store into maintenance mode (Boolean)

  23. no new customersNumber of minutes before store goes offline

  24. maintenance warning message

  25. maintenance message

  26. order minimum quantity

  27. order minimum price

  28. order must meet both minimums whether or not both minimums
    must be met (Boolean)

  29. order minimum not met message

* These fields accept #none# to force a blank field.

DOMAIN_UPDATE_NOTIFICATIONSE
TTINGS

Notification Settings (4.10, 4.12)

server_url, security_alerts, software_updates, special_offers,
check_notifications

  1. server_urlthe url to your notification server

  2. security_alertsWhether or not Security Alerts is on/checked
    (Boolean)

  3. software_updatesWhether or not Software Updates is on/checked
    (Boolean)

  4. special_offersWhether or not Special Offers is on/checked
    (Boolean)

  5. check_notificationsL = at every Login
    D = Daily
    W = Weekly
    N = Never

DOMAIN_UPDATE_NOTIFICATIONSE
TTINGS

Notification Settings (4.13)

server_url, security_alerts, software_updates, tips, docs, enews,
special_offers, check_notifications

  1. server_urlthe url to your notification server

  2. security_alertsWhether or not Security Alerts is on/checked
    (Boolean)

  3. software_updatesWhether or not Software Updates is on/checked (Boolean)

  4. tipsWhether or not Tips & Tricks is on/checked (Boolean)

  5. docsWhether or not Documentation Updates is on/checked (Boolean)

  6. enewsWhether or not E-Commerce Newsletter is on/checked (Boolean)

  7. special_offersWhether or not Special Offers is on/checked (Boolean)

  8. check_notificationsL = at every Login
    D = Daily
    W = Weekly
    N = Never

DELETE_STORE

(4.0)

store code in third field of the basic file format.

MERCHANT| |store_code|ACTION| DELETE_STORE

DELETE_STORE

(4.1)

store code is the data.

MERCHANT| | |ACTION|DELETE_STORE|,|store_code

DOMAIN_UPDATE

(4.0)

Domain name, license #, owner, email, company, address, city, state, zip, country, phone, fax, mm_url, mm_surl, admin_surl, graphic_root, base_url, base_surl, mod_root, mod_sroot, Administration Session Timeout, mailserver, mailangle, Layout UI, Failed Login Lockout Time, Failed Login Attempts Allowed

  1. Domain name

  2. license #

  3. owner

  4. email

  5. company*

  6. address

  7. city

  8. state

  9. zip

  10. country

  11. phone

  12. fax*Accepts blank to retain existing data, and the special value #none# to force a null to change from an entry to blank

  13. mm_url URL to Miva Merchant

  14. mm_surl*Secure URL to Miva Merchant

  15. admin_surl*Secure URL to Miva Merchant Administration

  16. graphic_rootRoot directory for graphics

  17. base_urlBase URL for graphics

  18. base_surl*Secure base URL for graphics

  19. mod_rootRoot directory for modules

  20. mod_sroot*Secure root directory for modules

  21. admexpAdmin session timeout

  22. mailserverHostname or IP address of the SMTP
    server

  23. mailangle (Boolean, Y if mail server requires angle brackets or N if it does not.)

  24. Layout UI mmui or kcui

  25. Failed Login Lockout Time

  26. Failed Login Attempts Allowed

* These fields accept #none# to force a blank field.

DOMAIN_UPDATE

(4.1x)

IP added in 4.15

Domain name, license #, owner, email, company, address, city, state, zip, country, phone, fax, mm_url, mm_surl, admin_surl, graphic_root, base_url, base_surl, mod_root, mod_sroot, Administration Session Timeout, mailserver, mailangle, Layout UI, Failed Login Lockout Time, Failed Login Attempts Allowed, img_delimit, img_ext, mailmeth, strict_codes, IP

  1. Domain name

  2. license #

  3. owner

  4. email

  5. company*

  6. address

  7. city

  8. state

  9. zip

  10. country

  11. phone

  12. fax*Also accepts blank to retain existing data

  13. mm_url URL to Miva Merchant

  14. mm_surl*Secure URL to Miva Merchant

  15. admin_surl*Secure URL to Miva Merchant Administration

  16. graphic_rootRoot directory for graphics

  17. base_urlBase URL for graphics

  18. base_surl*Secure base URL for graphics

  19. mod_rootRoot directory for modules

  20. mod_sroot*Secure root directory for modules

  21. admexpAdmin session timeout

  22. mailserverHostname or IP address of the SMTP server

  23. mailangle (Boolean, Y if mail server requires angle brackets or N if it does not.)

  24. Layout UI mmui or kcui

  25. Failed Login Lockout Time

  26. Failed Login Attempts Allowed

  27. img_delimiterthe delimiter used for specifying image
    extensions. (ex: , %, gif% jpg% pal,mailmethod)

 NOTE: Img_delimiter cannot be the same as your data delimiter.

  1. Image Extensions* Identifies the type of the image extensions to be allowed for uploading.

  2. mailmeth* The optional commerce library method to use for an MvCOMMERCE call to send mail. If set, the commerce library will be called when sending mail rather than using
    the MvSMTP Tag.

  3. strict_codes Whether or not to restrict allowed characters for code fields. Boolean.

  4. IPCaptures IP for administrative session.

* These fields accept #none# to force a blank field.

DOMAIN_UPDATE_ADMINDISABLING

Domain Settings, Modules, Payment, Shipping, Fulfillment, Users, Logging, System Extension, Maxstores

  1. Domain Settings - Boolean

  2. Modules - Boolean

  3. Payment - Boolean

  4. Shipping - Boolean

  5. Fulfillment - Boolean

  6. Users - Boolean

  7. Logging - Boolean

  8. System Extension - Boolean

  9. util - Boolean

  10. Maxstores - Maximum number of store for this domain. 0
    indicates no limit

DOMAIN_ADD_UPDATE_USER

name, password, admin, create, parent, page_len, simple_mode

  1. name - User Name, required

  2. password - Required when adding a new user

  3. admin - Whether or not user has Administrative rights (Boolean)

  4. create - Whether or not User May Create Additional Users (Boolean)

  5. parent - Name of the user who created this user

  6. page_len - Items per Page for this User

  7. simple mode - Whether or not the Simple Administration Interface should load for this User (Boolean)

DOMAIN_DELETE_USER

name

DOMAIN_ACTIVATE_MODULE

(4.1x)

module code
Activates a module that has been inactive.

DOMAIN_DEACTIVATE_MODULE

(4.1x)

module code
Deactivates a module.

DOMAIN_INSTALL_MODULE

path/module name

NOTE: path is relative to the module root

DOMAIN_UNINSTALL_MODULE

module code

STORE_ADD_UPDATE_STATE

state_code, state_name[, state_code, state_name...]

State_code is the 2 letter abbreviation. One state_code may be #none# (which in the default Miva Merchant store is used for Outside US.

MERCHANT| |storeUSA|ACTION|STORE_ADD_UPDATE_STATE|; |
CA;California;IN;Indiana

STORE_CLEAR_STATE

(no data)

CAUTION: clears the state database.

STORE_DELETE_STATE

state_code[, state_code...]

Removes the state(s) from the store.

STORE_ADD_UPDATE_COUNTRY

country_code[, country_code...]

NOTE: country_code must appear in the domain country table. This is the 2 letter ISO code for the country.

STORE_DELETE_COUNTRY

country_code[, country_code...]

Unassigns the country or countries from the store.

STORE_CLEAR_COUNTRY

(no data)

Unassigns all countries.

STORE_INSTALL_MODULE

module_code

NOTE:For a ui, tax, or currency module, Miva Merchant automatically uninstalls the previous module.

STORE_UNINSTALL_MODULE

module_code

STORE_UPDATE_CUSTOMERFIELDS

BillingInfo, fname, lname, email, phone, fax, company, address, city, state, zip, country

All fields can only contain 1 character.

  • BillingInfo: H or R

  • All other fields: O - Optional, R - Required, H - Hidden)

Affiliates

Action Code

Data

STORE_UPDATE_AFFILIATEMANAGE

(Affiliate Email Notification)

active, from, to, cc, subject, header

  1. active - Whether or not to activate New Affiliates Email (Boolean)

  2. from - Accepts #affiliate# which causes the system to use the new affiliate's Email address.

  3. to - Accepts #affiliate# which causes the system to use the new affiliate's Email address.

  4. cc* - Accepts #affiliate and #none#

  5. subject

  6. header*


    * These fields accept #none# to force a blank field.

STORE_UPDATE_AFFILIATEEMAIL

(Lost Password Email)

from, cc, subject, header

  1. from

  2. cc*

  3. subject

  4. header*

* These fields accept #none# to force a blank field.

STORE_UPDATE_AFFILIATEOPTIONS

(Affiliate Configuration Options)

active, default status, hits, percent, commission_type, flat, terms,
payout_threshold, link_image, link_text

  1. activeWhether or not to activate the Affiliate program. (Boolean)

  2. default statusValues:
     RPending
     AApproved
     IDisabled

  3. hitsDefault Commission Per Referral

  4. percentDefault Commission Percent of Order

  5. flatDefault Commission Flat Fee Per Order

  6. terms*Terms and Conditions

  7. payout_thresholdAccumulated commission before payout

  8. link_image*image for affiliate's website

  9. link_text*Text for affiliate's website

NOTE: commission_type does not apply to 4.00.

  1. commission_typeValues:

     OEntire Order
     SSubtotal (not including Tax, Shipping)

* These fields accept #none# to force a blank field.

 

STORE_ADD_UPDATE_AFFILIATE

login, password, lostpass_email, site_name, site_url, contact_name,
email, company, phone, fax, address, city, state, zip, country, hits, percent, flat, status

  1. login

  2. password

  3. lostpass_email

  4. site_name*

  5. site_url*

  6. contact_name*

  7. email*

  8. company*

  9. phone*

  10. fax*

  11. address*

  12. city*

  13. state*

  14. zip*

  15. country*

  16. hitsCommission Per Referral

  17. percentCommission Percent of Order

  18. flatCommission Flat Fee per Order

  19. statusApplication Status:
    A = Approved
    P = Pending
    R = Rejected

NOTE: When adding a new affiliate, hits, percent, flat, and status will not be read from Affiliate Options. Enter the desired amounts in provide.dat.

* These fields accept #none# to force a blank field.

STORE_DELETE_AFFILIATE

 

code

Attribute Templates

Action Code

Data

STORE_ADD_UPDATE_ATTRIBUTET
EMPLATE

attribute template code, attribute template prompt

STORE_DELETE_ATTRIBUTETEMPL
ATE

attribute template code

STORE_ADD_UPDATE_ATTRIBUTET
EMPLATEATTRIBUTE

(Add or Update Attribute(s) in an
Attribute Template)

attribute template code, attribute code, type, prompt, price, cost, required,
image

  1. attribute template codeRequired

  2. attribute codeRequired

  3. typeradio
    select list
    checkbox
    text (for the Text Field)
    memo (for the Text Area)

  4. promptRequired when adding an attribute

  5. price

  6. cost

  7. requiredWhether or not this attribute is required
    (Boolean)

  8. Image*

NOTE: Price and Cost should be null when type is radio or select list

* This field accepts #none# to force a blank field.

STORE_DELETE_ATTRIBUTETEMPL
ATEATTRIBUTE

attribute template code, attribute code

STORE_ADD_UPDATE_ATTRIBUTET
EMPLATEOPTION

(Add or Update Option(s) in an Attribute Template)

attribute template code, attribute code, option code, prompt, price, cost, image, default

  1. attribute template codeRequired

  2. attribute codeRequired

  3. option codeRequired

  4. promptRequired when adding an option

  5. price

  6. cost

  7. image*

  8. defaultWhether or not this option is the default
    selection (Boolean)

* This field accepts #none# to force a blank field.

STORE_DELETE_ATTRIBUTETEMPL
ATEOPTION

attribute template code, attribute code, option code

Category

Action Code

Data

STORE_ADD_UPDATE_CATEGORY

category_code, name, parent, active

  1. category_codeRequired

  2. name Required when adding a new category

  3. parent*Category_code of parent category

  4. active Whether or not this category is active
    (Boolean)

* This field accepts #none# to force a blank field.

STORE_DELETE_CATEGORY

code

STORE_CATEGORY_ADD_PRODUCT

NOTE: The category and product
must already exist in the store, or
have an entry before this Action Code in the provide.dat file

category_code, product_code[, product_code...]

Assigns the product(s) to the category defined by category_code.

STORE_CATEGORY_REMOVE_PR
ODUCT

category_code, product_code[, product_code...]

Unassigns the product(s) from the category defined by the
category_code.

Customers, Availability Groups, and Price Groups

Action Code

Data

STORE_ADD_UPDATE_CUSTOMER

login, lost password email, password, shipping first name, shipping last name, shipping email, shipping company, shipping phone, shipping fax, shipping address, shipping city, shipping state, shipping zip, shipping country, bill same as ship, billing first name, billing last name, billing email, billing company, billing phone, billing fax, billing address, billing city, billing state, billing zip, billing country

  1. login

  2. lost password email

  3. password

  4. shipping first name*

  5. shipping last name*

  6. shipping email*

  7. shipping company*

  8. shipping phone*

  9. shipping fax*

  10. shipping address*

  11. shipping city*

  12. shipping state*

  13. shipping zip*

  14. shipping country* - 2 letter ISO country code

  15. bill same as ship - Boolean. If y then, the shipping data will be used for billing and the billing fields entered are ignored, so they can be blank.

  16. billing first name*

  17. billing last name*

  18. billing email*

  19. billing company*

  20. billing phone*

  21. billing fax*

  22. billing address*

  23. billing city*

  24. billing state*

  25. billing zip*

  26. billing country - 2 letter ISO country code*

    * These fields accept #none# to force a blank field when these fields are not required (You can control whether or not these fields are required using the code    )

STORE_DELETE_CUSTOMER

login

STORE_ADD_UPDATE_AVAILABILITY
GROUP

name

STORE_DELETE_AVAILABILITYGROU
P

name

STORE_AVAILABILITYGROUP_ADD_
CUSTOMER

NOTE: The availability group must
already exist in the store, or have an entry line before this Action Code in the provide.dat file.

Availability Group name, customer login[, customer login...]

Assigns an existing customer to the named Availability Group.

STORE_AVAILABILITYGROUP_REMO
VE_CUSTOMER

Availability Group name, customer login[, customer login...]

Unassigns the customer(s) from the named Availability Group.

STORE_AVAILABILITYGROUP_ADD_P
RODUCT

NOTE: The availability group must
already exist in the store, or have an entry line before this Action Code in the provide.dat file.

Availability Group name, product_code[, product_code...]

Assigns existing product(s) to the named Availability Group.

STORE_AVAILABILITYGROUP_REMO
VE_PRODUCT

Availability Group name, product_code[, product_code...]

Unassigns the product(s) from the named Availability Group.

STORE_AVAILABILITYGROUP_ADD_
CATEGORY

NOTE: The availability group must
already exist in the store, or have an entry line before this Action Code in the provide.dat file.

Availability Group name, category_code[, category_code...]

Assigns an existing category to the named Availability Group.

STORE_AVAILABILITYGROUP_REMO
VE_CATEGORY

Availability Group name, category_code[, category_code...]

Unassigns the category(ies) from the named Availability Group.

STORE_ADD_UPDATE_PRICEGROUP

Price Group name, Pricing rate, discount from retail, markup from cost

  • Pricing rate:

    R = Retail (i.e. Price)
    C = Cost
    D = Discount from Retail (%)
    M = Markup from cost (%)

If Pricing rate is D, enter the number with no percent symbol for 'discount from retail' and 'Markup from cost' is null:

MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_PRICEGROUP|
;| vendors; D;15;

If Pricing rate is M, enter the number with no percent symbol for 'markup from cost' and discount is null:

MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_PRICEGROUP|
;|vendors;M;;10

STORE_DELETE_PRICEGROUP

Price Group name

STORE_PRICEGROUP_ADD_CUSTO
MER

NOTE: The price group and customer(s) must already exist in the store, or have an entry line before this Action Code in the provide.dat file.

Price Group name, customer_code[, customer_code...]

Assigns an existing customer to the named Price Group.

STORE_PRICEGROUP_REMOVE_CU
STOMER

Price Group name, customer_code[, customer_code...]

Unassigns the customer(s) from the named Price Group.

STORE_PRICEGROUP_ADD_PRODU
CT

NOTE: The price group and product(s) must already exist in the store, or have an entry line before this Action Code in the provide.dat file.

Price Group name, product_code[, product_code...]
vendors; p1; p2; p3; p4

Assigns existing product(s) to the named Price Group.

STORE_PRICEGROUP_REMOVE_PR
ODUCT

Price Group name, product_code[, product_code...]

Unassigns the product(s) from the named Price Group.

Groups

Action Code

Data

STORE_ADD_UPDATE_GROUP

group name, privilege_code:view:add:modify:delete [, privilege_code:]

DataDescription

view, add, modify, delete Privilege type (Boolean)

Privilege_Codes:
AFLT - Affiliates
AGRP - Availability Groups
ATMP - Attribute Templates
CTGY - Categories
CURR - Currency Configuration
CUST - Customer
PMNT - Payment Configuration
SHIP - Shipping Configuration
FUFL - Order Fulfillment Configuration
INVT - Inventory
LOGM - Logging Configuration
MONY - Affiliate Money
ORDR - Order Processing
PGRP - Price Groups
PROD - Products
STAT - States
STAX - Sales Tax
STCT - Countries
STOR - Store Settings
SYSM - System Extension Configuration
SUTL - Store Utility Configuration
UPSL - Upsold Products

Example:

MERCHANT||ds|ACTION|STORE_ADD_UPDATE_GROUP|,|do-a-
lot,CTGY:y:y:y:y,CURR:y:y:y:y,FUFL:y:y:y:y,LOGM:y:y
:y:y,ORDR:y:y:y:y,PMNT:y:y:n:n,PROD:y:y:y:y,SHIP:y:
y:n:n,STAT:y:y:y:y,STAX:y:y:y:y,STCT:y:y:y:y,STOR:y
:y:y:y,SUTL:y:y:y:y,SYSM:y:y:y:y

STORE_DELETE_GROUP

Group name

STORE_GROUP_ADD_USER

group, user[, user...]

Assigns existing user(s) to the named group. (See DOMAIN_ADD_UPDATE_USER to add a new user to the domain.)

STORE_GROUP_REMOVE_USER

group, user[, user...]

Unassigns user(s) from the named group. It does not remove a user from the domain.

MERCHANT| |storeUSA|ACTION|STORE_GROUP_REMOVE_USER|
;|groupN; usr1; usr2

Inventory

Action Code

Data

STORE_UPDATE_INVENTORYSETTI
NGS

active, in_short, in_long, low_track, low_stock, low_short, low_long,
out_track, out_level, out_hide, out_short, out_long, ltd_long, eml_low,
eml_out, eml_from, eml_to, eml_cc, eml_sub, eml_msg

  1. active - Whether or not to Track Inventory (Boolean)

  2. in_short - In Stock Message (Short)

  3. in_long - In Stock Message (Long)

  4. low_track - Whether or not to track Low Stock Level (Boolean)

  5. low_stock - Low Stock Level (a number)

  6. low_short - Low Stock Message (Short)

  7. low_long - Low Stock Message (Long)

  8. out_track - Whether or not to track Out of Stock Level (Boolean)

  9. out_level - Out of Stock Level (a number)

  10. out_hide - Whether or not to hide Out of Stock Products (Boolean)

  11. out_short - Out of Stock Message (Short)

  12. out_long - Out of Stock Message (Long)

  13. ltd_long - Limited Stock Message

  14. eml_low - Whether or not to send Email When Stock is Low
    (Boolean)

  15. eml_out - Whether or not to send Email When Stock is Out
    (Boolean)

  16. eml_from - Email From

  17. eml_to - Email To

  18. eml_cc* - Email Copy

  19. eml_sub - Email Subject

  20. eml_msg - Email Message

* These fields accept #none# to force a blank field.

Action Codes and Data

Action Code

Data

STORE_ADD_UPDATE_INVENTORYP
RODUCTSETTINGS

product_code, add stock, active, in_short, in_long, low_track, low_level, low_short, low_long, out_track, out_level, out_hide, out_short, out_long, ltd_long

  1. product_code - Required

  2. add stock - Increase Stock By (adds this amount to current stock quantity)

  3. active - Whether or not to Track Inventory (Boolean)

  4. in_short* - In Stock Message (Short)

  5. in_long* - In Stock Message (Long)

  6. low_track - Track Low Stock Level (Y, N, or blank for default)

  7. low_level - Low Stock Level (QTY or #default#)

  8. low_short* - Low Stock Message (Short)

  9. low_long* - Low Stock Message (Long)

  10. out_track - Track Out of Stock Level (Y, N, or blank for default)

  11. out_level - Out of Stock Level (QTY or #default#)

  12. out_hide - Hide Out of Stock Products (Y, N, or blank for default)

  13. out_short* - Out of Stock Message (Short)

  14. out_long* - Out of Stock Message (Long)

  15. ltd_long* - Limited Stock Message

NOTE: in_short, in_long, low_level, low_short, low_long, out_level, out_short, out_long, ltd_long all accept #default# as a special value to read the value from the store's Inventory Settings.

* These fields accept #none# to force a blank field.

STORE_DELETE_INVENTORYPRODU
CTSETTINGS

product_code

Unchecks 'Track Inventory, removes stock levels and messages.

Mailing Lists (in 4.13)

Action Code

Data

STORE_MAILINGLIST_SETTINGS

account, server
 

  1. account - Required

  2. server - Required *

* If server is #DEFAULT# the default setting will be restored.
 

STORE_MAILINGLIST_
ADDUPDATELIST

mailing list code, prompt, show affiliates, default affiliates, show customers, default customers

  1. codeRequired

  2. promptThe prompt viewed in the store to
    subscribe to list. Required when adding

  3. show affiliatesWhether or not to show prompt on affiliates
    page (Boolean)

  4. default affiliatesWhether or not to check the prompt by
    default (Boolean)

  5. show customersWhether or not to show prompt on
    customer account and customer order
    information pages (Boolean)

  6. default customersWhether or not to check the prompt by
    default (Boolean)

Caution: Adding a Mailing List requires establishing a connection to
the Miva Merchant Mailer   server. Therefore, adding more than a few lists could cause a time out.

STORE_MAILINGLIST_DELETELIST

 

code

STORE_MAILINGLIST_SUBSCRIBE
CUSTOMERS

mailing list code, customer login [, customer login...]

  1. codeThe Mailing List code

  2. customer loginLogin field

The following subscribes the 4 customers to the mailing list, News1:

MERCHANT||ws6|ACTION|
STORE_MAILINGLIST_SUBSCRIBECUSTOMERS|;|News1;
jamesb; MaryP; Cust3, Cust4

Invalid customer Logins should generate a warning, but will not halt processing.

STORE_MAILINGLIST_
REMOVECUSTOMERS

mailing list code, customer login [, customer login...]
 

  1. code - The Mailing List code

  2. customer login - Login field

STORE_MAILINGLIST_SUBSCRIBE
AFFILIATES

mailing list code, affiliate code [, affiliate code...]

Same format as subscribe customers.

STORE_MAILINGLIST_REMOVE
AFFILIATES

mailing list code, affiliate code [, affiliate code...]

Same format as remove customers.

Notifications

Action Code

Data

ADD_NOTE

label, Note

  1. labelLink for Note

  2. NoteNote includes a button for User to delete the
    note.

If the store code (Field 3 of the Basic File Format) is included, the Note appears at the store level. If the Store Code is not included, the Note appears at the domain level.

Store Example:

MERCHANT||ds|ACTION|ADD_NOTE|,|Attention Store
Administrator, This is a Store Note.

Domain Example:

MERCHANT|||ACTION|ADD_NOTE|,|Domain Note, This is a
Domain Note.

Products and Attributes

Action Code

Data

STORE_ADD_UPDATE_PRODUCT

product_code, name, thumbnail, image, price, cost, description, weight, taxable, active

  1. product_code - Required

  2. name - Required when adding a product

  3. thumbnail* - Thumbnail-sized image

  4. image* - Full-sized image

  5. price - Retail price of product

  6. cost - Wholesale cost

  7. description* - Product description

  8. weight - Product weight

  9. taxable - Whether or not product is taxable
    (Boolean)

  10. active - Whether or not product is active (Boolean)

* These fields accept #none# to force a blank field.

STORE_DELETE_PRODUCT

product_code

STORE_ADD_UPDATE_ATTRIBUTE

product_code, attribute_code, type, prompt, price, cost, required, image

  1. product_code - Required

  2. attribute code - Required

  3. type - Radio, Select list, Checkbox, Text (for the Text Field), Memo (for the Text Area), Template (Enter the Attribute Template Code)

  4. prompt - Text

  5. price - Number

  6. cost - Number

  7. required - Whether or not this is a required
    attribute (Boolean)

  8. image*

Applying Attribute Template to Product:

product_code, attribute template code, template: attribute template
code, attribute template code

MERCHANT||storeUSA|ACTION|
STORE_ADD_UPDATE_ATTRIBUTE|;|p2;F01; template:F01;
F01;

* The image field accepts #none# to force a blank field.

STORE_DELETE_ATTRIBUTE

product_code, attribute_code

STORE_ADD_UPDATE_OPTION

product_code, attribute_code, option_code, prompt, price, cost,
image, default

  1. product_codeRequired

  2. attribute_codeRequired

  3. option_codeRequired

  4. promptRequired when adding new option

  5. price

  6. cost

  7. image*

  8. defaultWhether or not this option is preselected (Boolean).

* This field accepts #none# to force a blank field.

STORE_DELETE_OPTION

product_code, attribute_code, option_code

NOTE: all required'

Related Products

Action Code

Data

STORE_RELATEDPRODUCTS_ADD_
PRODUCT

product_code, related_product_code[, related_product_code...]

STORE_RELATEDPRODUCTS_REMO
VE_PRODUCT

product_code, related_product_code[, related_product_code...]

Simple Administration

Action Code

Data

CLEAR_TASKS

none
Removes all tasks from the database

DELETE_TASKS

code [,code...]

Removes the task(s) identified by the required code.

MERCHANT|||ACTION|DELETE_TASKS|,|SHWIZ, TFWIZ, CAWIZ,
TTWIZ, IRWIZ, PAWIZ, CSWIZ

ADD_UPDATE_DOMAINTASK

(4.1)

code, parent_code, module, label, params, completed

  1. code - Required. This is a code you create for this
    task.

  2. parent_code - The code for a task that must be performed before starting this task. Enter an existing code, or one you created.

    CSTORCreate Store
    CAWIZAdd Categories
    PAWIZAdd Products
    ATWIZAdd Attributes
    PCWIZConfigure Payment
    SHWIZConfigure Shipping
    AFWIZAffiliate Configuration
    AAWIZAdd Affiliates
    FCWIZOrder Fulfillment Configuration
    UIWIZConfigure Look & Feel

  3. module
    cswizard    Create Store Wizard
    cawizardAdd Categories
    pawizardAdd Products
    atwizardAdd Attributes
    pcwizardConfigure Payment
    shwizardConfigure Shipping
    afwizardAffiliate Configuration
    aawizardAdd Affiliates
    fcwizardOrder Fulfillment Configuration
    uiwizardConfigure Look & Feel

  4. label - Text to be displayed in association with the selected module and this task.

  5. params - &Step=2&Have_Fields=1&New_Step=2&PaymentWizard_Module_
    Code=cod&Module_New_Step=1&Module_Have_Fields=1

  6. complete - Whether or not task completed (Boolean)

ADD_UPDATE_TASK

(4.1)

code, parent_code, wizard module, label, level, params, priv, view, add,
modify, delete, completed

  1. code - Required. This is a code you create for this
    task.

  2. parent_code - The code for a task that must be performed
    before starting this task. Enter an existing code, or one you created.

    CSTORCreate Store
    CAWIZAdd Categories
    PAWIZAdd Products
    ATWIZAdd Attributes
    PCWIZConfigure Payment
    SHWIZConfigure Shipping
    AFWIZAffiliate Configuration
    AAWIZAdd Affiliates
    FCWIZOrder Fulfillment Configuration
    UIWIZConfigure Look & Feel

  3. wizard module -
    cswizard    Create Store Wizard
    cawizardAdd Categories
    pawizardAdd Products
    atwizardAdd Attributes
    pcwizardConfigure Payment
    shwizardConfigure Shipping
    afwizardAffiliate Configuration
    aawizardAdd Affiliates
    fcwizardOrder Fulfillment Configuration
    uiwizardConfigure Look & Feel

  4. label - Text to be displayed for this task.

  5. level - S = Store, D = Domain

NOTE: Level for code CSTOR (Create Store Wizard) is D, and is S for
other codes listed above.

  1. params

  2. priv - Privilege MANGR is a new, unique privilege. Identifies that only a store manager or administrator has privileges for this task.

  3. view - Privilege Level, Boolean

  4. add - Privilege Level, Boolean

  5. modify - Privilege Level, Boolean

  6. delete - Privilege Level, Boolean

  7. completed - Whether or not task is completed (Boolean), because you may have already set up the payment configuration, for example.

MERCHANT|||ACTION|ADD_UPDATE_TASK|,|IIWIZ,CSTOR,
shwizard, Shipping Assistant, S,, SHIP, Yes, Yes, No,
Yes, No

ADD_UPDATE_TASK

(4.00 only)

code, parent_code, wizard module, label, params, level, priv, view, add,
modify, delete, completed

  1. code - Required. This is a code you create for this task.

  2. parent_code - The code for a task that must be performed before starting this task. Enter an existing code, or one you created.

    CSTOR - Create Store
    CAWIZ - Add Categories
    PAWIZ - Add Products
    ATWIZ - Add Attributes
    PCWIZ - Configure Payment
    SHWIZ - Configure Shipping
    AFWIZ - Affiliate Configuration
    AAWIZ - Add Affiliates
    FCWIZ - Order Fulfillment Configuration
    UIWIZ - Configure Look & Feel

  3. wizard module
    cswizard     - Create Store Wizard
    cawizard - Add Categories
    pawizard - Add Products
    atwizard - Add Attributes
    pcwizard - Configure Payment
    shwizard - Configure Shipping
    afwizard - Affiliate Configuration
    aawizard - Add Affiliates
    fcwizard - Order Fulfillment Configuration
    uiwizard     - Configure Look & Feel

  4. label - Text to be displayed for this task.

  5. params

  6. level - S = Store, D = Domain

NOTE: Level for code CSTOR (Create Store Wizard) is D, and is S for other codes listed above.

  1. priv - Privilege

  2. view - Privilege Level, Boolean

  3. add - Privilege Level, Boolean

  4. modify - Privilege Level, Boolean

  5. delete - Privilege Level, Boolean

  6. completed - Whether or not task is completed (Boolean),
    because you may have already set up the payment configuration, for example.

STORETASK_UPDATE_COMPLETED

(4.1 only)

code, completed

Marks whether or not a Simple Administration task has been completed or not.

Upsell

Action Code

Data

STORE_UPDATE_UPSELLOPTIONS

products to show, upsold products to select

These Upsale Settings fields are both numbers.

STORE_ADD_UPDATE_UPSELL

product code, required percent, percent, price

  1. product code - required

  2. required percent

  3. percent - Boolean. Y indicates that the 'price' field is a
    percent of the original price. N indicates an absolute price.

  4. price

STORE_DELETE_UPSELL

product code

STORE_UPSELL_ADD_PRODUCT

upsold product code, required product code[, required product code...]

Assigns the 'required product code' to the upsale product.

STORE_UPSELL_REMOVE_PRODUCT

upsold product code, required product code[, required product code...]

Unassigns the 'required product code' from the upsale product.

Module Codes and Data

Currency

Module Code

Data

eurocur

symbol, after, thousands, decimal, rate, eursymbol, enclose, lbracket,
rbracket

  1. symbol - A currency symbol

  2. after - Whether symbol is positioned after Amount. If N, symbol is positioned before Amount.

  3. thousands - Thousands Separator

  4. decimal - Decimal Separator

  5. rate - Conversion Rate to Euros

  6. eursymbol - Euro Symbol

  7. enclose - P = Parenthesis, A = Angle Brackets, S = Square Brackets, O = Other

  8. lbracket - Left bracket if enclose is 'O'

  9. rbracket - Right bracket if enclose is 'O'

NOTE:If you are changing the decimal separator, when you enter the rate, use the decimal symbol that the store is currently using and not the new one you are changing it to.

MERCHANT||store_DE|ACTION|STORE_INSTALL_MODULE|;|
eurocur
MERCHANT||store_DE|MODULE|eurocur|;|DM; Y; .; ,;
.51129; ¬; O; {; }

gencurr

symbol, positive, negative, groupsymbol, groupsize, decimal symbol, digits after decimal, userdef

  1. symbol

      - None
    &DOLLAR - $
    ¥ -     ¥
    £ -     £
    &EURO -     ¬

  2. positive

    A = *1.1
    C = 1.1*
    B = * 1.1 (a space between positive symbol
    and Amount)
    D = 1.1 * (a space between positive symbol
    and value)

  3. negative

    A = (*1.1)
    B = -*1.1
    C = *-1.1
    D = *1.1-
    E = (1.1*)
    F = -1.1*
    G = 1.1-*
    H = 1.1*-
    I = -1.1 *
    J = -*1.1
    K = 1.1 *-
    L = * 1.1-
    M = * -1.1
    N = 1.1- *
    O = (* 1.1)
    P = (1.1 *)

  4. groupsymbol - Digit Grouping Symbol

  5. groupsize - Number of Digits in Group

  6. decimal symbol

  7. digits after decimal - Number of Digits after Decimal

  8. userdef

    1 = Currency Symbol 'Other'
    0 = Currency Symbol from list

MERCHANT||storeUSA|ACTION|STORE_INSTALL_MODULE|;|gencurr
MERCHANT||storeUSA|MODULE|gencurr|;|£;C;I;-;4;,;3;1

 

usmoney

Not provisionable

Fulfillment

Module Code

Data

custeml
(Customer Order Confirmation Email)

from, cc, subject, header

meremail

(Email Merchant Notification)

from Other, Other Email, to, cc, subject, header

  1. from Otheran Email address

  2. Other EmailBoolean

    • Y = the Email address 'from Other' should be used

    • N = the Customer's Email Address should be used

  3. toan Email address

  4. cccopy to

  5. subject

  6. header

MERCHANT||ds|MODULE|meremail|,|test@miva.com,
Y,test@miva.com, , subject, header

Payment

Module Code

Data

authnet

(Authorize.Net Payment Services v3.0)

login id, password, url, automatic capture, full cc, test mode, credit card type [, credit card type...]

  1. login ID string

  2. passwordstring

  3. url string

  4. automatic capture boolean:

    • Y is Online (Automatic Capture

    • N is Offline (Authorize Only, Capture Later)

  5. full ccboolean:

    • Y = store the entire credit card number

    • N = do not store the entire credit card number

  6. test modeboolean

  7. credit card type
    Visa
    MasterCard
    Amex
    Discover

NOTE: the case is sensitive.

This will enable only credit card types that are listed, and disable others that are not listed.

cod

charge, message

  1. charge - number (surcharge)

  2. message - optional string

icps

merchant_key, message, url

  1. merchant_keykey obtained from ICSP

  2. messageMessage to display during Checkout

  3. urlURL to Gateway

ics2

(CyberSource ICSv2 Payment Services)

 

merchant id, url, currency, full cc, credit card type

  1. merchant idis a string

  2. urlstring (URL to gateway)

  3. currencyCurrency code (3 characters)

  4. full ccboolean:

    • Y = store the entire credit card number

    • N = do not store the entire credit card number.

  5. credit card type:
    VISA
    MASTERCARD
    AMEX
    DISCOVER
    DINER

NOTE: the case is sensitive.

This will enable only credit card types that are listed, and disable others that are not listed.

 

linkpt

(Cardservice/LinkPoint Payment
Gateway)

store name, server, port, certif, pre-auth, store cc, test mode, credit card type[, credit card type...]

  1. store namename received from gateway

  2. serverURL to secure server

  3. portnumber

  4. certifDigital Certificate

  5. pre-authboolean:

    • Y = Pre-Auth/post-Auth

    • N = Sale

  6. store ccboolean:

    • Y = store the entire credit card number

    • N = do not store the entire credit card number

  7. test modeboolean

  8. credit card type:
    axAmerican Express
    cbCarte Blanche
    dcDiner's Club
    dsDiscover
    mcEurocard/MasterCard
    vsVISA

NOTE: the case is sensitive.

This will enable only credit card types that are listed, and disable others that are not listed.

lynksys

Lynk Systems
(in 4.15)

user_name, password, url, store_id, terminal_id, merchant_id,
charge_method, store_full_cc, cards [code, cvv2...]

  1. user_name

  2. password

  3. url

  4. store_id

  5. terminal_id

  6. merchant_id

  7. PreAuthBoolean:

    • Y = Pre-Auth, Authorize only Capture Later

    • N = Sale, Authorize and Capture now

  8. store_full_cc

    • Y = store the entire credit card number

    • N = do not store the entire credit card number

  9. cards [code, cvv2...]

MERCHANT||hhh|MODULE|lynksys|,|test, testing,
https://sundev.lynk-systems.com
/servlet/LynkePmtServlet, 123456789, 123456789,
123456789, Yes, Yes, visa, yes, amex, no

MOD10

(Credit Card Payment With Simple
Validation)

ADD_UPDATE, name, prefixes, lengths[, name, prefixes, lengths...]

MERCHANT||s2|MODULE|mod10|;| ADD_UPDATE; BankOne:3:14;
BankTwo:4:16

 - Example would add BankOne and BankTwo Credit Card selections.

DELETE, name[, name...]

paylink

(Verisign Payflow Link)

 

user id, password, url, capture, credit card type[, credit card type...]

  1. user id

  2. password

  3. url

  4. captureboolean:

    • Y = Automatic Capture

    • N = Authorize Only (Capture Later)

  5. credit card type:
    VISAVisa
    MASTERCARDMasterCard
    AMEXAmerican Express
    DISCOVERDiscover
    DINERDiner's club
    JCBJCB
    TCHTeleCheck

NOTE: the case is sensitive.

This will enable only credit card types that are listed, and disable others that are not listed.

paynet

4.0 Verisign Payflow Pro
(PaymentNet)

user id, password, host, port, proxy add, port, proxy logon, proxy pass, store cc, credit card type[, credit card type...]

  1. user id

  2. password

  3. hostURL

  4. port

  5. proxy addressURL

  6. proxy port

  7. proxy logon

  8. proxy password

  9. store ccboolean:

    • Y = store the entire credit card number

    • N = do not store the entire credit card number

  10. credit card type:
    VISAVisa
    MASTERCARDMasterCard
    AMEXAmerican Express
    DISCOVERDiscover
    DINERDiner's club
    JCBJCB

paynet

4.10-4.13 Verisign Payflow Pro
(PaymentNet)

user id, password, host, port, proxy add, port, proxy logon, proxy pass, store cc, credit card type[, credit card type, active...]

  1. user id

  2. password

  3. hostURL

  4. port

  5. proxy addressURL

  6. proxy port

  7. proxy logon

  8. proxy password

  9. store ccboolean:

    • Y = store the entire credit card number

    • N = do not store the entire credit card number

  10. credit card type:
    VISAVisa
    MASTERCARDMasterCard
    AMEXAmerican Express
    DISCOVERDiscover
    DINERDiner's club
    JCBJCB

  11. activeY = card is active; N = card is not active, not an
    available payment method (blank will leave current selection unchanged)

paynet

4.15 Verisign Payflow Pro
(PaymentNet)

user id, password, host, port, vendor, partner, proxy add, proxyport, proxy logon, proxypassword, store_cc, credit card type, active [credit card type, active...].

  1. user idfrom Verisign

  2. passwordfrom Verisign

  3. hostURL

  4. port

  5. vendorUsually same as user id

  6. partnerfrom Verisign

  7. proxy addressURL

  8. proxy port

  9. proxy logon

  10. proxy password

  11. store ccboolean:

  • Y = store the entire credit card number

  • N = do not store the entire credit card number

  1. credit card type:

    VISAVisa
    MASTERCARDMasterCard
    AMEXAmerican Express
    DISCOVERDiscover
    DINERDiner's club
    JCBJCB

  2. activeY = card is active; N = card is not active, not an
    available payment method (blank will leave
    current selection unchanged)

evalcheck

(e-ValuCheck - Accept checks for
immediate shipment )

(in 4.13)

UPDATE_SITE_INFO, exchange_id, merchant_id, merchant_password,
url, error_message

MERCHANT||s2|MODULE|eValuCheck|;|UPDATE_SITE_INFO;
12345; 34567; password;
https://www.evalucheck.net/default; Please select a
different payment method.

  1. exchange_ida string (optional). This is the ID that is assigned by eValuCheck so that eValuCheck can resolve the external merchant ID to the eValuCheck assigned merchant ID.

  2. merchant_id is a string (required). Identifies the merchant to
    eValueCheck system.

  3. merchant_password string(required). Required to be sent along with the ID. Identifies the merchant to eValuCheck
    system.

  4. urla string (required). Connects users to eValuCheck's transaction validation system.

  5. error_messagea memo (optional). Error message that will be
    displayed if the transaction has been rejected.

Enter #NONE# to erase the field.

UPDATE_MERCHANT_INFO, company, fname, lname, addr1, addr2,
city, state, zip, phone, email, tech_fname, tech_lname, tech_email,
operator1, operator2, coefficient, hidden_url, success_url, reject_url

  1. company

  2. fname

  3. lname

  4. addr1

  5. addr2optional

  6. city

  7. state2 character state code

  8. zip

  9. phone

  10. email

  11. tech_fname

  12. tech_lname

  13. tech_email

  14. operator1*must be either 0 (+) or 1 (–)

  15. operator2*must be either 0 (+) or 1 (–)

  16. coefficient*2 decimal point number and cannot be a 0

  17. hidden_url

  18. success_url

  19. reject_url

operator1, operator2, and coefficient are used in a verification algorithm.

evalcheck

(in 4.13)

MERCHANT||hhh|MODULE|evalcheck|,|UPDATE_MERCHANT_INFO,
my company, Mike, Myers, 2639 Boulevard, P.O.Box 358,
La Jolla, CA, 92829, 999-999-9999, test@rojhl.org,
Loren, Fields, lory@rojhl.org, 0, 0, .35,
http://localhost/Merchant/evalcheckp.mv,
http://localhost/Merchant/evalchecki.mv,
http://localhost/Merchant/evalcheckp.mv

UPDATE_CHECKSUM, operator_1, operator_2, coefficient

  1. operator1* - 0 or 1

  2. operator2* - 0 or 1

  3. coefficient* - 2 decimal point number, not 0

operator1, operator2, and coefficient are used in a verification algorithm.

 

rodopi

(R-P-G Rodopi Payment Gateway)

(in 4.13)

login, password, url, currency_symbol, charge_method, store_full_cc,
test_mode, card type [card type...]

  1. loginrequired

  2. passwordrequired

  3. urlrequired

  4. currency_symbolValid values are:
    1 (United States Dollar - USD)
    2 (Canadian Dollar - CAD)
    3 (French Francs - FRF)
    4 (German Deutsche mark - DEM)
    5 (Ireland Punt - IEP)
    6 (Japanese Yen - JPY)
    7 (Netherlands Guilder - NLG)
    8 (United Kingdom Pound - GBP)

  5. charge_methodBoolean. Yes for Online (Automatic Capture)
    and No for Offline (Authorize Only, Capture
    Later)

  6. store_full_ccBoolean:

    • Y = store the entire credit card number

    • N = do not store the entire credit card number

  7. test_modeBoolean

  8. card type
    Visa (Visa)
    MasterCard (MasterCard)
    Discover(Discover)
    AmerExp (American Express)

MERCHANT||hhh|MODULE|rodopi|,|test, testing,
https://secure.rsb-gateway.com/gateway/rsb.dll?, 1,
Yes, No, N, Visa, MasterCard, AmerExp

amerinet

(debit-it! - Full Service Online
Electronic Check Processing)

(in 4.13)

UPDATE_SITE_CONFIG, site_id, product_billing_id, mode

  1. site_idRequired. Code identifying the merchant to AmeriNet and can be obtained when creating an account through AmeriNet.

  2. product_billing_idRequired. Code identifying product billing
    specifics as assigned by AmeriNet.

  3. mode
    D     Primary Debit Format: Mode Name D005
    C     Debit Format for Check Guarantee: Mode Name W002
    A     Format for Authorization Only: Mode Name A002

UPDATE_MODE_D005, url, ssn, dl_num, dl_st

Note: mode D must be selected in UPDATE_SITE_CONFIG.

  1. urlRequired string to connect to Amerinet

  2. ssnBoolean. Whether or not to require the optional
    Social Security field.

  3. dl_numBoolean. Whether or not to require the optional
    Drivers License Number field

  4. dl_stBoolean. Whether or not to require the optional
    Drivers License State field.

UPDATE_MODE_W002, url, ssn, suffix, gender

Note: mode C must be selected in UPDATE_SITE_CONFIG.

  1. urlRequired. string to connect to Amerinet

  2. ssnBoolean. Whether or not to require the optional
    Social Security field.

  3. suffixBoolean. Whether or not to require the optional
    Suffix field. (For a personal or professional title,
    such as Sr. or Ph.D.)

  4. genderBoolean. Whether or not to require the optional
    Gender field.

UPDATE_MODE_A002, url

Note: mode A must be selected in UPDATE_SITE_CONFIG.

  1. urlRequired. string to connect to Amerinet

MERCHANT||hhh|MODULE|amerinet|,|UPDATE_SITE_CONFIG,
1234567, 1234567, D

MERCHANT||hhh|MODULE|amerinet|,|UPDATE_MODE_D005,
https://www.tssecure.com/tsscripts/D005.asp, yes, yes yes

igsgroup

(Innovative Gateway Solutions)

(in 4.13)

user_name, password, url, test_mode, charge_method, store_full_cc, card types [card types...]

  1. user_nameRequired.

  2. passwordRequired.

  3. urlRequired string to connect to igsgroup.

  4. test_modeBoolean. Whether or not to enter test mode.
    Always returns an approval.

  5. charge_methodYes for Preauth (Authorization Only)
    No for Sale (Authorize, and capture for
    settlement)

  6. store_full_ccBoolean:

    • Y = store the entire credit card number

    • N = do not store the entire credit card number

  7. card type
    visa (Visa)
    mc (MasterCard)
    discover (Discover)
    diners (Diner's Club)
    amex (American Express)
    jcb (JCB)

MERCHANT||hhh|MODULE|igsgroup|,|test, testing,
https://transactions.innovativegateway.com/servlet/com
.gateway.aai.Aai, Yes, Yes, Yes, visa, mc

usms

PayQuake (formerly U.S. Merchant
Systems - Accept Major Credit Cards)

(in 4.13)

user_name, password, url, terminal_id, merchant_id, charge_method,
store_full_cc, card type [card type, cvv2...]

  1. user_nameRequired

  2. passwordRequired

  3. urlRequired string to connect to usms

  4. terminal_idRequired

  5. merchant_idRequired

  6. charge_methodYes for PreAuth (Authorization Only)
    No for Sale (Authorize, and capture for
    settlement)

  7. store_full_cc

    • Y = store the entire credit card number

    • N = do not store the entire credit card number

  8. card type
    Visa (Visa)
    MasterCard (MasterCard)
    Discover (Discover)
    Diners (Diner's Club)
    Amex (American Express)
    JCB (JCB)

  9. cvv2Optional. Enter Yes (to require cvv2) or No (to
    not require cvv2) after each card type

MERCHANT||hhh|MODULE|usms|,|test, testing,
http://216.35.10.153:7001/gatewayservice/gateway.jsp,
123456789, 123456789, Yes, Yes, visa, mc

MERCHANT||hhh|MODULE|usms|,|elise, elisePass,
http://216.35.10.153:7001/gatewayservice/gateway.jsp, TermID123,
MerchantID123, Yes, No, Visa, yes, MasterCard, yes, Amex, no

The above would require cvv2 for Visa and MasterCard.

paypal

(in 4.14)

email, url, message

  1. email - merchant's business Email

  2. url - PayPal's gateway URL

  3. message - Additional message that displays on the Payment Information screen of the store

MERCHANT||hhh|MODULE|paypal|,|test@test.com,
https://www.paypal.com/cgi-bin/webscr, Please press
next to continue.

mvpay

Miva Merchant Payment
(in 4.15)

merchant id, url, currency, storeCC, [card type, cvv2...]

  1. merchant id

  2. URL

  3. currency

  4. store_full_cc

    • Y = store the entire credit card number

    • N = do not store the entire credit card number

  5. credit card type:
    VISAVisa
    MASTERCARDMasterCard
    AMEXAmerican Express
    DISCOVERDiscover
    DINERDiner's club
    JCBJCB

  6. cvv2 - Boolean

Shipping Modules

Module Code

Data

baseunit

(4.0 Base + Weight Shipping)

Shipping method, base charge, rate per weight unit [,Shipping Method,
base charge, rate per weight unit...]

baseunit

(4.1 Base + Weight Shipping)

 

This data field contains actions and data.

ADD_UPDATE_METHODS, Shipping method, base charge, rate per
weight unit [,Shipping Method, base charge, rate per weight unit...]

DELETE_METHODS, method [, method...]

flatrate

( 4.0 Flat Rate Shipping)

method, amount [,method, amount...]

MERCHANT||storeUSA|MODULE|flatrate|;|Domestic; 7.5;
International; 11

flatrate

( 4.1 Flat Rate Shipping)

This data field contains actions and data.

ADD_UPDATE_METHODS, method, cost [,method, cost...]

MERCHANT||storeUSA|MODULE|flatrate|;|
ADD_UPDATE_METHODS;Domestic; 7.5; International; 11

DELETE_METHODS, method [, method...]

minunit

(4.0 Minimum or Weight Shipping)

item[,item...]

Item = method, rate per weight unit, minimum charge

minunit

(4.1 Minimum or Weight Shipping)

This data field contains actions and data.

ADD_UPDATE_METHODS, method, rate per weight unit, minimum
charge [,method, rate per weight unit, minimum charge...]

MERCHANT||storeUSA|MODULE|flatrate|;|
ADD_UPDATE_METHOD; Holiday Special Shipping Price; 2;
4; Every Day Shipping; 3; 6

DELETE_METHODS, method [, method...]

mvfedex

FedEx
(in 4.14)

This data field contains actions and data.

SETTINGS, server, account, meter, base handling, percent handling,
minimum handling, drop off, signature

  1. serverOne of these:
    FedEx URL
    #TEST# (for testing purposes)
    #PROD# (for production)

  2. accountFedEx account number

  3. meterMeter number (may be left blank)

  4. base handlingbase charge for handling

  5. percent handlingpercent of shipment, charge for handling

  6. minimum handlingminimum charge for handling

  7. drop off typeOne of the following types:

    • 1regular pickup

    • 2request courier

    • 3drop box,

    • 4drop at BSC

    • 5drop at station

  8. signatureWhether signature required for home delivery.

MERCHANT||hhh|MODULE|mvfedex|,|SETTINGS,
#PROD#,123456789,987654321,1.00,50,3,1,yes

SERVICES, Service, enabled[, service, enabled... ]

  1. ServiceFedEx Services:

    • FDXE-01(FedEx Priority)

    • FDXE-03(FedEx 2day)

    • FDXE-05(FedEx Standard Overnight)

    • FDXE-06 (FedEx First Overnight)

    • FDXE-20(Express Saver)

    • FDXE-70(FedEx Overnight Freight)

    • FDXE-80 (FedEx 2day Freight)

    • FDXE-83(FedEx Express Saver Freight)

    • FDXG-90(FedEx Home Delivery)

    • FDXG-92(FedEx Ground Service)

    • #ALL#(All above services)

  2. EnabledBOOLEAN: whether Service is enabled or disabled. (Blank interpreted as Yes)

MERCHANT||hhh|MODULE|mvfedex|,|SERVICES,#ALL#,no,FDXG-
90,yes,FDXE-03,yes

(This sample disables all services, then enables Home Delivery and 2day).

qship

(Quantity Based Shipping)

 

This data field contains actions and data.

ADD_UPDATE_METHOD, method, progressive

  1. methodShipping Method

  2. progressiveBoolean:

    • Y = progressive mode (ADD_UPDATE_FLOOR creates the ranges

    for this selection.)

    • N selects the standard mode

ADD_UPDATE_FLOOR, method, floor, ceiling, rate [, floor, ceiling, rate...]

  1. method

  2. floor

  3. ceiling accepts numbers, and + is a valid value

  4. rate (amount per unit)

    • When adding a new rate, a blank or no entry for 'amount per unit' is

    treated as zero.

    • When updating, a blank or no entry for 'amount per unit' and percentage will retain the existing values.

MERCHANT||hhh|MODULE|qship|,|ADD_UPDATE_FLOOR,

Pegasus,1,2,1.00, 3,4,5.00, 5,+,10.00

DELETE_METHOD, method
 MERCHANT||hhh|MODULE|qship|,|DELETE_METHOD,Pegasus

DELETE_FLOOR, method, floor[,floor...]
 MERCHANT||hhh|MODULE|qship|,|DELETE_FLOOR, Pegasus, 1, 3

ptbship

(Price Table Based Shipping)

 

This data field contains actions and data.

ADD_UPDATE_METHOD, method, handling charge

ADD_UPDATE_CEILING, method, ceiling, charge, percentage[, ceiling, percentage...]

  1. methodShipping Method

  2. ceilingnumber, or
    + for an unlimited ceiling

  3. chargenumber for this ceiling

  4. percentageBoolean

When updating, a blank or no entry for 'rate' and 'percentage' will retain the existing values.

ADD_UPDATE_PRODUCT, method, product code, charge
[,product code, charge...]

  • Charge can be a positive or negative number.

DELETE_CEILING, method, ceiling[,ceiling...]

DELETE_METHOD, method

wtbship

(Weight Table Based Shipping)

 

This data field contains actions and data.

ADD_UPDATE_METHOD, method, handling

DELETE_METHOD, method

ADD_UPDATE_CEILING, method, ceiling, charge[, ceiling, charge...]

  1. methodShipping Method

  2. ceilingnumber, or + for an unlimited ceiling

  3. chargecharge (number) for this ceiling

When updating, a blank or no entry for 'charge' will retain the existing
values.

DELETE_CEILING, method, ceiling[,ceiling...]

ADD_UPDATE_PRODUCT, method, product code, charge[,product code, charge...]

ups

(4.10 – 4.13)

 

url, ratechart, handling, residential[, method...]

  1. url - http://www.ups.com/using/services/rave/qcost_dss.cgi

  2. ratechart:

    Customer Counter
    Letter Center
    On Call Air
    One Time Pickup
    Regular Daily Pickup

  3. handling - Handling charge

  4. residential - Boolean. Whether or not to use Residential Rates

  5. method -

    1DM (Next Day Air Early AM)
     1DA (Next Day Air)
     1DAPI (Next Day Air Intra in Puerto Rico
     1DP (Next Day Air Saver)
     2DM (2nd Day Air AM)
     2DA (2nd Day Air)
     3DS (3 Day Select)
     GND (Ground)
     STD (Canada Standard)
     XPR (Worldwide Express)
     XDM (Worldwide Express Plus)
     XPD (Worldwide Expedited)

NOTE: ratechart and method are case sensitive.

http://www.ups.com/using/services/rave/qcost_dss.cgi,
Customer Counter,5,Yes,1DM,1DA,2DA,GND

mvusps

U.S.P.S.

(in 4.14)

url, source_zip, handling, userid, password[,method1, method2,...]

  1. urlhttp://www.xxxx

  2. source_zip zip code

  3. handlingHandling charge

  4. useridUSPS user ID

  5. passwordUSPS user password

  6. method

    • EXPRESS(U.S.P.S. Express Mail®)

    • FIRST CLASS (U.S.P.S. First Class)

    • PRIORITY(U.S.P.S. Priority Mail® )

    • PARCEL(U.S.P.S. Parcel Post")

    • BPM(U.S.P.S. Bound Printed Matter)

    • LIBRARY(U.S.P.S. Library)

    • MEDIA(U.S.P.S. Media Mail")

    • iPRIORITY(U.S.P.S. Global Priority Mail)

    • iEXPRESSG(U.S.P.S. Global Express Guaranteed)

    • iEXPRESS(U.S.P.S. Global Express Mail)

    • iAIRMAIL(U.S.P.S. Global Airmail Parcel Post)

    • iECONOMY(U.S.P.S. Global Economy Parcel Post)

http://xxx, 92109, 3, name, pass, PRIORITY, FIRST
CLASS, iAIRMAIL

Tax Modules

Module Code

Data

canvat

(4.00 Canadian VAT)

This data field contains actions and data.
GST, gst rate, tax shipping

  1. gst rate is a number, blank keeps current value

  2. Tax shipping is Boolean, blank keeps current value

MERCHANT||hhh|MODULE|canvat|,|GST,7,N

- Example sets the GST to 7% with no tax on shipping

ADD_UPDATE_PST, province, pst rate, tax shipping[, province, pst rate, tax shipping...]

  1. province the code from the state table

  2. pst rate

  3. tax shipping - Boolean

MERCHANT||hhh|MODULE|canvat|,|add_update_pst, BC, 4.5,
N, ON, 7.5, Y

- Example sets the PST in British Columbia to 4.5 with no tax on shipping, Ontario to 7.5 with tax on shipping.

DELETE_PST, province[, province...]

  1. province the code from the state table

MERCHANT||hhh|MODULE|canvat|,|delete_pst,NW,PE

- Example removes Northwest Territories and Prince Edward Island from the list of provinces charging PST

ADD_UPDATE_PRODUCT, product code, GST exempt, PST exempt [,
product code, GST exempt, PST exempt...]

  1. GST exemptBoolean, blank keeps current value

  2. PST exemptBoolean, blank keep current value

MERCHANT||hhh|MODULE|canvat|,|add_update_product,
hammer1, Y, , hammer_st, , N, hammer_pb, N, Y

- Example:

  • makes hammer1 gst exempt, doesn't change pst exemption status

  • makes hammer_st pay PST, doesn't change GST exemption status

  • makes hammer_pb pat GST, and exempt for PST

DELETE_PRODUCT, product code[, product code]

MERCHANT||hhh|MODULE|canvat|,|delete_product, hammer1,
hammer_st

- Example removes the indicated product records, making the product
non-exempt.
Makes hammer1 and hammer_st non-exempt from GST and PST:
MERCHANT||hhh|MODULE|canvat|,|gst,4.5,N
MERCHANT||hhh|MODULE|canvat|,|add_update_pst,ON,4.5,N,AB,7.5,Y
MERCHANT||hhh|MODULE|canvat|,|delete_pst,ON

canvat

(4.1 Canadian VAT)

NOTE: Make sure you enter the
product version in the version field (the second data field), as shown in the examples.

This data field contains actions and data.

GST, gst rate, hst rate, tax shipping

  1. GST rateis a number, blank keeps current value

  2. HST rateis a number, blank keeps current value

  3. Tax shipping is Boolean, blank keeps current value

MERCHANT|4.11|hhh|MODULE|canvat|,|GST,7,15,N

- Example sets the GST to 7% and the HST rate to 15% with no tax on
shipping

ADD_UPDATE_PST, province, type, [pst rate, tax shipping, tax GST][,
province, type, [pst rate, tax shipping, tax GST...]]

  1. province the code from the state table

  2. typepst or hst. If blank pst is assumed

  3. pst ratenumber for rate, when type is pst

  4. tax shippingBoolean, when type is pst

MERCHANT|4.11|hhh|MODULE|canvat|,|add_update_pst, NS,
hst, ON, pst, 7, N, N, QC, pst, 7.5, Y, Y

- Example selects the following:

  • HST for Nova Scotia

  • PST at 7% for Ontario with no PST on shipping nor on GST

  • PST at 7.5% for Quebec with PST on shipping and GST.

DELETE_PST, province[, province...]

  1. province the code from the state table

MERCHANT|4.11|hhh|MODULE|canvat|,|delete_pst,NW,PE

- Example removes Northwest Territories and Prince Edward Island from the list of provinces charging PST

canvat

(4.1 Canadian VAT)

ADD_UPDATE_PRODUCT, product code, GST exempt, PST exempt [,
product code, GST exempt, PST exempt...]

  1. GST exemptBoolean, blank keeps current value

  2. PST exemptBoolean, blank keep current value

MERCHANT||hhh|MODULE|canvat|,|add_update_product,
hammer1, Y, , hammer_st, , N, hammer_pb, N, Y

- Example:

  • makes hammer1 gst exempt, doesn't change pst exemption status

  • makes hammer_st pay PST, doesn't change GST exemption status

  • makes hammer_pb pat GST, and exempt for PST

DELETE_PRODUCT, product code[, product code]

MERCHANT||hhh|MODULE|canvat|,|delete_product, hammer1,
hammer_st

- Example removes the indicated product records, making the product
non-exempt.
Makes hammer1 and hammer_st non-exempt from GST and PST:
MERCHANT||hhh|MODULE|canvat|,|gst,4.5,N
MERCHANT||hhh|MODULE|canvat|,|add_update_pst,CA,4.5,N,OR,7.5,Y
MERCHANT||hhh|MODULE|canvat|,|delete_pst,CA

certitax

serial, line item, validate addresses

  1. serialMerchant Serial Number from CertiTAX

  2. line itemBoolean: Whether or not to use 'Line Item Level Calculation'

  3. validate addressesBoolean: whether or not to use CertiTAX
    should check for valid addresses. (If not valid, order will not process.)

devat

(German VAT)

This data field contains actions and data.

OPTIONS, Price Includes VAT, Shipping is Taxed, Shipping Includes VAT

  1. All three fields are boolean.

MERCHANT||hhh|MODULE|devat|,|options,Y,Y,Y

ADD_COUNTRY, Country Code, [Country Code...]

  1. Adds the country codes to the list of countries charged VAT

MERCHANT||hhh|MODULE|devat|,|add_country,SW, FR

REMOVE_COUNTRY, Country Code, [Country Code...]

  1. Removes the country from countries list being charged VAT

MERCHANT||hhh|MODULE|devat|,|remove_country,GB,FR

PRODUCT_ASSIGN_RATE, Rate, Product Code[, Product Code...]

  1. Assigns the indicated rate to the listed products. Rate must exist.

MERCHANT||hhh|MODULE|devat|,|product_assign_rate,7.5,
hammer1,hammer_st,hammer_bp Assigns three hammers to the 7.5 tax
rate

PRODUCT_CLEAR_RATE, Product Code[, Product Code...]

  1. Removes the rate from the indicated products.

MERCHANT||hhh|MODULE|devat|,|product_clear_rate,
hexboltkit, nut_hx

ADD_UPDATE_RATE, Rate, Desc[, rate, desc...]

  1. Rate Required

  2. DescIf desc is omitted, it will be set to blank.

MERCHANT||hhh|MODULE|devat|,|add_update_rate, 7.5,
food and books, 8.5, , 11.5, coffee products

- Example assigns the description "food and books" to the existing tax rate of 7.5, creates a tax rate of 8.5 with no description, and a rate of 11.5 with a description of "coffee products"

DELETE_RATE, Rate[, rate]

  1. Deletes the indicated rates.

CAUTION: No check is made to ensure that the rate is not in use

statetax

item[,item...]

There can be an indefinite number of items. Each item passed is a
delimited list.

  1. state2 letter state code

  2. tax rateNumber

  3. shippingWhether or not shipping is taxed (Boolean)

If the tax is provided, the indicated state will be updated or added.
shipping is boolean

shoptax

(Shopper Selected Sales Tax)

This data field contains actions and data.

PROMPT, data

  1. data up to 254 characters long (blank leaves current
    value unchanged)

MERCHANT||hhh|MODULE|shoptax|,|PROMPT,Please Select
One,

ADD_UPDATE_RATE, option, rate, tax shipping

  1. optionup to 254 characters long

  2. rate number with 3 decimal places

  3. tax shipping Whether or not shipping is taxed (Boolean)

MERCHANT||test|MODULE|shoptax|,|ADD_UPDATE_RATE, Our
Limited Rate, 5.25, y

- Sample creates an Option named 'Our Limited Rate' with a rate of 5.25% and taxes shipping

NOTE:If the option provided already exists, that option will be updated. Otherwise, the option will be added as a new record. Blank leaves current values unchanged

DELETE_RATE, option

MERCHANT||hhh|MODULE|shoptax|,|DELETE_RATE,Our Limited
Rate

 - Removes 'Our Limited Rate' record from the database

vat

item[,item...]

product_code, tax

CAUTION: If the tax is blank, the current value will be deleted.

For example,
product_a:1.50,product_b:
Mean -Update product_a with tax of 1.5
-Delete product_b, since the tax is null

User Interface Provisioning

MMUI

The syntax for a line or record in provide.dat is:

product|version|store|type|code|delimiter|data

MMUI is a User Interface Module, so the type is MODULE, and the code for the module is mmui (it must be lowercase). Specifically, for MMUI, each line is:

MERCHANT| |Store|MODULE|mmui|,|data

The MMUI data fields contain both an action and data.

Module Code

Data

mmui

(in 4.13)

 

AFFILIATE_LOGIN, login text, edit text, show login

  1. login text - Initial Affiliate Login Link text

  2. edit text - Affiliate Account Link text

  3. show login - Boolean. Whether or not to display Affiliate Affiliate Login.

MERCHANT||ds|MODULE|mmui|,|AFFILIATE_LOGIN,affiliates
click here to log in, affiliates click here to edit
your account, yes

mmui

CATEGORY_ADD_UPDATE, category_code, page length, title, header,
footer, tree image, title image

  1. category_code

  2. page length - Number of products to display per page for this category

  3. title - Whether or not to display the Category Title (Boolean)

  4. header - Text, HTML, Java Script, etc. (Data the browser can read.)

  5. footer - Same as header

  6. tree image - graphics//00000001/cat1.gif (replaces the category name in the Category Tree)

  7. title image - graphics//00000001/cat1Title.gif (replaces the Category title on the Category page)

mmui

COLORS, Body Background, Body Text, Body Link, Body Active Link, Body Viewed Link, Category Tree Background, Header Foreground, List Header Foreground, List Header Background, List Alternate Background, Navigation Bar Background

  1. Body Background

  2. Body Text

  3. Body Link

  4. Body Active Link

  5. Body Viewed Link

  6. Category Tree Background

  7. Header Foreground

  8. List Header Foreground

  9. List Header Background

  10. List Alternate Background

  11. Navigation Bar Background

MERCHANT||ds|MODULE|mmui|,|COLOORS, #ffffff, #ffffff,
#ffffff, #ffffff, #111111, #000000, #000000, #ffffff,
#333333, #333333, #000000

mmui

CUSTOMER_ACCOUNTS, Display Links Above Categories, Customer Login Link, Customer Account Link, Customer Name Appearance, Extra, Display Login Before Order Form

  1. Display Links Above Categories - Boolean

  2. Customer Login Link

  3. Customer Account Link

  4. Customer Name Appearance - Values:
    first (First Name Only), firstlast (First Name, Last Name)
    None (no name displays)

  5. Extra - Punctuation after Name

  6. Display Login Before Order Form - Boolean

NOTE: If you want a space after Customer Login Link, Customer Account Link or the Extra field, add a &nbsp to the end of that entry in the provide.dat file. Any other space will be removed.

mmui

FONTS, Body Text Face, Body Text Size, Category Tree Text Face, Category Tree Text Size, Header Text Face, Header Text Size, List Header Text Face, List Header Text Size

  1. Body Text Face

  2. Body Text Size

  3. Category Tree Text Face

  4. Category Tree Text Size

  5. Header Text Face

  6. Header Text Size

  7. List Header Text Face

  8. List Header Text Size

MERCHANT||ds|MODULE|mmui|,|FONTS, arial, 2, verdana, 3,
comic sans, 4, courier, 5

mmui

HEADERS_AND_FOOTERS, Screen, Header Text, Footer Text[, Screen, Header Text, Footer Text...]

  1. Screen Values:

    • glob = Global

    • ctgy = Category Tree

    • logn = Customer Login

    • eact = Edit Customer Account

    • cact = Create Customer Account

    • attr = Missing Required Attribute(s)

    • srch = Search

    • plst = Product List

    • bask = Basket Contents

    • olgn = Order: Customer Login

    • oact = Order: Create Customer Account

    • oinf = Order: Customer Information

    • ousl = Order: Upsale

    • osel = Order: Select Shipping/Payment

    • opay = Order: Payment Information

    • uatr = Order: Upsale Missing Required Attribute(s)

    • invc = Invoice

  2. Header Text

  3. Footer Text

mmui

IMAGES, Body Background, Logo, Logo Link, Select Store, Store Front, Account, Search, Product List, Basket Contents, Checkout

  1. Body Background

  2. Logo

  3. Logo Link a URL

  4. Select Store

  5. Store Front

  6. Account

  7. Search

  8. Product List,

  9. Basket Contents

  10. Select

MERCHANT||ds|MODULE|mmui|,|
IMAGES,,graphics/en-US/mmui/hotdog/blades.gif,http://y
ahoo.com, graphics/en-US/mmui/hotdog/selstr.gif,
graphics/en-US/mmui/hotdog/storfrnt.gif,
graphics/en-US/mmui/hotdog/account.gif,
graphics/en-US/mmui/hotdog/search.gif,
graphics/en-US/mmui/hotdog/prodlist.gif,
graphics/en-US/mmui/hotdog/basket.gif,
graphics/en-US/mmui/hotdog/checkout.gif,

mmui

MESSAGES, welcome, thankyou

MERCHANT||ds|MODULE|mmui|,|MESSAGES,Welcome to our
store,Thank you for your order

mmui

PAGINATION, product list, search results

MERCHANT||ds|MODULE|mmui|,|PAGINATION,15,20

mmui

PAGE_SECTIONS, Category Tree, Navigation Bar

Both are Booleans, indicating whether or not to display the Page Section.

mmui

PRODUCT_ADD_UPDATE, product code, header, footer

mmui

PRODUCT_LAYOUT, screen, category, format, image, product name, product code, price, weight, description, add button, buy button, inventory level

  1. screenif listed, category must be blank. Values:
    RELP = Related Products Layout
    PROD = Product List Layout
    SRCH = Search Layout

  2. categoryif listed, screen must be blank

NOTE: Either category or screen must be listed

  1. formatValues:
    L = Line item
    X = Expanded

  2. imageValues
    N = None
    L = Large (Full-Sized)
    S = Small (Thumbnail)

  3. product nameWhether or not to display Item (Boolean).

  4. product codeWhether or not to display Item (Boolean).

  5. priceWhether or not to display Item (Boolean).

  6. weightWhether or not to display Item (Boolean).

  7. descriptionWhether or not to display Item (Boolean).

  8. add buttonWhether or not to display Item (Boolean).

  9. buy buttonWhether or not to display Item (Boolean).

  10. inventory levelValues:
    short
    long
    none

EXAMPLE:

MERCHANT||ds|MODULE|mmui|,|PRODUCT_LAYOUT,, red, l, N,
Yes, n, n, n, n, n, n, short

mmui

STORE_SELECTION_LAYOUT, stores per line, header, body_background color, body_background image, body_text color, body_link color, body_alink color, body_vlink color, body_font, body_font size, nav_bar background color, nav_bar logo image, nav_bar select store image

  1. stores per line

  2. headerText, HTML

  3. body_background color

  4. body_background image

  5. body_text color

  6. body_link color

  7. body_alink color

  8. body_vlink color

  9. body_font

  10. body_font size

  11. nav_bar background colorNavigation bar background color

  12. nav_bar logo imageNavigation bar logo

  13. nav_bar select store imageNavigation bar Select Store

mmui

UPDATE_BUTTON, % , code% mode %text %image [,code% mode %text %image...]

This data contains an action, sub-delimiter, and the data. Repeated sets of data are delimited by the major delimiter, defined in the basic file format in field 6. Syntax:

MERCHANT| |StoreCode|MODULE|mmui|delimiter|SUB-ACTION,
dataset delimiter, dataset, next dataset

Dataset:

  1. Code - Values:

    • Add1ToBasket

    • Add1ToBasketL

    • Add1ToOrder

    • AddToBasket

    • Buy1Now

    • Buy1NowL

    • Continue

    • DoNotAddToOrder

    • Login

    • Next

    • Previous

    • Remove

    • Save

    • Search

    • Update

    • EditAffiliate

  3. Mode - Values:

    • D (Default)

    • T (Text)

    • I (Image)

  5. Text

  6. Image

MERCHANT||StoreUSA|MODULE|mmui|;|
UPDATE_BUTTON;,;Add1ToBasket,T,Put 1 In Basket,,;
Add1ToBasketL,I,,graphics/00000001/add1Blue.gif,;
Add1ToOrder , D , , ,; AddToBasket ,t, Add to Basket
NOW , ,

KCUI

Action Code

Data

kcui

STORE_SELECTION_LAYOUT, intro, header, header_method,
footer, footer method

  1. intro - Text

  2. header - Text

  3. header_method - DO, GET, POST

  4. footer - Text

  5. footer method - DO, GET, POST

kcui

MESSAGES, intro, thankyou

  1. introIntroduction on Main Catalog Page

  2. thankyou"Thank You" on Invoice Page

kcui

COLORS, background, text, links, selected links, viewed links, bask_table, prod_table, invoice

  1. background

  2. text

  3. links

  4. selected links

  5. viewed links

  6. bask_table - Basket table background

  7. prod_table - Product table background

  8. invoice - Invoice background

MERCHANT||storeCAN|MODULE|kcui|;|COLORS; #FFFFC0;
#000000; #C00000; blue; #800000; #FFFFC0; #C0C000;
#FFFF80

kcui

CUSTOMER_ACCOUNTS, accnt

  1. accntWhether or not to use customer accounts (Boolean)

kcui

(in 4.13)

AFFILIATE_SETTINGS, show affiliate link

Boolean. Whether or not to show affiliate link

MERCHANT||ds|MODULE|kcui|,|AFFILIATE_SETTINGS,yes

kcui

HEADERS_AND_FOOTERS, Screen, Header, Header method, Footer, Footer method [,Screen, Header, Header method...]

  1. ScreenValues:

    storMain Page
    lognCustomer Login
    eactEdit Customer
    cactCreate Customer
    baskBasket Contents
    cselCategory Selection
    ctgyCatalog/Category Contents
    srchSearch/Search Results
    prodProduct Display
    attrProduct Attribute Selection
    oinfOrder Form
    upslProduct Upsale
    oselShipping and Payment Options
    opayPayment Information
    thnkInvoice
    lgafAffiliate Login     (4.1 only)
    adafCreate Affiliate Account     (4.1 only)
    edafEdit Affiliate Account     (4.1 only)

  2. HeaderFile

  3. Header MethodValues:
    DOMivaScript file
    GETHTML
    POSTHTML

  4. FooterFile

  5. Footer Method
    DOMivaScript file
    GETHTML
    POSTHTML

MERCHANT||ds|MODULE|kcui|,|HEADERS_AND_FOOTERS,
stor,storhead.mv,DO,storfoot.mv,DO, prod,
prodhead.htm, GET, prodfoot.htm,GET

Samples

Each action code or module code is one record, each on one line. Where code or data differs between Miva Merchant versions 4.0 and 4.1, the sample shows 4.1.

Store

//add or update store
MERCHANT|||ACTION|ADD_UPDATE_STORE_SETTINGS|;|elisa;storeUSA;testv-123456789; USA Store; Jeussi Bjorling; Jeussi@miva.com;MIVA;5060 Santa Fe Street; San Diego; CA; 92109; US; 858-490-2570; ; pounds; 60; highest; mmui; usmoney; statetax; 1001; N; ;Attention! %store_name% will be closing in %maint_countdown% minutes.; We are closed on %maint_date%. Please check back.;2;15;yes;Please buy 2 items totalling at least $15.

//tax
MERCHANT||storeUSA|MODULE|statetax|;|CA;7.5;N

MERCHANT||storeUSA|MODULE|statetax|;|NY;5.0;N

//add users
MERCHANT|||ACTION|DOMAIN_ADD_UPDATE_USER|;|Davey;Davey;Y;Y;;20;Y; Dot;Dot;Y;Y;;20;N

//add group
MERCHANT||StoreUSA|ACTION|STORE_ADD_UPDATE_GROUP|,| group2,AFLT:y:y:y:y,AGRP:y:y:y:y,ATMP:y:y:y:y,

CTGY:y:y:y:y,CURR:y:y:y:y,CUST:y:y:y:y,P MNT:y:y:n:n,SHIP:y:y:n:n,FUFL:y:y:y:y,INVT:y:y:y:y,LOGM:y:y:y:y,

MONY:y:y:y:y,ORDR:y:y: y:y,PGRP:y:y:y:y,PROD:y:y:y:y,STAT:y:y:y:y,STAX:y:y:y:y,STCT:y:y:y:y,STOR:y:y:y:y,

SYSM :y:y:y:y,SUTL:y:y:y:y,UPSL:y:y:y:y

//add users to group
MERCHANT||StoreUSA|ACTION|STORE_GROUP_ADD_USER|,|group2,Dot,Davey

//add categories
MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_CATEGORY|;|cat1;Category One;;Y MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_CATEGORY|;|cat2;Category Two;;Y MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_CATEGORY|;|cat3;Category Three;;Y

//add products
MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_PRODUCT|;|p1;Product One ;;;55; 44;Description for Product One;1;Y;Y

MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_PRODUCT|;|p2;Product Two; graphics/00000001/hammer.steel.th.gif;graphics/00000001/hammer.steel.gif;25;18; Description for Product Two;1;Y;Y

MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_PRODUCT|;|p3;Product Three; ;;75 ;58;Description for Product Three;1;Y;Y

MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_PRODUCT|;|p4;Product Four; ;;15; 11;Description for Product Four;1;Y;Y

//assign products to category
MERCHANT||storeUSA|ACTION|STORE_CATEGORY_ADD_PRODUCT|;|cat3;p1;p2;p3

//Add customers
MERCHANT||StoreUSA|ACTION|STORE_ADD_UPDATE_CUSTOMER|;|jamesb; JBjorling@miva.com; jamesb; james; bjorling; JBjorling@miva.com; Sound Stereo; 858-321-4321; ; 1 somewhere street; Toronto; Ontario; MC3109; CA; Y; ; ; ; ; ; ; ; ; ; ; MERCHANT||StoreUSA|ACTION|STORE_ADD_UPDATE_CUSTOMER|;|MaryP; maryParker@miva.com; MaryP; Mary; Parker; MaryP@miva.com; Mary's Little Lamb; 421-321-4321; ; 1 Linienstrasse; Bremen; ; 75231; DE; Y; ; ; ; ; ; ; ; ; ; ; MERCHANT||StoreUSA|ACTION|STORE_ADD_UPDATE_CUSTOMER|;|JohnE; JohnEastman@miva.com; JohnE; John; Eastman; JohnEastman@miva.com; Sound Stereo; 858-321-4321; ; 2 Sound Place; San Diego; CA; 92109; US; Y; ; ; ; ; ; ; ; ; ; ;

//availability group and products
MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_AVAILABILITYGROUP|;|

vendors MERCHANT||storeUSA|ACTION|STORE_AVAILABILITYGROUP_ADD_PRODUCT|;|vendors;p1;p2;p3;p4

//availability group and customers
MERCHANT||storeUSA|ACTION|STORE_AVAILABILITYGROUP_ADD_CUSTOMER|;| vendors;jamesb;JohnE;MaryP

//price group
MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_PRICEGROUP|;|
vendors;M;;10 MERCHANT||storeUSA|ACTION|STORE_PRICEGROUP_ADD_CUSTOMER|;|
vendors;jamesb;JohnE;MaryP MERCHANT||storeUSA|ACTION|STORE_PRICEGROUP_ADD_PRODUCT|;|vendors;p1;p2;p3;p4

//Affiliates (Last data field, commission_type (S below), is available in 4.1x) 
MERCHANT||storeUSA|ACTION|STORE_UPDATE_AFFILIATEOPTIONS|;|Y;A;.01;4;1.5;terms and conditions;10;graphics/00000001/books.gif;Link Text On Affiliate Site; S 
MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_AFFILIATE|;| AffilCode;mary;elise@miva.com;marylamb;marylamb;mary comley;elise@miva.com;;858-490-2570;;5060 Santa Fe Street;San Diego;California;92109;US;.02;5;7;A

//inventory settings
MERCHANT||storeUSA|ACTION|STORE_UPDATE_INVENTORYSETTINGS|;|Y;Item in Stock;%inv_instock% available NOW;Y;10;Back ordered Item;There may be a delay in shipment, '%product_name%' is on backorder.;Y;5;GONE!;GONE..Check back;Adjust quantity, please. Item is low.;;;;;;;

//product-specific inventory
MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_INVENTORYPRODUCTSETTINGS|;|p2; 50;Y ;;;Y;15 ;;;Y;6;N;;;;

MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_INVENTORYPRODUCTSETTINGS|;|p1; 20;Y ;;;;2; ;;;1;;;;;

MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_INVENTORYPRODUCTSETTINGS|;|p3; 20;Y; ;;;3;;;;2;;;;;

MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_INVENTORYPRODUCTSETTINGS|;|p4; 20;Y; ;;;4; ;;;3;;;;;

 

//add attribute template
MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_ATTRIBUTETEMPLATE|;|F01;Finish-Internal Prompt

MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_ATTRIBUTETEMPLATEATTRIBUTE|;| F01;Fin;radio;Select the Finish;;;Y

MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_ATTRIBUTETEMPLATEOPTION|;|F01;Fin;01;Mirror Polish;4;2.5;;T

MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_ATTRIBUTETEMPLATEOPTION|;|F01;Fin;02;High Polish;2.5;1.5;;T

MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_ATTRIBUTETEMPLATEATTRIBUTE|;| F01;Mono;text;Enter You Monogram, up to 3 letters;7.5;4.5;N;;

//product attribute
MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_ATTRIBUTE|;|p2;F01;template:F01;prompt;;;; 
MERCHANT||storeUSA|ACTION|STORE_ADD_UPDATE_ATTRIBUTE|;|p3;F01;template:F01;F01;

//payment configuration - Credit Card Payment with Simple Validation 
MERCHANT||ds|ACTION|STORE_INSTALL_MODULE|,|mod10

MERCHANT||ds|MODULE|mod10|;|Visa:4:13, 16;MasterCard:5:16

//shipping configuration - Flat Rate Shipping
MERCHANT||storeUSA|ACTION|STORE_INSTALL_MODULE|;|flatrate 
MERCHANT||storeUSA|MODULE|flatrate|;|ADD_UPDATE_METHODS; Domestic; 8.00;
International;12.00

//fulfillment
MERCHANT||storeUSA|MODULE|meremail|;|; N;Orders@StoreUSA.com; ; Order Placed; The Order contents:

MERCHANT||storeUSA|MODULE|custeml|;|Jeussi@miva.com; ALL@storeUSA.com; About Your StoreUSA Order; Thanks for Shopping with us!

//Notifications
MERCHANT|||ACTION|ADD_NOTE|;|Attention ALL; This is a note at the DOMAIN Level. 
MERCHANT||StoreUSA|ACTION|ADD_NOTE|;|Store Administrator; This is a note to the Store Administrator

Currency

//eurocur
MERCHANT||storeUSA|ACTION|STORE_INSTALL_MODULE|;|eurocur 
MERCHANT||storeUSA|MODULE|EUROCUR|;|E;Y;.;,;1;euro;S;[;];

// currency gencurr
MERCHANT||storeUSA|ACTION|STORE_INSTALL_MODULE|;|gencurr 
MERCHANT||storeUSA|MODULE|gencurr|;|£;C;I;-;4;,;3;£

Tax

//shopper selected sales tax
MERCHANT||storeUSA|ACTION|STORE_INSTALL_MODULE|;|shoptax 
MERCHANT||storeUSA|MODULE|shoptax|;|prompt;Select Your County; 
MERCHANT||storeUSA|MODULE|shoptax|;|

add_update_rate;Ontario;7.5;N;add_update_rate;Monroe;7.25;N

 

//state based sales tax
MERCHANT||storeUSA|MODULE|statetax|;|CA;7.5;N

MERCHANT||storeUSA|MODULE|statetax|;|NY;5.0;N

//Canadian VAT (4.1 example)

//MERCHANT|4.11|storeCAN|ACTION|STORE_INSTALL_MODULE|;|canvat 
MERCHANT|4.11|hhh|MODULE|canvat|,|GST,7,15,N

MERCHANT|4.11|hhh|MODULE|canvat|,|add_update_pst, NS, hst, ON, pst, 7, N, N, QC, pst, 7.5, Y, Y

MERCHANT|4.11|hhh|MODULE|canvat|,|add_update_product, prd1, Y, ,prd2, , N, prd3, N, Y

//Generic VAT
MERCHANT||storeUSA|ACTION|STORE_INSTALL_MODULE|;|vat 
MERCHANT||storeUSA|MODULE|vat|;|p1;7.5; p3;15

//German VAT
MERCHANT||storeGER|MODULE|devat|;|options;N;N;N

MERCHANT||storeGER|MODULE|devat|;|product_assign_rate;7;P2;P3

Payment

//Authorize.Net Payment Services v3.0
MERCHANT||storeUSA|ACTION|STORE_INSTALL_MODULE|;|authnet 
MERCHANT||storeUSA|MODULE|authnet|;|login id; password; https://authorize.net; N; Y; N; Discover; Visa

//CyberSource ICSv2 Payment Services
//credit card names UPPER case

MERCHANT||storeUSA|ACTION|STORE_INSTALL_MODULE|;|ics2 
MERCHANT||storeUSA|MODULE|ics2|;|merchant id; http://url.com; USD; Y; AMEX; MASTERCARD

//Cardservice/LinkPoint Payment Gateway
MERCHANT||storeUSA|ACTION|STORE_INSTALL_MODULE|;|linkpt 
MERCHANT||storeUSA|MODULE|linkpt|;|ABCDEF; secureURL.linkpt.net; 8000; digital cert; N; N; Y; ax;vs

//Verisign Payflow Link
MERCHANT||storeUSA|ACTION|STORE_INSTALL_MODULE|;|paylink 
MERCHANT||storeUSA|MODULE|paylink|;|miva; password; http://www.miva.com; y; VISA; MASTERCARD

//Verisign Payflow Pro (PaymentNet)

MERCHANT||storeUSA|ACTION|STORE_INSTALL_MODULE|,|paynet MERCHANT||storeUSA|MODULE|paynet|;|miva; password; http://www.miva.com; 8080; http://www.proxy.com; 8800; bon; password; N; VISA; Y; MASTERCARD; Y

Shipping

// Base + Weight Shipping
MERCHANT||storeUSA|ACTION|STORE_INSTALL_MODULE|;|baseunit 
MERCHANT||storeUSA|MODULE|baseunit|;|ADD_UPDATE_METHODS; BaseWeight1; 5; 2

// Flat Rate Shipping
MERCHANT||storeUSA|ACTION|STORE_INSTALL_MODULE|;|flatrate 
MERCHANT||storeUSA|MODULE|flatrate|;|ADD_UPDATE_METHODS; FlatRate1; 10; FlatRate2; 12

// Minimum or Weight Shipping
MERCHANT||storeUSA|ACTION|STORE_INSTALL_MODULE|;|minunit 
MERCHANT||storeUSA|MODULE|minunit|;|ADD_UPDATE_METHODS; Minimum or By Weight; 5; 2

// Quantity Based Shipping
MERCHANT||storeUSA|ACTION|STORE_INSTALL_MODULE|;|qship 
MERCHANT||storeUSA|MODULE|qship|;|ADD_UPDATE_METHOD; QuantityDiscounts;Y 
MERCHANT||storeUSA|MODULE|qship|;|ADD_UPDATE_FLOOR;QuantityDiscounts; 1;2;4; 3;6;2.25; 7;+;1

// Price Table Based Shipping
MERCHANT||storeUSA|ACTION|STORE_INSTALL_MODULE|;|ptbship 
MERCHANT||storeUSA|MODULE|ptbship|;|ADD_UPDATE_METHOD; PriceTable2;4.25 
MERCHANT||storeUSA|MODULE|ptbship|;|ADD_UPDATE_CEILING; PriceTable2;25;10;Y; 100;8;Y; +;5;Y

MERCHANT||storeUSA|MODULE|ptbship|;|ADD_UPDATE_PRODUCT; PriceTable2;p1;-2;p2;2.30

//Weight Table Based Shipping
MERCHANT||storeUSA|ACTION|STORE_INSTALL_MODULE|;|wtbship 
MERCHANT||storeUSA|MODULE|wtbship|;|ADD_UPDATE_METHOD; WeightTable;5.21 
MERCHANT||storeUSA|MODULE|wtbship|;|ADD_UPDATE_CEILING;WeightTable;.5;1;2;3;+;6 
MERCHANT||storeUSA|MODULE|wtbship|;|ADD_UPDATE_PRODUCT;WeightTable;p3;3.23;p4;-1