24/7 Support: 800.608.6482

Get Started

Reference Guide

UPS Developer Kit

To Enable UPS

  1. Go to Menu> Shipping > Add / Remove Modules > Available Modules section.
  2. Click Install under UPSĀ® Online Tools.

To Register the UPS Module

You must register the UPS module after you enable it. Normally you only do this once, but if you remove the module in the Add/Remove Modules tab, and then re-install it, you'll have to go through registration again.

  1. Enable the UPS Developer Kit module.
  2. Register the module. Click on the UPS Developer Kit tab.
  3. 2.1. In the first install screen you can choose to install the module in Production or Test modes. In Production mode you can get real-time shipping rates and print real shipping labels that will be billed to your UPS account. In Test mode you can get real-time rates and print free test labels that cannot be used for shipping.

    2.2. Select the installation mode, then click on "Click here" to start the wizard.

    Shipping Settings

    2.3. The first screen of the registration wizard will appear. Click Next.

    UPS Dev Kit

    2.4. The end user license (EULA) screen will appear. Scroll to the bottom of the agreement, check the agreement box, and click Next.

UPS Technology

2.5. The contact information screen will appear. Enter information in at least the bold (required) fields and click Next. If you have a UPS account number you can enter it in this screen, but you can complete the registration process without it and enter it later. The phone number that you enter here should not have spaces or dashes.

UPS Technology

2.6. In the next screen, click Finish to complete the registration.

To Configure the UPS Developer Kit Module

After you register the UPS module, you can click on the UPS Developer Kit tab and select the UPS services that you want.

Before PR8 Update 7 you could only print UPS shipping labels if you had a credit card and an account with UPS. In the current UPS module, you can create shipping labels with just a credit card. It is no longer necessary to have a UPS account.

Mode: You can use the UPS module in Production or Test mode. In Production mode you can get real-time shipping rates and print real shipping labels that will be billed to your UPS account. In Test mode you can get real-time rates and print free test labels that cannot be used for shipping.

Rating API Status: This is a read only field. It will display "Active" if you have successfully registered the UPS module, with or without your UPS account number. If this field is set to active, you will be able to get real-time UPS shipping rates.

Shipping API Status: This is a read only field.. It will display "Active" if you have entered a valid UPS account number. If you have not yet entered your UPS account number, this field will show "Inactive". If this field is set to active, you will be able to create valid UPS labels that are billed to your account.

Default UPS Account: You must have a valid UPS account number in order to print shipping labels. If you don't have a UPS account number, you can still use this module to get real-time shipping rates.

UPS Account Type: Select the type of account that you created with UPS.

Billing Method: Select "Bill configured UPS account" or "credit card". If you select credit card, Miva Merchant will prompt you to enter a credit card number every time that you print a label. Your credit card information is not retained by Miva Merchant.

UPS Rate Code: This is a read only field. It displays a proprietary code, created by UPS, that corresponds to the type of account that you have. The rate code will change if you re-register the module.

Use Negotiated Rates: UPS has three "standard" rates depending on how frequently you ship: Daily Pickup, Occasional Pickup, and Suggested Retail Rate. See "Billing Method" above. However, you can also contact UPS and get a better rate if you are an even more frequent shipper. This is called a "negotiated rate". If you check this box, your on-line store will display your negotiated rate. If you don't check this box, your on-line store will display the rate associated with whatever you selected in the UPS Account Type field.

Re-registering the module also unchecks the Use Negotiated Rates checkbox.

Use Zebra Thermal Printing: PR8 Update 8 added the ability to print adhesive backed address labels using a Zebra or Zebra compatible printer. A Zebra compatible printer can be used with Endicia, FedEx, UPS, and Canada Post, but currently not with the USPS module.

Requirements:

  • Your browser must have Java enabled. See http://java.com/en/download/help/enable_browser.xml.
  • You must have a Zebra or Zebra compatible printer that can print .zpl.
  • Your store must be running PR8 Update 8 or later.

Ship From: This address, and the customer's ship to address, are used to calculate shipping charges. This address will appear on your shipping labels.

Default Delivery Confirmation: The value you select here for delivery confirmation will be the default for every product that you ship using UPS. However, you can over-ride the store wide default setting at the product level.

Please note that the most restrictive delivery confirmation setting for any item in the order gets precedence for the entire order. For example, if one item in the order requires an adult signature, and the other items in the order only require delivery confirmation, the order as a whole will be marked as requiring adult signature.

Specify Declared Value Equal To Basket Subtotal:"Declared value" is the order total. If you check this box, the order total will be sent to UPS and UPS will automatically insure the order based on its value. The shipping charge will go up because it includes the insurance. If you don't check this box, the order total is not sent to UPS and insurance is not automatically added. This field cannot be over-ridden at the product level.

http://www.ups.com/content/us/en/shipping/time/service/value_added/declared_valu e.html

Declared Value Currency: Select the currency that you use to describe the order total.

Available Services: Select the UPS shipping options that customers will see during checkout. Note that shipping methods can also be restricted at the product level.

Looking for Developer Docs?

We have a whole section for that, including: Developer Training Series, Template Language docs, Module Development tutorials and much, much more.

Head to the Developer Section

Miva believes that all online businesses should have access to a scalable ecommerce platform that can meet their unique business requirements. Miva offers PCI compliant ecommerce, hosting, and custom website design and development solutions. Miva customers have processed over $100 billion in online sales since 1997.

Copyright © 2016 Miva, Inc - All Rights Reserved   Privacy Policy | Store Policy

Links
Contact Us
Receive Tips & Updates

Copyright © 2016 Miva, Inc - All Rights Reserved

Back To The Top