ShippingKit Labels integrating UPS Shipping Services for X-Cart

Quick Guide

Content:

1. Introduction
2. Installation
3. Configuring
4. Orders and Labels

Configuration

After ShippingKit Labels has been installed, you should configure the UPS settings.

The software settings are available by clicking the "UPS Settings" link in the "Management" section of the administrator back-end. There are various settings to manage UPS Shipping Labels options such as package type, label format, etc.

First of all, you should populate UPS account number, UPS username, UPS password and Access Key provided by UPS.

1. Shipper's attention name is a shipper's contact name.
2. Currency allows to choose currency UPS Shipping Labels generation module works with:
   • "USD" - US dollar
   • "CAD" - Canadian dollar
   * The currency must be the same as the currency of your store which is set on the General Setting page.
3. Package type allows to choose a package type used by the store by default. If you choose "Package" as the package type, you should define package sizes below.
   • UPS Letter/Express Envelope
   • UPS Tube
   • UPS Pak
   • UPS Express Box
   • UPS 25 KG Box
   • UPS 10 KG Box
   • Package
4. Package sizes (Package length, Package width, Package height) should be defined if "Package" is selected as the package type
5. Ship to Residence allows to choose logic to determine the "Business/Residence" address flag.
   • "Always NO" - All adresses are treated as "Business"
   • "Always YES" - All adresses are treated as "Residence"
   • * Extra field
   * You can define an additional user profile field on the "User Profiles options" page, and select it as the "Ship to residence" option here. We recommend setup the "checkbox" or "select box" type for the extra field associated with the "Ship to residence" field. If it's a select box, it should just contain "Yes" and "No" options.
6. Test mode allows to test UPS Shipping Labels generation, you won't be charged for labels in this mode.
7. Debug mode saves all transactions requests and response from UPS server (to generate, void shipping labels, tracking information requests) in the log file located in the Logs directory of your store.
8. Label image type allows to choose one of the following label formats:
   • "GIF (plain)" - a GIF picture
   • "EPL2 (thermal)" - thermal printer format
9. Ship from address field allows to choose an address the packages would be sent from:
   • "Company`s default address" - your company address
   • "Provider`s billing address" - your provider billing address
   • "Provider`s shipping address" - your provider shipping address
10. Delivery confirmation allows to set a confirmation delivery flag for packages. The following options supported:
    • No Delivery Confirmation
    • No signature
    • Signature Required
    • Adult Signature Required
11. Mark the order as 'Completed' after getting the label checkbox sets the "Completed" status to the order as soon as a shipping label successfully generated.

    Note: When order status is set to 'Completed' the store sends email notifications to customers.