ups i-parcel shipping extension for magento 1 · introduction about this guide this document...

UPS® i-parcel™ Shipping

Extension for Magento 1

THIS DOCUMENT IS THE CONFIDENTIAL INTELLECTUAL PROPERTY OF UNITED PARCEL SERVICE OF AMERICA. INC. USE, REPRODUCTION, AND

DISTRIBUTION OF THIS DOCUMENT IS LIMITED SOLELY TO AUTHORIZED PERSONNEL.

© 2019 United Parcel Service of America, Inc. UPS, the UPS brand mark, and the color brown are registered trademarks of United Parcel Service, Inc.

All Rights Reserved.

February 13, 2019

UPS i-parcel / Magento Integration

Contents

Introduction .............................................................................................................................................................................................................................................................................................................................................................................................. 3 About this guide .................................................................................................................................................................................................................................................................................................................................................... 3 Assumptions ........................................................................................................................................................................................................................................................................................................................................................... 3 Get the extension .................................................................................................................................................................................................................................................................................................................................................. 3 Setting up the UPS i-parcel extension ............................................................................................................................................................................................................................................................................................................ 3

Configuration ........................................................................................................................................................................................................................................................................................................................................................................................... 6 General .................................................................................................................................................................................................................................................................................................................................................................... 6

Company ID ............................................................................................................................................................................................................................................................................................................ 6 Web Service Key (GUID) ......................................................................................................................................................................................................................................................................................... 6 Dashboard ............................................................................................................................................................................................................................................................................................................... 6

Tax Interception .................................................................................................................................................................................................................................................................................................................................................... 7 Disabled .................................................................................................................................................................................................................................................................................................................. 7 Enabled – Tax & Duty cumulatively ........................................................................................................................................................................................................................................................................ 7 Enabled – Tax and Duty separately ........................................................................................................................................................................................................................................................................ 7

Synchronization > Catalog Mapping .................................................................................................................................................................................................................................................................................................................................................. 8 Configuration ......................................................................................................................................................................................................................................................................................................................................................... 8

Disabled .................................................................................................................................................................................................................................................................................................................. 8 On product save...................................................................................................................................................................................................................................................................................................... 8 Cron job .................................................................................................................................................................................................................................................................................................................. 8

Upload ..................................................................................................................................................................................................................................................................................................................................................................... 9 Upload Catalog button ........................................................................................................................................................................................................................................................................................... 9 Upload Step Size ..................................................................................................................................................................................................................................................................................................... 9 Upload offset .......................................................................................................................................................................................................................................................................................................... 9

Catalog Mapping Attributes ............................................................................................................................................................................................................................................................................................................................ 10 Attribute(s) ........................................................................................................................................................................................................................................................................................................... 10 HS Code ................................................................................................................................................................................................................................................................................................................. 10 Ship Alone ............................................................................................................................................................................................................................................................................................................. 10 Price Type ............................................................................................................................................................................................................................................................................................................. 10

Shipping Methods .................................................................................................................................................................................................................................................................................................................................................................................. 11 Enabled .................................................................................................................................................................................................................................................................................................................................................................. 11 Title ......................................................................................................................................................................................................................................................................................................................................................................... 11 Allowed Services .................................................................................................................................................................................................................................................................................................................................................. 12 Name of Displayed Payment Method .......................................................................................................................................................................................................................................................................................................... 12 Use alternate country of origin … .................................................................................................................................................................................................................................................................................................................. 13 Country of Origin ............................................................................................................................................................................................................................................................................................................................................... 13 Ship to Applicable Countries / Ship to Specific Countries ...................................................................................................................................................................................................................................................................... 13 Auto Generate Shipment ................................................................................................................................................................................................................................................................................................................................. 13 Auto Generate Tracking on Shipping ........................................................................................................................................................................................................................................................................................................... 13 Completed Orders Use Different Order Prefix… ........................................................................................................................................................................................................................................................................................ 14 Send Order Number as Reference ................................................................................................................................................................................................................................................................................................................. 14


Introduction

About this guide

This document describes starting and setting-up the UPS i-parcel Shipping extension for Magento 1.

Assumptions

1. You have a Magento admin account.

2. You have a UPS i-parcel Global Access account.

Get the extension

You can install the UPS i-parcel extension in several ways:

1. We can send you a zip file with the extension

2. Login in to your UPS i-parcel Global Access Dashboard and follow the links to Integrate > Magento > Install

3. Use the Magento Extension Marketplace: https://www.magentocommerce.com/magento-connect/developer/UPSiparcel

