UPS

Go to the Extensions → Shippings → UPS

The UPS Shipping Extension integrates United Parcel Service (UPS) with your AbanteCart store.

It allows you to display real-time shipping rates, create shipping labels, and offer domestic and international delivery options directly from checkout.

Account (Shipper) Number: Your UPS account number used for billing and shipment processing. This number is required to authenticate shipments with UPS.

If you’re a new customer, your UPS account number may have been provided during sign-up.

If not, you can contact UPS sales or retrieve it by logging in to your UPS account:

1. Go to your Account Information or Billing section.

2. Your Account Number will be displayed there.

API Credentials

API Client ID: The Client ID provided by UPS when registering for API access. Used to authenticate API requests.

API Password: The corresponding password (Client Secret) associated with the API Client ID. Keep this value secure; do not share it publicly.

Obtain UPS API Credentials

To obtain UPS API credentials, including the Client ID and Client Secret, follow these steps:

1. Create a UPS Developer Account

   • Go to the UPS Developer Kit page.

   • Sign up for a UPS Developer account if you don’t already have one.

2. Log in to the Developer Portal

   • Access the UPS Developer Portal.

3. Access UPS APIs

   • Go to https://developer.ups.com/apps

4. Create an Application

   • Create a new application by providing basic information about your store.

5. Get API Keys

   • After the application is created, generate your Client ID and Client Secret.

   • These credentials will be used in your AbanteCart UPS extension settings.

    

Test Connection Button

The Test Connection button allows you to verify that your UPS API credentials are correct before saving or using the extension.

How It Works:

1. Click Test Connection after entering your Account Number, API Client ID, and API Password.

2. The system will send a validation request to the UPS API.

3. A confirmation message will display whether the connection was successful or failed.

Label generation

Create Shipment When Order Status: Determines when the system automatically creates a UPS shipment for an order. When the selected order status is applied, a shipment request is sent to UPS and a label is generated. Choose from your store’s available order statuses (e.g., Processing, Shipped, Completed).

Example Workflow

1. A customer places an order.

2. The store admin updates the order status to Shipped (or the configured trigger status).

3. The UPS extension automatically sends a shipment creation request to UPS using the provided API credentials.

4. A shipping label is generated.

Additional Settings

Packaging Type: What kind of packaging do you use?

Shipper Country & Zone: Enter the two-letter code for your origin state/province.

Shipper City: Enter the name of the origin city.

Shipper Postal Code: - Enter your origin zip/postal code.

Shipper Phone Number (10 digits or more): The phone number associated with the shipper’s UPS account. Must contain 10 digits or more (including country code if applicable). Used for shipment documentation and UPS label details.

Weight Code: Allowed kgs or lbs. Make sure you match the weight class with the UPS accepted weight code.

Length Code: Set to inches or centimeters.

Default Product Dimensions (L x W x H): Default product dimensions (in store units) used when a product does not have its own length specified.

Default Product Weight: Default product weight used when an individual product does not have its weight defined. Ensures shipping rate and label generation still work. Example: 0.5 (kg or lb, depending on store settings)

Tax Class: If you are required to charge tax on this item, set to "Taxable Goods."

Location: Limits the availability of the UPS shipping method in the checkout to specific store locations. All Locations: UPS shipping is available to all destinations supported by your store

Storefront Icon: Shipping Icon to be displayed at checkout shipping selection

Auto Select:  You can set to skip the shipping selection page if there is only one shipping option. This shipping method will be selected automatically

Select to restrict payments: If only specific payment methods are needed for this shipping method, select them here. If nothing is selected, all available payment methods will be shown

Developer Note:

AbanteCart provides an open-source PHP SDK for UPS REST API communication.

You can find it here: https://github.com/abantecart/ups-php

This SDK powers the extension’s UPS connection layer and can also be used independently for custom integrations.