Add a UPS account

This page walks through the UPS-specific steps. The setup steps common to every carrier (sidebar navigation, general settings, save) are described once on Add a carrier account.

Before you start

• UPS sandbox or live credentials. From UPS you need: shipper number, client ID, client secret, tax ID, and the service code matching your UPS contract.
• Decision: live or sandbox. UPS has a sandbox API. Smoke-test before flipping to Live Connector.

1. Open the carrier accounts page

In the Carriyo Dashboard, open Settings in the left sidebar.

Under Carrier Management, click Carrier Accounts to open the list of existing accounts.

Click the + add icon in the top-right corner to start a new account.

2. Pick UPS

Type UPS into the carrier picker's search field, then click Select on the UPS result.

3. Enter the basics

Account name. A label that's meaningful to your ops team. Conventional patterns: ups-uk, ups-us. Keep it short and unique within the tenant.

Account country. The country the account operates from.

Click Next.

4. Enter your UPS credentials

The next screen collects the three credentials UPS issued for your account. Each is essential; UPS rejects calls if any are missing or wrong.

Shipper number. The six-digit account number UPS provides for your shipper account. UPS uses this for billing and identification.

Client ID. The public identifier you received when registering with UPS for API access.

Client secret. Paired with the client ID. Carriyo uses both to obtain an access token for booking shipments and generating labels.

Click Next.

5. Tax ID and service code

The next screen collects two fields:

• Tax ID. The shipper's tax identification number. Required for customs and billing purposes.
• Service code. The UPS service this account defaults to (for example UPS SAVER, GROUND, EXPRESS). Pick the one matching the contract you have with UPS.

Click Next through any remaining wizard screens. UPS may show optional packaging and shipment-option pages; defaults work for most setups, and you can revisit them on the account detail page afterwards.

6. Finish the wizard

Click Go to Account to land on the new account's detail page.

7. Configure the account

The newly created account opens on its detail page.

The general settings (active toggle, country, currency, sandbox/live) are configured the same way for every carrier. See Add a carrier account → General settings for the full walkthrough.

Default label

UPS labels default to Carriyo PDF. UPS also exposes its own label-format options (GIF, ZPL, SPL, EPL) configurable in the UPS Label Configuration section further down the account detail page.

Merchant access

On multi-merchant tenants, restrict the account to specific merchants via the Permissions tab.

Click Save in the top-right corner.

UPS-specific concepts

Service codes

UPS supports a wide range of service codes for domestic and international shipments. Pick one as the account default; individual shipments can override the default if you need a different service.

Common codes:

• 01: Next Day Air
• 02: Second Day Air
• 03: Ground
• 07: Express
• 08: Expedited
• 11: UPS Standard
• 65: UPS Saver

Packaging code

Set the default packaging type used for your shipments. Defaults to Customer Supplied Package (02) when not set.

Other Shipment Charge Types

Add any extra shipment charges that should apply to all shipments booked with this account. Currently supported: 02 (Duties and Taxes). Optional.

Terms of Shipment

The Incoterm UPS records on the commercial invoice for cross-border shipments. Common values: DDP (Delivery Duty Paid), DDU (Delivery Duty Unpaid), CIF (Cost Insurance and Freight). Pick what your contract with the consignee specifies.

Payment configuration

If duties, taxes, or transportation charges are paid by a party other than the shipper (recipient, third party), configure the Billing & Payment section on the account detail page. UPS requires the payor's account number, country code, and postal code (for US/Canada origins).

UPS return service settings

For reverse / return shipments, the UPS Return Settings section on the account detail page configures how UPS generates and delivers the return label:

• Return Service Code. The type of return service: print and mail, return service one/three attempt, electronic return label, print return label, exchange print return label, pack-and-collect variants.
• From Email Address for Label. Sender on the return label. If empty, Carriyo uses the contact email from the Dropoff details.
• To Email Address for Label. Recipient of the return label email. If empty, Carriyo uses the contact email from the Pickup details.

World Ease (consolidated shipping)

If you've negotiated UPS World Ease for consolidated shipping, enable Enable Consolidated Shipping under Account Setup. Additional World Ease configuration becomes available once enabled.

Callback registration

UPS doesn't push status updates to Carriyo via webhook. Status updates come through scheduled tracking polls. No callback configuration is needed on UPS's side.