Software Sale!
Save up to 20%
Welcome to Advanz Design
Specializing in Miva since 2000
Miva Business Partner
   Home     Shop     My Account     Search     All Products View Cart     Checkout   
Sign In

Affiliate Login

Find a Product:

Modules By Type:
Miva Merchant 5
Admin Utilities
Extra Functionality
Look and Feel
Free Modules


Legal Information
Product Documentation
Module Upgrades

MAD Ring Search:

Find modules and scripts in the
Miva Application Developers Ring

UPS Address Validation v5

Product Code: UPSADDR5
Doc Updated: May 2012
Product Documentation Menu

This module interfaces with the UPS address validation server to allow customers to verify shipping addresses at checkout. In order to use this feature, the UPS brand/mark logo must appear where the address validation technology is in use as required by UPS. The address validation results/options display is based on Miva's template/token language for enhanced customizability/flexibility.

After the address info is filled in on the customer info checkout page and the continue button is clicked, the supplied shipping address will be verifed by UPS. If the address is an exact match then the next checkout page will display normally. If some recommended addresses are returned then the customer has the option to select one of these recommended addresses displayed below the customer fields OR update the filled in address above and re-validate OR just continue checkout with the filled in address. If no available addresses can be recommended by UPS then the customer has the option to update the filled-in address above and re-validate or just continue checkout with the filled in address.

  1. Install upsaddr_m5.mvc module file normally into Miva Merchant 5. The module settings will be located in the system extension settings of the admin.
  2. The module will initially be configured for use with UPS's test/cie server that can validate CA and NY state addresses only. In order to use the UPS production level that can validate any US based address you'll need to upgrade your UPS Access Key to "production access" for the address validation feature as instructed below before the Production server mode option can be activated to function properly.
*Required fields are in bold so these fields will need to be configured before the module can be used for the first time. The intially empty fields include UPS account user name, password, access key, and brand/mark image (please upload the included UPS image in order to retain the right to use the address validation technology from UPS required by the terms & conditions of this module). The module field definitions are displayed below:
  • Enable - Turns the module on/off.
  • UPS User Name - User name/login id to log into your UPS account.
  • UPS Password - Password to log into your UPS account.
  • UPS Access Key - Access key obtained from UPS allowing use of the address validation feature with UPS.
  • UPS Test/CIE Server URL - UPS's test server url for testing address validation for CA and NY state address.
  • UPS Production Server URL - UPS's production server url for validating any US based address.
  • UPS Mark Image - UPS's brand/logo image required for display whereever the UPS address validation technology is in use. Please upload the included UPS image file to fulfill the usage requirements mandated by UPS and the terms and conditions associated with this module.
  • Maximum # of Addresses to Display - Maximum number of recommended/validated addresses returned from the UPS server to list displayed underneath the customer fields at checkout.
  • Server mode - Select "test/cie" to run intial tests for CA/NY state based addresses as needed or "production" when ready to validate any US based street address. Please reference the section below regarding "Upgrading to Production Access for UPS Address Validation" before the production option can be activated for proper use.
  • Address Selection Template - Displays content corresponding to the recommended addresses returned by UPS server and options to re-validate or continue checkout with filled-in address. The following SMT items and entities available to customize the display of this content:

    • <mvt:item name="upsaddr" /> - Displays the addresses recommended by UPS in addition to the alternative options to re-validate or continue checkout. This item is automatically inserted in the OCST customer info checkout page underneath the customer fields during the module installation.
    • upsaddr:invalid - Set to true or "1" if UPS cannot return any recommended addresses.
    • upsaddr:results - Array populated with UPS recommended addresses. Please reference the default template content for an example of the array syntax and available displayable entities, such as address, city, state, and zip code.
    • upsaddr:results_serialized - hidden data returned from UPS server used to process customer's selection.

This feature provides a method to submit test addresses to the UPS address validation server to display/review the returned XML data for testing purposes. Please make sure that you've initially setup the module settings for the first time with your UPS account creditentials in order to use this feature. Also included is an option to download the generated XML file to submit to UPS in order to upgrade to UPS "production access", for example.

To validate an address input an address into the fields where prompted where bolded fields are required and then click the update button. If the Server Mode module setting is set to Test/CIE then you'll only be able to validate addresses in CA and NY state until your UPS account has been updated to Production Access level. The server response in XML format is then displayed below the input fields. Right click the Download Export File link if you would like to save the server response to a file on your computer, such as for submittal to UPS in order to upgrade a UPS account to Production Access level.

When the module is intially installed and activated, the SMT item to display the suggested addresses is automatically created and assigned to display under the customer fields in the customer info checkout page template (OCST) as indicated by a new template version labled "upsaddr: Insert UPS Address Validation". If the suggested addresses do not display in the customer info checkout page you will need to manually review and execute the steps outlined below in the "Pages" configuration for the "OCST: Checkout: Customer Information" page in your admin.
  • Create Item - Inside the "Items" interface, add a new item by clicking on the "Add Item" button. Enter "upsaddr" into the Code field and "UPSADDR5" into the Module field when prompted and click the Update button.
  • Assign Item - Inside the "Items" interface, find the newly created item and assign it by checking the "assigned" box and click the Update button.
  • Add Item Reference to Page - Inside the "page" interface for the template field, you can add the item reference to display the new buttons under the basket contents by following the steps outlined below.

    Inside the "Template" field find a snippet of code that resembles the following:

    Then replace it with the following code snippet:

When uninstalling the module, the process above should automatically be reversed, which removes the item reference from the customer info checkout page template (as inidicated by a new template version labeled "upsaddr: Remove UPS Address Validation"), unassigns the item, and deletes the item. If this process didn't complete, you can manually reverse the steps displayed above with the steps outlined below.
  • Remove Item Reference from Page - Recall any previous version saved for this template or follow the steps outlined below.

    Inside the "Template" field find a snippet of code that resembles the following:

    Then replace it with the following code snippet:

  • Unassign and Delete Item - Inside the "Items" interface, find the item associated with the module labeled "upsaddr" and uncheck the "assigned" box and click the Update button. Next, click the "edit" link associated with the item and then click the Delete button.
  1. Log into your UPS account and register for an access key if you don't already have one at the following link:
    UPS Developer Kit
  2. Click on "Manage Access Keys" link underneath the "Access and Administration" section, input your access key, and click "Request Production Access" button.
  3. You'll then receive email instructions on what is needed to submit to UPS in order to approve your request. This includes two successful XML responses returned from UPS's CIE/test server for address validation. Please reference the "server test feature" section on how to use this module's feature to generate these XML files for submittal to UPS.
Paypal Verified
Sales Inquiries:
Technical Support:
Copyright © 2015-2001 by Advanz Design
Legal Information

High Speed Ecommerce
& Web Hosting Services