gift certificate manager - viking coders

http://www.vikingcoders.com

Gift Certificate Manager This module lets you offer and accept gift certificates in your Miva Merchant store. It has several configurations for purchasing and redeeming options, as well as the ability to offer printable certificates. Add-on modules let you import gift card keys from pre-existing programs and batch generate keys. The Concept... This module provides an interface for you to create, sell and distribute gift certificates, which can be redeemed during the checkout process. Certificates can be auto generated, and auto or manually fulfilled. To work with other gift card programs, pre-existing keys can be imported, allowing customers to redeem gift cards generated by another program. This feature requires the Gift Certificate Manager Import module. Gift Certificates act like payments on an order. They can carry a leftover balance if an order does not utilize the entire value of the certificate. Should a gift certificate not fully cover the cost of an order, the shopper can pay the remaining balance using any payment methods you already accept. The Gift Certificate Manager Batch Generate module lets you create keys in bulk to use for other programs. Note about compatibility with other modules: This module plugs into Miva Merchant’s OSEL screen by default. If you are using a module (like a template module) that overwrites this screen, you’ll need to use a token to place the coupon prompt for customer usage.

Other Page Templates users—click here for info on integrating Gift Certificate Module. OpenDesigner users—this module will only work with v1.x objects with hook points enabled.

Note about how the module works: When a gift certificate key is entered during checkout, the amount is deducted from the order total. If the balance of the certificate covers the entire order, the customer will be able to checkout without making any additional payment (unless you require shipping and tax to be paid separately). If the total amount is not covered, the shopper will be required to pay the balance. This module uses tokens. A primer on tokens can be found here. Installing the Module... This module is installed as an Order Fulfillment module. Click here for installation steps. Accessing the Module... After installing the module, click on the Order Fulfillment link in your Miva Merchant Admin, and click on the Gift Certificate Manager link in the right-hand screen. This is where you will make all configurations for the module.

http://www.vikingcoders.com/go.mv?ID=BROK_CERTS_IMPORT

http://www.vikingcoders.com/go.mv?ID=BROK_CERTBATCH

http://www.vikingcoders.com/helpdesk/faq.php?parent=168&cmd=view&id=264

http://www.vikingcoders.com/docs/listings.html

GCopyright 2004. All Rights Reserved.
ift Certificate Manager – Last Update 09/05/06

Setting Options... When you first access the module’s admin, you will be presented with the Listing screen, which displays all Gift Certificates that have been created.

Click the Opoptions for t

To set the options for the module, click the Options link in the module’s admin

Enable module: Checked means the module will run. If you need to temporarily disable usage, Path to module file (optional): This is the direct path to the module’s file. Information is only required if you nsuch as a 404 error when trying to view a certificate.

Some sites might have a varying “path to Miva Merchant” set in the mthat’s vastly different than the standard, such as a point to stub file in the merchant.mvc file). If the path can’t be resolved by this module proTo fix the problem, this input field can collect the absolute path to the root). If you need to enter anything here, you may need to contact youdetermining the absolute path. If you aren’t experiencing any problems you needn’t enter anything he

Generate keys automatically for these payment methods: All of the payment methods your store uses will be listed (the OpenUI is listedthat deal with payment issues). If you want keys immediately generated for orders that are paid for via credit cpurchased via PayPal, you can check off the credit card module and leave the

NOTE: If you check off any payment method, the module will generatedo so, email it to the proper party immediately upon order finalization.

Gift Certificate Copyright 2004. All Rights Reserved.

tions link to set general he module.

.

you can uncheck this box.

eed to correct a problem,

