UPS by Worldwide Express

For merchants shipping from the United States, ShipStation supports connecting your UPS account through Worldwide Express (WWEX), allowing you to access your negotiated UPS shipping rates and create domestic and international shipping labels directly through ShipStation API.

Worldwide Express is an authorized UPS reseller. Your negotiated rates are managed by Worldwide Express and reflected in real time when you get rates in ShipStation API.

This guide provides developers with the details needed to build UPS by Worldwide Express shipping capabilities into your ShipStation API workflows.

NOTE:

Billing

For billing questions, please contact Worldwide Express support directly. Worldwide Express invoices you directly for shipments. There is no reconciliation process required within ShipStation API, and labels are not charged at the time of creation.

The following fields are required to establish a connection with Worldwide Express:

Contact Worldwide Express support to locate your account credentials in your account portal.

• Weight is required to create any label.
• Ship from country: United States only
• Ship to countries: Determined by the UPS service selected
• International shipping is supported. All necessary customs documents are generated automatically and returned via the API.

NOTE:

Your Carriers Add-On

🇺🇸 For US-based ShipStation accounts, certain plans require you to enable the Your Carriers add-on before connecting carrier accounts. If you have not yet enabled it, you will be prompted to do so.

You can connect a UPS by Worldwide Express account using the POST method to the /v1/connections/carriers/ endpoint, or via the ShipStation API Dashboard.

carrier_name: wwex_parcel

POST /v1/connections/carriers/:carrier_name

POST /v1/connections/carriers/wwex_parcel HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json

{
  "nickname": "My Worldwide Express Account",
  "client_id": "your_client_id",
  "client_secret": "your_client_secret"
}

A successful connection will return a response with the carrier_id, which you'll use for any requests for this account going forward.

1. Go to Settings > Shipping > Carriers and select Add Carrier.
2. Enter Worldwide Express in the search field and select the Worldwide Express tile.
3. Enter your account nickname and your Worldwide Express account credentials.
4. Click Connect.

Your Worldwide Express account will appear under the Your Carrier Accounts tab once successfully connected.

UPS by Worldwide Express supports rate shopping with ShipStation API. Your negotiated rates are configured and managed by Worldwide Express and are reflected automatically in ShipStation API rate responses in real time. No additional setup is required within ShipStation API to access your negotiated rates.

All services available through this integration are UPS services routed via the Worldwide Express platform. Merchants have access only to the service types returned for their specific WWEX account.

To inquire about eligibility for specific services, contact Worldwide Express directly.

Domestic return labels are supported. When a return label is requested, both the outbound and return labels are generated together in a single response. Return labels are only available in combination with the corresponding forward shipment label.

Review the Return Labels page for details on creating return labels with ShipStation API.

UPS by Worldwide Express supports the following carrier package types:

UPS by Worldwide Express supports adding insurance to your shipments through UPS's standard insurance offerings. Review the Parcel Insurance page for details on adding shipment insurance with ShipStation API.

• Label sizes: Standard UPS label sizes
• Label formats: Standard UPS label formats

Contact Worldwide Express support for details on custom label message support.

UPS by Worldwide Express supports creating multi-package shipments with ShipStation API.

Contact Worldwide Express support for details on label branding support.

UPS by Worldwide Express supports voiding labels with ShipStation API.

Individual labels can be voided through ShipStation API. Bulk voiding is not supported. Standard UPS voiding rules apply — refer to UPS guidelines for time limits and eligibility.

Contact Worldwide Express support for details on paperless label support.

All required customs and international shipping documents are generated and returned automatically by the API for international shipments.

Both Signature and Adult Signature confirmation types are available for applicable services.

See our Delivery Confirmation page for more details about using the confirmation property.

UPS by Worldwide Express supports certain advanced options, which you can add to the shipment object when creating a shipment or label.

• DDP (Delivered Duty Paid): Bill duties and taxes to the payor of shipping. See Bill Duties & Taxes for details.
• Tax Identifiers: Support for shipper, consignee, and sold-to tax identifiers. See Tax Identifier Numbers for details.

NOTE: Shipping hazardous materials is not supported through this integration.

To ensure you always have the most up-to-date information about Worldwide Express's advanced options, use the list carrier options call.

UPS by Worldwide Express does not require end-of-day manifesting. ShipStation API submits all shipment data electronically at the time of label creation. No end-of-day process, manifesting, or PLD form is necessary.

Contact Worldwide Express support for details on pickup scheduling capabilities.

NOTE: Pickup cancellation is not supported through ShipStation API. If you need to cancel a scheduled pickup, please contact UPS directly.

UPS by Worldwide Express does not currently support shipping to service points via ShipStation API.

All shipments include a 1Z UPS tracking number for end-to-end tracking. Tracking is available for both domestic and international shipments.

ShipStation API's integration with UPS by Worldwide Express supports receiving tracking updates. Review our Track a Package guides for details on tracking with ShipStation API.

NOTE: Webhook-based push tracking updates are not supported through this integration.

See the Disconnect section in our Delete a Carrier page for the process of deleting or disconnecting a carrier from ShipStation API.

NOTE:

If you disconnect a carrier account and reconnect it, the account will have a new carrier_id in ShipStation API.