Setting up the UPS i-parcel extension

Get your customer ID and API key.

✓ Log into the UPS i-parcel Global Access Dashboard: https://globalaccess.i-parcel.com/Dashboard

✓ Select the </> Integrate! Option in the left panel

https://www.magentocommerce.com/magento-connect/developer/UPSiparcel

https://globalaccess.i-parcel.com/Dashboard


✓ Select the API key link

✓ Store your Company Id and API key, which you will need next

✓ Log into your Magento Admin Panel with your Magento credentials


✓ Select i-parcel > Configuration


Configuration

General

These are the initial settings of the extension. Select the Save Config button to commit any changes.

Company ID

This is your UPS i-parcel Company ID number.

Web Service Key (GUID)

This is your UPS i-parcel API key.

Dashboard

Select this button to go to the Global Access Dashboard.


Tax Interception

This screen asks you how to display tax and duty on your website.

Disabled

You can opt not to show Tax and Duty.

Enabled – Tax & Duty cumulatively

You can opt to show Tax and Duty on separate lines.

Enabled – Tax and Duty separately

You can show Tax and Duty as one line item.


Synchronization > Catalog Mapping

This section describes how to synchronize your Magento catalog with the copy of your catalog in UPS i-parcel Global Access.

Configuration

This screen asks if and how often you want to update the Global Access catalog.

Disabled

You can turn off automatic catalog updates.

On product save

You can update the catalog when you save product information in your Magento catalog.

Cron job

You can update the catalog at pre-scheduled time intervals.


Upload

This screen asks how to handle uploads to the UPS i-parcel catalog.

Upload Catalog button

Select this button to upload to the UPS i-parcel catalog immediately.

Upload Step Size

The Upload Step Size describes how many SKUs to upload at once. If your catalog has 1000 SKUs and you put 100 here, the

extension will make 10 SubmitCatalog API requests to send the catalog to Global Access.

Upload offset

If you put a number here, and your catalog upload is interrupted, then the re-upload will begin at the SKU after this number. This

is mostly a concern for catalogs of 250 thousand SKUs or larger.


Catalog Mapping Attributes

Use these fields to map your field names in Magento to Global Access.

Attribute(s)

You can use the Attribute fields to map the attributes to Global Access attribute elements. UPS i-parcel uses attributes for

classification purposes. The items in these dropdown are propagated by the product attributes setup in Magento

HS Code

HS Code refers to the item’s Harmonization Code.

Ship Alone

Ship Alone is either True or False. True means the item can ship by itself. False means the item can be can be bundled with other

items. The value is false by default.

Price Type

This field refers to configurable products - products that require shopper to select certain options selected before adding them to

the cart. By default, we the price associated with the item SKU. However, we can also take the price of the parent or configurable

SKU. For example, if Red-Hood is the parent product, we can use its price. Or we can use the price of its children i.e. Red-Hood-

or Red-Hood-XL.


Shipping Methods

The Shipping Methods screen is native to Magento.

Enabled

Select Yes here to enable UPS i-parcel as a shipping option.

Title

You can label the shipping method with this field.


Allowed Services

Select the UPS i-parcel service enabled with your account. Options include:

• 112 UPS i-parcel Express

• 115 UPS i-parcel Select

• 119 UPS i-parcel Saver

• 211 UPS Standard

• 208 UPS Expedited

• 265 UPS Saver

• 207 UPS Express

• 254 UPS Express Plus

Name of Displayed Payment Method

You can edit the name in this field

.


Use alternate country of origin …

If you select “Yes” in this field, then you can choose an origin country that differs from the country selected in “Shipping Settings.”

Country of Origin

If the shopper’s destination country differs from the origin country selected using the dropdown in this field, the UPS i-parcel shipping

method will be available.

Ship to Applicable Countries / Ship to Specific Countries

In these sections, you can apply shipping options to the countries selected here. You will still need to select countries in the UPS i-parcel

Global Access Dashboard to apply or not apply shipping for those countries.

Auto Generate Shipment

Enable this option to generate a Magento shipment automatically when the order completes.

Auto Generate Tracking on Shipping

Enable this option to submit a parcel automatically when the shipment is created.


Completed Orders Use Different Order Prefix…

You can enter a prefix in this field to differentiate UPS i-parcel from other shipping methods. Leave blank for no prefix.

Send Order Number as Reference

This allows Magento order numbers to become the reference fields in the UPS i-parcel Global Access Dashboard.

ups i-parcel shipping extension for magento 1 · introduction about this guide this document...

Documents