all’s domain settings (one the script root that redirects to perly, an error will appear.

module’s file (from the server r host for assistance in

re.

because it contains functions

ard, but not for those PayPal box unchecked.

the key and, if configured to

Manager – Last Update 09/05/06

Emails will be sent as soon as the order is placed.

Add key to product name? If checked, the gift certificate key will be displayed along with the product name in the order and on emails. Automatically send purchaser email? Checking off the “automatically

send” options will overrides any selections you may allow the certificate purchaser to make. If you want to give purchaser’s the option of having an email automatically sent to the recipient, leave the “Automatically send to recipient email” box unchecked.

If checked, the module will automatically send an email with the certificate key to the purchaser (the email address listed under the order’s Bill To info). Automatically send to shipping email? If checked, the module will automatically send an email with the certificate key to the shipping recipient (the email address listed under the order’s Ship To info). Automatically send to recipient email? If checked, the module will automatically send an email with the certificate key to the recipient (if the module is configured to accept the recipient’s email address). File name for attachments? This is the filename given to the certificate that will be emailed to the customer or recipient. Mailhost: This is the mailhost the site uses on the server. Usually this will be the same mailhost that is set under your store’s Domain Settings. From Address: This is the email address the certificate email will be sent from. The default entry is the email address used on the registration of Miva Merchant. CC: You can opt to have a copy of the certificate email carbon copied to another email address (such as yourself).

Gift Certificate Manager – Last Update 09/05/06 Copyright 2004. All Rights Reserved.

Redemption button setup: You can customize how the input field for the certificate and redemption button is displayed to the shopper. Feel free to use HTML, such as using a table to box it in. Redemption button image: Use the upload button to upload a custom graphic. If left blank, a standard form submit button will be used. Redemption button alt: If you upload a graphic, the text in this box will appear when the mouse is placed over the button. Otherwise, it will be the word(s) that appear in the submit button. Text box size: This controls the width of the certificate key input field. Allow multiple certs? If checked, shoppers will be able to use multiple gift certificates when placing a single order. Bypass payment/shipping for $0.00? If checked, the payment/shipping selection and payment information section will be bypassed if the balance on the redeemed certificate is enough to cover the entire order. In this case, shipping will NOT be charged and tax will NOT be added to the order.

If you wish to charge tax for the order DO NOT use this option. The calculation and display of tax occurs after the gift certificate is redeemed.

Show redeemed certificate as item on basket page? If checked, the certificate will display as an item in the shopping basket.


Calculate tax on “post redemption” subtotal? If checked, any sales tax will be configured based on the amount the customer is actually paying (the order subtotal minus the amount of the gift certificate). If unchecked, the module will tax the entire subtotal as it was prior to the redemption of the gift certificate.

This option is provided so users can adhere to state laws – some require tax is paid on the customer’s actual “pay” amount, and some require that the entire order subtotal is taxable. In most cases, a gift certificate is treated like a payment option rather than a discount, thus this option is normally not used. It is recommended you check with your local laws to determine the proper option to use.

Message for payment info screen: This is the text that will be displayed to the shopper when the amount of the gift certificate covers the order.

gift certificate if you’ve opted to have it display as an item in the basket. It will ppear in this format:

Gift Certificate: CERTIFICATEKEY

Label for certificate in basket: This is the label for the a


Fields to add to redemption form: For advanced users, this input field allows you to add additional input fields to the form the shopper uses to redeem the certificate. Redemption Error Messages: You can customize the various error messages that may display. These deal with invalid keys, limited redemptions, zero balances, expired keys and restricted products.

Default Options Here you can set default options that will apply to all gift certificate templates.

NOTE: Once you create a key for a gift certificate, any changes you want made will need to be made on the certificates actual template.

Default applicable products: If you want to restrict redemption of certificates to be used with or without specific products, enter the product codes here and select either permit use or do NOT permit use.

To add more than one product, delimit the codes with the | character (that’s the key above the enter key on the standard keyboard – and it’s called a PIPE).

NOTE: Due to the constraints of the module with MIVA Merchant, if you require specific products under the PERMIT or DO NOT PERMIT section, any mixture of products (products not listed) ordered will throw an error and will disallow the usage of the certificate.


Default email to purchaser… The settings under this section will only have an affect if you’ve either opted to automatically send an email to the purchaser or if you manually email the purchaser.

HTML format? If you want the email that is sent to the purchaser to be in HTML format, check this option. Send cert as attachment? If you want to send the gift certificate as an html file attachment, check this option. The file will be named what you set as the file name previously (in our example, it is named certificate.html). Default subject: You can modify the subject of the email that will be sent to the purchaser. Default message: This is the default email message. You can use HTML only if you’ve checked off the HTML format option.

Default email to recipient… The settings under this section will only have an affect if you’ve either opted to automatically send an email to the recipient or if you manually email the recipient.

HTML format? If you want the email that is sent to the recipient to be in HTML format, check this option. Send cert as attachment? If you want to send the gift certificate as an html file attachment, check this option. The file will be named what you set as the file name previously (in our example, it is named certificate.html). Default subject: You can modify the subject of the email that will be sent to the purchaser. Default message: This is the default email message. You can use HTML only if you’ve checked off the HTML format option.


Certificate Defaults The settings under this section will be applied to all certificates unless you’ve set specific options for an individual certificate. Options for individual certificates will override any settings here.

Default Certificate template: This is the template for the display of the certificate, which the shopper can print. You can use HTML and

kens to display specific information.

his is the number of days for which the certificate is valid.

ed with the generated key, and the token %certcode% will be replaced y the certificate template code.

the certificate code you created is GIFT100, then a

ey would look like: MM-67Y3gT-GIFT100

ver, using the store code and the cert code tokens rovide a more unique key for your store.

T is the certificate key. You can opt for keys to use just numbers, just letters, r both numbers and letters.

his is the number of characters each key will have (in our example it is 6 characters).

to Default Length: T Default Key template: This is the template that will be used to generate the certificate key. The token %storecode% will be replaced by your store’s store code, the token |key| (note that this token is not of the usual format, having pipes | instead of %) will be replacb

For example, if your store’s code is MM andk You could opt to just display the key. Howep

Default Key characters: In the example above, 67Y3go Default Number of characters: T


Certificate Page This area allows you to customize the Gift Certificate page purchasers or recipients can view. They can also print the certificate here.

Close button image: This is the close button that’s displayed on the popup page so the user can close the window. You can upload a custom graphic here. Otherwise, a standard text link will be displayed. Close button alt: This is the ALT tag for the graphical button, or the text that will appear if a text link is used. Print button image: This is the close button that’s displayed on the popup page so the user can close the window. You can upload a custom graphic here. Otherwise, a standard text link will be displayed. Print button alt: This is the ALT tag for the graphical button, or the text that will appear if a text link is used. Main page template: This is the template for the actual page. You can use HTML and tokens to customize the display.


How Do I Create Gift Certificates? Before delving in, let’s discuss how gift certificates work in respect to how your customer’s will purchase them and how they will be fulfilled. First, how do you want the shopper to purchase a certificate? By choosing the certificate amount first? By selecting an amount when completing the form? Or by letting the shopper purchase any dollar amount he/she chooses. Selling gift certificates online requires that you have some way for the customer to purchase one, and the simply method is creating a product for purchase. There are, however, a few different ways to do this.

Let them choose the amount first: With this option, you would create separate products in your store (in our case, four separate products, all listed on a category page). Each would be for a specific dollar amount. Each individual product page to collect recipient information and oth Put it all on one page: With this option, you would cattributes to designate the avchoose just one amount. Thefields. In our example here, we useoptions, because keys will bemanually upon further determ

Let the customer set the amount: This option would allow the shopper to enter the desired dollar amopre-defined gift certificate amount.

Details on how this would work is discussed in the section,Keys.

Let the customer purchase offline: With this option, you would sell gift certificates via the phone or in aonly way you want to sell gift certificates, there is no need to setupstore. You can create manual keys without a certificate having evercertificates don’t have to be associated with a purchase in the store

GiftCopyright 2004. All Rights Reserved.

could contain attributeser data.

reate a single product, and use ailable amounts. The shopper may n, he/she would complete any other

d radio button attributes for the send generated and sent to recipients ining the validity of the order.

unt, without being forced to select a

Creating Customer Defined Amount

brick and mortar store. If this is the a product for gift certificates in the been ordered. In other words, gift .

Certificate Manager – Last Update 09/05/06

Manually Creating Certificates You can create gift certificates right via the module’s admin. From the main screen (which you can reach from other screens by clicking the Certificates link), click the New Certificate link. When you create a certificate, you’re creating a template for that type of certificate (normally a certificate worth a specific dollar amount). Then, after created, keys can be generated. You would usually only create manual gift certificates if you are creating special ones for customers over the phone or in a brick and mortar store. Manual certificates wouldn’t be auto purchased in the store.

The code should be simple, and usually identifies the type of certificate.

Certificate code: This is the unique identifier of the certificate ng codes of “ten” or “twenty”; or “10” or “20”; o t will be appended to the Key template if you use Value: This is the value of the gift certificate. Sincecertificate type will have a default value of ton a per-key basis). Do not use the $ here, Apply to tax? If checked, the gift certificate can also be u Apply to Shipping? If checked, the gift certificate can also be u

Copyright 2004. All Rights Reserved.

template. Most users signify the dollar amount here, by usir in our example, GIFT10 and GIFT100. This is the code tha the %certcode% token in the template.

you are creating a template, each key you generate for this he amount entered here (you can later change that, however, just the number.

sed to pay for the tax on the order.

sed to pay for the shipping.

Gift Certificate Manager – Last Update 09/05/06

ALERT! Many of the certificate settings are copied to the gift certificate key's database records and are not changed if the certificate settings are subsequently changed. When making changes to the certificate template itself (such as assignment of restricted products), the changes will only ffect gift certificate keys reated after the specific hanges are made.

Length (days): Enter the number of days for which the certificate is valid. Key template: The format you applied in the default options will appear here. Any changes will only take affect on this certificate type. Key characters: This is the character formatting you set in the default options. Any changes will only take affect on this certificate type. Number of characters: This is the number you entered in the default options. Any changes will only take affect on this certificate type. Associated product: This is the product the customer wbecome a gift certificate. This is nomanual gift certificate, and is discu Applicable products: These are the products you set to eAny changes will only take affect o You can also customize the Email you make no changes, the defaults

Creating Automatic You can setup your store so specifneed to create a product and a giftautomatic association as being a g The first step is to create a new proin your store. It’s probably best to git a logical product code, and for thname you’ll want to make it clear this a gift certificate. For the Price, you have two option

1. You can create several giftcertificate products and giveach their own product pric

2. You can create one item a

use attributes to distinguishbetween the prices.

The Gift Certificate Manager will thallow you to associate either the pr If you merely want to setup individuyou want to allow the customer to sbe used in conjunction with the cer


acc

ould purchase in order for it to t necessary when creating a ssed in the next section.

ither be permitted or not permitted to be paid for with a gift certificate. n this certificate type.

to Purchaser, Email to Recipient, and the Certificate Template. If will be used.

Gift Certificates ic products are set as actual gift certificates. This is useful since you only certificate template, and allow shoppers to purchase the item with ift certificate item.

duct ive e at it

We left the price at zero because we’ll use attributes to set the dollar amounts. This gives us one product and the customer can select the value from a list.

s:

e e. Is it taxable? Normally the tax is paid on the order of

actual items, so the gift certificate purchase itself would not be taxable. However, check with your local laws. nd

en oduct code or the attribute code to a specific certificate.

al products with no additional options, you are set for this part. But if elect a value from one screen, or collect additional information that can tificate, read on.


Using Attributes for Values A key part of this module is the ability to really streamline the automation of gift certificates. The first is the purchasing of the certificate and selection of value. It’s much easier for a customer to just select the dollar amount from a list than to have to click on a specific dollar amount product (if you have 10 dollar amounts, you’d need to create 10 products).

We have seven attributes for the dollar amount, so we will create 7 certificate templates and assign each to one of the attributes.

Note: Do not use MIVA Merchant’s Attribute Templates to create your product’s attributes. The amounts will not work. Instead, build your attributes right under the product itself.

Using Attributes to Collect Other Info You can also collect other information, such as the recipient’s name and email, and options the customer has on the delivery method. The module will work with the following product attributes. If you want to use any of them, you must create the attribute code and type exactly as shown. Also, you cannot use Attribute Templates for this functionality – the attributes must be directly applied to the product. You use anything you want for the attribute prompts. Attribute Code Attribute Type What it collects for

Text field

The name of the recipient.

foremail

Text field

The email address of the recipient

sendrecip

Checkbox

When checked, the module will send an email to the recipient with the gift certificate key. This is done automatically when the order is placed.

sendship

Checkbox

When checked, the module will send an email to the email address in the order’s Ship To section with the gift certificate key. This is done automatically when the order is placed.

deliveron

Text field

Only collects the date – useful if the customer wants the gift certificate mailed to the recipient. This option WILL NOT intercept the automatic email send, which means you cannot use it to have the auto email sent on a specific date.


note

Text field OR text area

Collects special notes from the purchaser. This can be a special message to the recipient, or can be directions to you.

address1


Collects the address for the recipient for you to mail the certificate. Normally this would be the street address.

address2


Collects the address for the recipient for you to mail the certificate. Normally this would be the city, state and zip code.

Note that the sendrecip and sendship att e module to determine whether or not the certificate should be s is will only be done if the payment method used is approved for au If you want the purchaser to decide whetsure the “Automatically send…” options

Associating Products with a CerOnce you’ve created your products (and attrif desired) you can associate them with speccertificate templates. When you go to create a new certificate, youuse the Associated product field to designatcorrect product (or product attribute). To designate only a product, enter the producode, or use the search tool to find it. Then, time that product is purchased, it will be designated as a certificate for this template, allowing you to create a key (or, if selected, auto generate the key).


ribute codes will be used by thent automatically. However, thtomatic delivery.

her or not the email should be sent automatically, make in the module’s setup are unchecked.

tificate ibutes, ific

can e the

ct each

it will


Associating Attributes with a Certificate To designate a specific attribute as a gift certificate, you’ll need to first set the Associated product (as done above). Then, you’ll need to edit the gift certificate to assign the specific attribute. To edit the gift certificate template, click on the Listing link, then click the link for the certificate template. To associate the certificate with a attribute, click the Product link. Select the attribute and click Update.

This gift certificate template will be used when the shopper selects the value of $100 from the product page.

Any other attributes you’ve setup for the product from the ones used by the module will have an automatic effect, which means you won’t need to make any selection for it.

Working with Certificate Keys Gift certificates are what you sell. What you provide to the purchaser or recipient is a key – a unique code that acts as payment for items. A key cannot be generated unless a certificate template has been setup.

Generating Certificate Keys You can manually generate a valid key for any of your certificate templates.

1. In the certificate listing, click the certificate for which you want to generate a key. 2. Click the Generate Key link.

You will now see a new key on the screen, and can verify it’s creation also by clicking in the Keys link. If you want to create another key, you can repeat steps 1 and 2, or simply click the Update button.


Editing Certificate Keys You can alter the current value of any gift certificate key. You might do this if the customer has returned an item, or if you need to decrement an amount due to a phone purchase. You can also alter the expiration date and other options for a specific key.

1. In the certificate listing, click the certificate type that contains the actual key you want to edit.

2. Click the certificate key from

the listing.

3. Make any changes and click Update.

Use this method to also manually send an email with the key to the recipient, billing email or shipping email. This is useful if a certificate was purchased via a payment method not approved for automatic fulfillment of the key. You can also check off that a gift certificate was mailed to the recipient.


Creating Customer Defined Amount Keys Though not a direct feature of the module, it is possible to allow customers to set their own dollar amount, and manually generate keys for usage. A basic option would be to create a product in the store with a price of $1, and instruct the customer to enter the appropriate quantity to the basket that reflects the gift certificate value he/she wants to purchase. A more ideal way is to use a module to create a non-catalog item, such as the Other Page Templates module, which lets you create a Specials screen so customers can enter their own dollar amount and pay for it like any other product in the store. After the purchase is made, you can then create the gift certificate and generate a key. Or, you can simply create a general gift certificate template for a $1 value, and alter the value of each key that you generate.

Configuring Shipping for Gift Certificates The Gift Certificate Manager is not capable of changing how shipping is calculated in the store. Shipping is calculated based on the shipping module(s) you are using. With that, if you want no shipping costs to be applied to the purchase of a gift certificate, you will need to adjust the way shipping is being calculated. Some third-party modules (like Shipping by Subtotal) will allow you to configure some products to have free shipping. Some users opt to use a weight-based shipping module and assign the gift certificate products a weight of zero. You can use Miva Merchant's standard Weight Table Based Shipping module to offer a "free" shipping option only if the customer purchases a gift certificate. To do this, you would set a single range to have a ceiling weight of .01 (or some other weight more than the gift certificate and less than your lightest product) and a 0.00 charge. Do not set any other ranges. With this method, if someone purchases only a gift certificate the total weight will be 0.00 and will fall below the ceiling for the range you created. If other items are also purchased, the range will be exceeded and since there are no other ranges created, no shipping will be calculated by the module.


http://www.vikingcoders.com/go.mv?ID=BROK_PAGETEMPLATES

http://www.vikingcoders.com/go.mv?ID=BROK_SUBSHIP

Troubleshooting Sales Tax Issues Configuring the sales tax for Gift Certificates can be a bit tricky. Normally, you wouldn’t tax the actual purchase of the gift certificate, because tax would likely be paid twice (the gift certificate purchaser would pay tax, as would the person redeeming the certificate in the store). When configuring how the gift certificate will work with tax on an order redeeming the certificate, you need to consider how different settings will affect the sales tax calculated. First, if you want the certificate to be allowed to cover tax and shipping (i.e. the balance of the certificate is used to pay this rather than forcing the shopper to pay this portion with a credit card), then you need to check off Apply to Tax and Apply to Shipping on the certificate’s configuration screen. But there’s the option to “calculate tax on post redemption”, which, if checked, will apply the tax to the order as usual (opposed to taxing only the “left over” amount the gift certificate balance may not cover). Leaving this unchecked means the customer may actually be responsible for no tax if the balance covers everything.

Example: Order total of taxable products is $100. Gift certificate is $100. If “calculate tax on post redemption” is unchecked, the customer will be charged no sales tax (which is likely NOT what you want to do). Left checked, the customer will be charged sales tax on the $100 worth of products (so if the tax rate is 6%, the customer order total is $106, leaving a remaining “to pay” amount of $6.

But there’s a hitch. Leaving the “calculate tax on post redemption” will allow the tax module you are running to calculate tax on the redeemed certificate amount, which would result in a negative amount. Thus, unless you have special reasons for doing so, you should make sure that “calculate tax on post redemption” is checked.


Printing Gift Certificates You can print individual gift certificates (for each key) from within the module’s admin. On each gift certificate key’s page, click the view certificate link.

Version 5 ONLY: In MIVA Merchant 5, the certificate will display on a new tab (rather than in a pop-up window). With this, some version 5 specific tokens were added to allow for printing. The %begin_print% and %end_print% conditionals will set to print everything inside these two tokens. Anything outside the tokens will not print via the browser. The %print% token will display the print button.

Displaying Certificate Info to Customers and Recipients You can use tokens to display certain information to purchasers and/or recipients.

Displaying the Balance To display the balance to the certificate user during checkout, use the %balance% token in the Redemption button setup field (under the module’s options in the admin). This will display the remaining balance. If you only want the balance to show if the certificate has already been redeemed, you can use a conditional statement with the tokens %begin_ifredeemed% and %end_ifredeemed%. The following would display the balance only if the certificate amount has been applied to the order:

%begin_ifredeemed% Your balance for certificate %key% is now %balance%<br>

%end_ifredeemed%

Displaying the Certificate • There are several ways you can display the actual gift certificate to the purchaser and/or

recipient:

• In the Email message, use the %certificate% token This will display the data in the Certificate template.

• Configure the module to attach the certificate as an HTML file attachment.

• Provide a link to the certificate in the email. The %certlink% token will display the actual link. If

using HTML you could format it as:

<a href=”%certlink%”>Click here to view your certificate</a>


Customizing the Certificate Page Chances are you will want to customize the look of the gift certificate page (that the purchaser and/or recipient sees) to your store. Here’s some tips and info. The format of the page is determined by the content of the Certificate template. By default, the page is displayed within a frame. This allows you to include content in a top frame, while displaying only the certificate in the bottom frame, and thus, allowing the print function to only print the actual certificate. The frames are separated by the %begin_frame|name|% and %end_frame% tokens. For example:

<FRAMESET ROWS="50,*"> %begin_frame|top_frame|%

<html> <body>

You are viewing certificate <i>%key%</i> Balance: <i>%balance%</i> Expires on: <i>%expire%</i>

%print|bottom_frame|% </body> </html>

%end_frame%

%begin_frame|bottom_frame|% <html> <body>

%certificate% </body> </html>

%end_frame% </FRAMESET>

This code will display a page with two frames. The top frame will be 50 pixels wide and will display:

You are viewing certificate CERTIFICATEKEY Balance: $xx.xx

Expires on: DD/MM/YYYY print

The bottom frame will be the actual certificate. The “print” link in the top frame will print the bottom frame. Canning the frames: You can rid the use of frames. However, if you want to include the print link (which is a good idea) the actual word “print” and the page’s header, will display on the printed page.

<html> <body>

You are viewing certificate <i>%key%</i> Balance: <i>%balance%</i> Expires on: <i>%expire%</i>

%print%<br><br> %certificate%

</body> </html>


Using Tokens for Gift Certificate Manager Gift Certificate Manager has it’s own set of tokens for displaying various content to the customer or recipient. Here’s a list of available tokens, and how they can be used.

Tokens Available in the Certificate Template Token

What it Displays/Does

%expire%

The individual gift certificate key’s expiration date.

%expire2%

The key’s expiration date in the format of DD Month YYYY.

%key%

The gift certificate key.

%balance%

The balance of the gift certificate.

%start%

The start date of the certificate (when it became valid).

%start2%

The start date in the format of DD Month YYYY.

%randomxx%

A random string of numbers. The xx denotes the number of characters long.

%orderid%

The Miva Merchant order number.

%todaysdate%

Today’s date.

%todaysdate2%

Today’s date in the format of DD Month YYYY.

%time%

The time the email is sent.


Customer Information Tokens The following tokens are used to display information about the customer who purchased the certificate (and is sent via email).

%ship_fname% The first name in the Ship-To.

%ship_lname% The last name in the Ship-To.

%ship_email% The email address in the Ship-To.

%ship_comp% The company name in the Ship-To.

%ship_phone% The phone number in the Ship-To.

%ship_fax% The fax number in the Ship-To.

%ship_addr% The address in the Ship-To.

%ship_city% The city in the Ship-To.

%ship_state% The state in the Ship-To.

%ship_zip% The zip code in the Ship-To.

%ship_cntry% The country in the Ship-To.

%bill_fname% The first name in the Bill-To.

%bill_lname% The last name in the Bill-To.

%bill_email% The email address in the Bill-To.

%bill_comp% The company name in the Bill-To.

%bill_phone% The phone number in the Bill-To.

%bill_fax% The fax number in the Bill-To.

%bill_addr% The address in the Bill-To.

%bill_city% The city in the Bill-To.

%bill_state% The state in the Bill-To.

%bill_zip% The zip code in the Bill-To.

%bill_cntry% The country in the Bill-To.


Store Information Tokens The following tokens will display specific information about the store.

%storename% The name of the store.

%storelink% A link to the store.

%storeemail% The email address of the store.

%storecompany% The store’s company name.

%storeaddress% The store’s address.

%storecity% The store’s city.

%storestate% The store’s state.

%storezip% The store’s zip code.

%storephone% The store’s phone number.

%storefax% The store’s fax number.

%storecountry% The store’s country.

Gift Certificate Attribute Tokens These tokens call in the information from the attributes used on the gift certificate product page (if used). Each token corresponds with the attribute code.

%for% The recipient’s name.

%address1% The recipient’s address.

%address2% The recipient’s additional address (usually city, state and zip code.

%note% The note entered by the purchaser.

%deliveron% The “deliver on” date.

%foremail% The recipient’s email address.


Version 5 Redemption Button Setup If you’re running version 5 of the module (with MIVA Merchant Version 5) you may need to manually place the redemption button. When installed, the module will attempt to make the necessary changes to the Merchant 5.x templates. However, to make those changes the module necessarily has to look for things it recognizes in the template and, as such, it is possible that the module would not be able to place the tokens correctly or not at all. If after installing the module you find the redemption button does not appear or does not work, you’ll need to modify the following pages in MIVA Merchant: The OSEL Page Template:

Immediately after the <mvt:item name="basket" /> item is where the module by default displays the prompt for the gift certificate key with the code: <mvt:item name="brokgcm" param="OSEL_redemption" /> You can place that item where you want to place the redemption prompt. If you have the module configured to bypass the shipping/payment prompt if the certificate is sufficient to cover the sub-total, then you will need to place: <mvt:if expr="ISNULL g.BROK_CERTIFICATES:bypass"> immediately before: <input type="hidden" name="Screen" value="OPAY"> and place: </mvt:if> after the </table> tag which ends the table in which the shipping and payment methods are displayed. This conditional will suppress that table if the subtotal is $0.00 after redeeming a certificate.

The OPAY Page Template:

To display the module's "the certificate was sufficient to pay for the order, please press 'continue button'" message you would use the token: <mvt:item name="brokgcm" param="OPAY_sufficient" /> by default, this is placed immediately after: <mvt:item name="basket" /><br>


To suppress the display of the payment module's payment fields (since they are not necessary as the certificate covers the order), place: <mvt:if expr="ISNULL g.BROK_CERTIFICATES:sufficient"> before the beginning of the form: <form method="post" action="&mvt:payment:url;"> and place: </mvt:if> immedately following the table in which the payment information fields are displayed (the module places the </mvt:if> after the second </table> tag appearing after the </mvt:foreach> tag)


Installing Gift Certificate Manager

1. In the Miva Merchant Admin Menu, click the next to Modules. 2. Click Add Module.

3. Use the upload button to upload the BROK_CERTIFICATES.mvc (or .mv if running MM version

4.13 or lower) to the store.

4. Once uploaded, click the Add button.

5. Click the next to your store’s link.

6. Click the Order Fulfillment link.

7. In the right-hand screen, check off the box next to Gift Certificate Manager and click Update.

8. At the top of the screen, click the Gift Certificate Manager link.

9. Enter your license key and agree to the terms.

10. Click Update.

Updating/Upgrading Gift Certificate Manager From time to time updates may be made to fix issues or add more features. To see if there are updates available for this module, you can click the upgrades link in the module’s admin at any time. If one is available, you can download the file and follow the instructions on updating the module.

Obtaining Support Standard support for this module is offered free of charge via the Support Desk. Standard support covers initial installation issues, confliction issues and standard usage of the module. Some issues may be considered advanced, such as requests that require custom coding or configuration. Services are offered for this type of support or work. Please inquire. Before contacting support, please double-check your settings against this document, and visit the Module’s FAQ section.


http://www.vikingcoders.com/helpdesk/faq.php?parent=168

gift certificate manager - viking coders

Documents