Create UPS return labels directly from yayloh, including paperless customs for cross-border returns.
Using UPS through Webshipper or nShift instead? See Webshipper or nShift.
Before you start
A UPS account, with the countries you want to offer returns from.
Your warehouse set up under Settings > Stores & warehouses. You'll choose it when you create the route.
Admin access to yayloh.
Step 1: Get your credentials
You need three things from UPS:
Client ID and client secret: create them in the UPS developer portal (see below).
UPS account number: make sure it's added to your ups.com profile.
Create a UPS client ID and secret
Go to the UPS developer portal and log in.
In your profile menu, go to Apps and click Add Apps. Choose I want to integrate UPS technology into my business and select your UPS account.
Enter your contact details.
Under API products, turn on Shipping, Tracking, Paperless Documents, Time in Transit, Locator, Pickup and Rating. OAuth is selected automatically.
Save, then copy your Client ID and Client Secret.
Step 2: Add UPS as a carrier
Go to Settings > Carriers & Routes and open the Carriers tab.
Click Add carrier, enter a name (for example "UPS"), and choose UPS as the carrier company.
Under Credentials, enter your client ID, client secret and UPS account number.
Step 3: Create a route
In the Routes tab, click Add route and choose your UPS carrier under Use.
Under Allow returns from, choose the countries enabled in your UPS account.
Choose your Default warehouse.
Open Specifications and fill in the fields below.
Field | What to enter |
SERVICE_CODE (required) | Your UPS service, for example |
PAPERLESS | Turn on for paperless customs documents |
LENGTH, WIDTH, HEIGHT, WEIGHT | The default parcel size and weight, for example 20 × 15 × 10 and 1 |
UNIT_OF_DIMENSION, UNIT_OF_WEIGHT | The units for the parcel, for example |
TERMS_OF_SHIPMENT | Optional. The delivery terms (Incoterms) for cross-border returns, for example |
TAX_REDUCTION | Optional. Use it to adjust the value declared for customs. |
Using different UPS services per country? Create a separate route for each.
Step 4: Save and test
Click Apply changes, then create a test label on the Labels page. To test paperless customs, use a return request with an item that has an HS code and a value of at least 1.
Good to know
Labels only work for countries enabled in your UPS account. To add a country, contact UPS first.
For how routes, priority and fallbacks work, see Carriers & Routes: how it works.