Miva Merchant 4 Module FAQs » UPS Custom Integration (BROK_UPS_CUSTOM)


Information required for installing UPS Custom Integration

Here is the info we need to perform the custom integration:

We will be installing the UPS Custom Integration into your "e-commerce enabled application" (aka. Miva Merchant) and we will need some information from you to permit us to do the integration. The module communicates with UPS.com to calculate shipping rates and to do that it needs to pass along three account specific pieces of information: a UPS.com User ID and Password, and a XML Rates and Services Access Key. All of these can be obtained relatively easily at UPS.com; unfortunately, UPS.com is very inconsistent in how it leads you through its website to obtain this information and to obtain the Access key you'll first need to obtain a Developer's key. We have provided step-by-step instructions for how to go about getting this information.

Obtaining the necessary information from UPS.com has three main "steps":

1) registering for an account at UPS.com

The first step is to register as a UPS user (i.e. get a "ups account" on the site) or log into your current account if you already have one. At the top of the white portion of the page are fields to provide your User Id and Password as well as a link to register for an account. If you already have an account, log in and proceed to step 2.

To register click on the [Register] link. You will be presented with a license agreement. Read it and click on the "accept" button at the bottom. You will then be provided with a form to collect your contact information. Provide the required information and click on [Submit]. You will then be prompted to provide a User ID and Password for your account (this is what you'll log in with on future visits). Provide
this and click on [Submit]. At this point you have successfully registered your account and are brought to the "My UPS" page.

2) obtaining a Developer's key

Here's how to go about it (directly from UPS tech support):

You will first need to accept the UPS OnLine Tools license agreement. This occurs when you actually try to access one of the tools. Accepting the agreement gives you a Developer's License (signified by a Developer's Key). Here are the steps to obtain a Developer's Key:

1. Access the OnLine Tools site at http://www.ups.com/onlinetools

2. Click on [Get OnLine Tools] on the right.

3. Click on [Log In] on the right.

4. Provide your user ID and password and click on [Submit].

5. Select the [UPS Tracking] link. The actual tool you select is not
important at this time.

6. Click on [Go to end user license agreement].

7. After reviewing the agreement, click on [Accept] at the bottom.

8. Provide any additional information on the form. Remember that fields
with bold titles are required.

9. Click on [Submit].


3) obtaining the XML Rates and Services access key

This step is very similar to the last step but on that step where we clicked to [Register] for a developer's key, you'll enter it.

a. Access the OnLine Tools site at http://www.ups.com/e_comm_access/laServ?loc=en_US&NEXT_PAGE=WELCOME

b. If you're not already logged in, provide your User ID and Password in the forms at the top of the white portion of the page an log in. (then click on the link http://www.ups.com/e_comm_access/laServ?loc=en_US&NEXT_PAGE=WELCOME to get back to where you were)

c. Click on the [Get Access Key] link on the right side.

d. On the subsequent screen, click on the [Get XML Access Key] in the center, gray portion.

e. The next screen prompts you for your Developer's Key. Enter the Developer's Key and click on [Submit].

f. You will be presented with a license agreement. Read it and click on "Accept".

g. On the next screen you will be prompted for additional account formation. Provide any required information that is not filled in and click on [Submit].

h. Your XML Access Key will be displayed and it will also be emailed to you.

To do the integration into your site, we'll need your UPS user id and password (that you use to log in to your UPS account at UPS.com) and the XML Rates and Services Access key for the tool (all three have to be communicated to UPS with every request for rates).

In addition, we'll need admin access to the store to install the module and ftp access to the server to upload some image files. We'll also need to know the specific store into which the module is going to be integrated.

So, to sum all of that up, to do the integration we need:

URL to Merchant admin
Merchant admin user name/password:
URL to ftp:
Ftp user name/password:

UPS User name:
UPS Password:
UPS XML Rates and Services access key:

Post all of these into a ticket in our Help Desk in the UPS Custom Integration Installation department. (Information posted at the Help Desk is secure)



Last update: 2007-10-24 10:41
Author: Thor
Revision: 1.1

Print this record Send to a friend Show this as PDF file
Please rate this entry:

Average rating: 0 out of 5 (0 Votes )

completely useless 1 2 3 4 5 most valuable

You cannot comment on this entry