Table of Contents
UPS
Updated by Colin
UPS is one of the world's largest shipping couriers and is well supported by the ShipStream WMS. With the UPS integration, you can:
- Generate shipping labels for UPS domestic and international parcel services
- Retrieve customs documents or submit paperless invoices for international shipments
- View up-to-date tracking information and generate webhooks for tracking events
- Validate and classify destination addresses
How to Set Up UPS
Getting started with UPS is easy, the steps from a high level are:
- Authorize the integration.
- Add one or more Shipping Accounts.
- Enable and configure the UPS carrier under Shipping Methods.
Step 1 - Authorize the integration
There are three methods of providing authorization for ShipStream to access a UPS account:
- Authorization Code
- Client Credentials
- Legacy Access Keys
The Authorization Code method allows a UPS user to authenticate securely on the UPS website without sharing any credentials to their account. This is the preferred method since it is both easy and more secure.
The Client Credentials method requires the account holder to create an "app" via https://developer.ups.com/ and copy the Client ID and Client Secret to the ShipStream shipping account configuration page or share these credentials with a user who has access to do so.
The Legacy Access Keys method is the method used before 2023 in which the MyUPS username and password of the account holder were copied into the ShipStream shipping account page. This method will no longer be supported beginning June 3, 2024 so it is expected that any accounts using this method on that date will begin to throw errors and must be updated to one of the above methods (preferably well before the EOL date).
If you are using the Authorization Code method (recommended), proceed to step 1-A. Otherwise, proceed to step 1-B for Client Credentials or step 1-C for the Legacy Access Keys method.
Step 1-A - Authorization Code
You will create either a Global Integration or Merchant Integration subscription for UPS and click the Authorize button to complete authorization via the UPS website. Choose a Global Integration if this is your primary account or you are a 3PL and you will be using one UPS.com ID for multiple merchants. Otherwise, choose Merchant Integration to create an authorization that can only be used by a specific merchant.
- Navigate to either System > Integrations > Global Integrations or System > Integrations > Merchant Integrations depending on your needs.
- For Global Integrations click UPS.
- For Merchant Integrations, click Add New Subscription, select the merchant that the account shall belong to, and then click UPS.
- Click Save Subscription.
- Click Authorize and complete the sign-in on the UPS.com pages that follow. You will be redirected back to ShipStream upon completion and the Connection Diagnostics will show the account which successfully authenticated.
Step 1-B - Client Credentials
To use this method, the UPS.com account holder must create a UPS "App".
- Navigate to developer.ups.com and log in with the account that contains the UPS shipper accounts to be used.
- Click My Apps in the top right corner.
- Click Add Apps in the bottom left corner.
- Continue the wizard to complete creating the app, choosing:
- I need API credentials because: I want to integrate UPS technology into my business.
- App Name: <any name recognizable by you, for example, "ShipStream Integration">
- Callback URL: <leave empty>
- Products Included In This App: <select all products for future possibility that ShipStream may utilize them, or minimally the following:>
- Shipping
- Address Validation
- Authorization
- Tracking
- Upon completion, note the Client ID and Client Secret which you will need for Step 2.
Step 2 - Create a Shipping Account
- Add a Shipping Account in ShipStream for each UPS shipper account you wish to use, selecting the appropriate value for Access Key Type based on which route you took for Step 1.
- If you followed Step 1-A, you will choose Authorization Code and then select the integration instance that corresponds to the authorization completed.
- If you followed Step 1-B, you will choose Client Credentials and copy and paste the Client ID and Client Secret to complete the authorization.
- Check the other account configuration options and adjust as needed.
- Click Save Shipping Account.
Step 3 - Enable and configure UPS
- Navigate to System > Configuration > Shipping > Shipping Methods > UPS and change Enabled to Yes.
- Check the other UPS configuration options and adjust as needed.
- Click Save Config.
You are now ready to create shipping labels with your UPS account!