UPS

UPS

Go to Extensions → Shippings → UPS.

The UPS shipping extension integrates United Parcel Service with your AbanteCart store. It displays live UPS rates at checkout, generates shipping labels from the admin, and offers domestic and international delivery options.

To offer UPS to your customers you need an active UPS account. The connection uses OAuth (REST API). The older UPS Access Key (XML API) is not supported.

Account number

Account (Shipper) Number: your UPS account number, used for billing and shipment processing. New customers usually receive it during sign-up. If you do not have it on hand, log in to your UPS account, open Account Information or Billing, and copy the number shown there. UPS sales can also confirm it for you.

API credentials

API Client ID and API Password (Client Secret) authenticate the extension's calls to UPS. Find them in the Credentials section of your application in the UPS Developer Portal. Keep the Client Secret private.

Obtain UPS API credentials

  1. Create a UPS Developer account. Sign up on the UPS Developer Kit page if you do not already have one.

  2. Sign in to the Developer Portal at the UPS Developer Portal.

  3. Open the apps area at developer.ups.com/apps.

  4. Create an application by providing basic information about your store.

  5. Copy the API keys (Client ID and Client Secret) generated for the application. Paste them into the AbanteCart UPS extension settings.

Test Connection

The Test Connection button validates the credentials before going live. It sends an authentication request to UPS using the configured Account Number, API Client ID and API Password, and shows whether the call succeeded.

If Test Connection fails with "The state is not supported in the Customer Integration Environment", the issue is your test address rather than your keys. The UPS CIE accepts fewer regions than production; change the Shipper Country & Zone and Shipper Postal Code to an address that your UPS account supports, or switch Test mode off and retry against production.

Connection settings

Test mode: switch between UPS production and the Customer Integration Environment (sandbox). Turn this off to return live rates and create real shipments.

Address Validation: when on (default), UPS validates the destination address before returning rates. Leave it on unless you are deliberately working around an address-validation failure.

Shipper address

UPS rates and labels are generated from the address you ship parcels from. Fill in:

  • Shipper Country & Zone: country (and state/region) you ship from. Picked from AbanteCart's built-in zones list.

  • Shipper Address: street address.

  • Shipper City: city name.

  • Shipper Postal Code: ZIP or postal code of the origin.

  • Shipper Phone Number: 10 digits or more, including country code if applicable. Used on UPS labels and shipment documentation.

Defaults are taken from System → Settings → Store Details and can be overridden here per extension instance.

Label generation

Create Shipment when Order Status becomes: when an admin moves an order into the selected status, the extension calls the UPS Ship API, creates the shipment, and stores the tracking number and label link on the order. Choose any of your store's order statuses (for example, Processing, Shipped, or Completed).

Typical workflow

  1. A customer places an order.

  2. The store admin moves the order to the configured trigger status (for example, Shipped).

  3. The extension sends a shipment-creation request to UPS using the saved API credentials.

  4. A shipping label is generated and the tracking link appears on the order.

If label creation fails, confirm the shipping address is complete and valid, then check the AbanteCart error log for the UPS error message.

Packaging and dimensions

Packaging: the parcel type sent to UPS. The extension currently offers Box as the packaging type.

Weight Code: the unit UPS receives in rate and label requests. Allowed values are Pounds, and Kilograms. Match this to a unit supported in your shipper country (for the USA, use Pounds).

Length Code: the linear unit. Allowed values are Inches and Centimeters. For the USA, use Inches.

Default Product Dimensions (Length, Width, Height): values used when a product does not declare its own dimensions.

Default Product Weight: used when a product does not declare its own weight (for example, 0.5).

UPS rates depend on real package size and weight. Set the weight and dimensions on every product you intend to ship with UPS; otherwise, rate quotes and label files may be inaccurate.

Storefront display and standard settings

Tax Class: tax class applied to the shipping charge. Choose Taxable Goods if you need to charge tax on shipping.

Location: restrict UPS to one or more store Locations. All Locations makes UPS available everywhere your store reaches.

Storefront Icon: shipping icon shown next to the UPS rate at checkout. Replace it if you prefer your own image.

Auto Select: skip the shipping selection page when only one shipping option is available; UPS is selected automatically.

Select to restrict payments: limit the payment methods offered when a customer chooses UPS at checkout. Leave empty to show every available payment method.

For developers

AbanteCart maintains an open-source PHP SDK for UPS REST API communication at github.com/abantecart/ups-php. It powers the extension's UPS connection layer and can be reused for custom integrations.

AbanteCart, all rights reserved. 2025 ©