ups i-parcel international cart - magento · 2018-02-16 · if your catalog has 1000 skus and you...

8
UPS ® i-parcel International Cart 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. © 2015 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. April 4, 2016

Upload: others

Post on 12-Jul-2020

1 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: UPS i-parcel International Cart - Magento · 2018-02-16 · If your catalog has 1000 SKUs and you put 100 here, we will make 10 SubmitCatalog API requests. Use these fields to map

UPS® i-parcel™ International Cart

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.

© 2015 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.

April 4, 2016

Page 2: UPS i-parcel International Cart - Magento · 2018-02-16 · If your catalog has 1000 SKUs and you put 100 here, we will make 10 SubmitCatalog API requests. Use these fields to map

Page 2 UPS i-parcel / Magento Integration

About this Guide

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

Assumptions

1. You have a Magento admin account.

2. You have a Global Access account.

Get the extension

Download and install the UPS i-parcel International Cart extension.

You can install the UPS i-parcel extensions 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

Page 3: UPS i-parcel International Cart - Magento · 2018-02-16 · If your catalog has 1000 SKUs and you put 100 here, we will make 10 SubmitCatalog API requests. Use these fields to map

Page 3 UPS i-parcel / Magento Integration

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

Select the API key link

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

Page 4: UPS i-parcel International Cart - Magento · 2018-02-16 · If your catalog has 1000 SKUs and you put 100 here, we will make 10 SubmitCatalog API requests. Use these fields to map

Page 4 UPS i-parcel / Magento Integration

Log into your Magento Admin Panel with your Magento credentials

The UPS i-parcel extension is nested in the System menu. Your screen will have a shortcut to the UPS i-parcel tab.

Page 5: UPS i-parcel International Cart - Magento · 2018-02-16 · If your catalog has 1000 SKUs and you put 100 here, we will make 10 SubmitCatalog API requests. Use these fields to map

Page 5 UPS i-parcel / Magento Integration

Configuration

Paste your UPS i-parcel Company

ID from the Dashboard here.

Paste your UPS i-parcel API Key

from the Dashboard here.

This field asks if you want to send information to i-parcel to start the

process of shipping items to your customers when a customer checks out.

In the Tax Intercepting row, you will have to make

certain decisions about how to show Tax and Duty on

your website. Depending on which option you chose,

you can rename the Tax, Duty, or Tax & Duty rows.

You can opt not to show Tax and Duty.

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

You can show Tax and Duty as one line item.

Select “Yes”

to apply two

lines of i-

parcel code (JS

and CSS) into

the <head>

element of

your theme.

If you do not have JQuery running, we can reference a jQuery library. Set

this to “No” if you are currently using another jQuery library.

If you need an additional file to append the various elements that i-parcel

looks at (i.e. to find product SKUs), then please upload these files here.

The standard is to set this to Yes.

Page 6: UPS i-parcel International Cart - Magento · 2018-02-16 · If your catalog has 1000 SKUs and you put 100 here, we will make 10 SubmitCatalog API requests. Use these fields to map

Page 6 UPS i-parcel / Magento Integration

Catalog Mapping

Turn off automatic catalog updates

Update the catalog when you

save product information.

Update the catalog at

pre-scheduled job updates.

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.

The Upload Step Size describes how many SKUs to upload at once.

If your catalog has 1000 SKUs and you put 100 here, we will make 10

SubmitCatalog API requests.

Use these fields

to map Magento

attributes to the

i-parcel attribute

elements. We

use attributes for

classification.

Ship Alone is either True or False.

True means the item will ship by

itself. False means the item can be

can be bundled with other items.

The value is false by default. HS Code is

the item’s

Harmonization

Code Configurable products are products that have

to have a certain options selected before adding

them to the cart. For Price Type of configurable

products, by default, we take the price associated

with the item SKU. However, we can also take the

price of the parent or configurable product. For

example, if Red-Hood is the configurable

products, we can use its price or the price of its

children i.e. Red-Hood- or Red-Hood-XL.

Page 7: UPS i-parcel International Cart - Magento · 2018-02-16 · If your catalog has 1000 SKUs and you put 100 here, we will make 10 SubmitCatalog API requests. Use these fields to map

Page 7 UPS i-parcel / Magento Integration

Shipping Methods

The Shipping Methods screen is inherent to Magento and is relevant to Logistics-Only clients.

International Cart clients should select “No” in the Enabled dropdown.

Select No if you are an International Cart merchant.

Select Yes to enable i-parcel as a Logistics/Only shipping option.

These are the three

standard UPS i-parcel

shipping methods

available.

In this section, Magento

asks to apply the i-parcel

shipping options to certain

countries or all countries.

However, you will still

need to select countries in

the i-parcel Dashboard to

apply or not apply

shipping for those

countries.

This automates shipping on your end once i-parcel APIs are called.

This differentiates i-parcel from other shipping methods.

This allows Magento order numbers to become the reference

fields in the UPS i-parcel Global Access Dashboard.

Page 8: UPS i-parcel International Cart - Magento · 2018-02-16 · If your catalog has 1000 SKUs and you put 100 here, we will make 10 SubmitCatalog API requests. Use these fields to map

Page 8 UPS i-parcel / Magento Integration

External API

Logs

We use this section for troubleshooting issues that you may encounter.

Logistics-Only clients should set this to “Yes”

to activate the i-parcel/Magento extension.

International Cart clients should select “Yes” here to prevent Magento from

sending out an order confirmation email after i-parcel already sends one out.

This option gives you the ability to set the status of the order (pending,

processing, or completed). This may be relevant if you use 3rd party

warehouse systems where orders have to be marked a certain way.