UPS integration¶

UPS is a shipping carrier service that integrates with Odoo to coordinate shipping to all regions. Once integrated, users can create shipping methods that estimate shipping costs and generate labels.

UPS account setup¶

To get started, go to the UPS website and click the Log In button in the top-right corner to log in or create a UPS account.

After logging in, click the profile icon in the top-right corner, and select Accounts and Payment from the drop-down menu.

Show how to navigate to the "Accounts and Payment" page from the home screen.

On the Accounts and Payment Options page, two accounts must be configured: an Odoo shipment account and a payment card.

Shipping account¶

To add an Odoo shipment account, select Add New Account from the Add a Payment Method drop-down menu, and click Add.

Display "Add an account" option from the drop-down menu.

On the next screen, labeled Open a Shipping Account, complete the forms to configure the shipping account type (e.g. Business) and if any regulated items will be shipped. Then finish the remaining three steps in the wizard to Add Addresses, Verify Identity, and Explore Discounts, with the last option being optional.

When complete, submit the application on the last page of the wizard to finish setting up the shipping account.

Display UPS form to fill out company shipping information.

Get account number¶

With the shipping account set up, the UPS Account Number becomes available. To access it, navigate to Profile ‣ Accounts and Payment and refer to the shipping account’s Number field.

Show Account "Number" field for the shipping account.

Payment card¶

Navigate back to the Accounts and Payments page and select the Add Payment Card option from the Add a Payment Method drop-down menu. Then, complete the form to add the credit card information.

UPS developer account setup¶

Next, log into the UPS developer account to generate the developer key. To begin, click the profile icon in the top-right corner, and choose the Apps option from the drop-down menu.

Add app¶

Then, click the Add Apps button to begin filling out the form. In the I need API credentials because * field, select I want to integrate UPS technology into my business.

Under the next label, Choose an account to associate with these credentials. *, select Add existing account from the drop-down menu in the corresponding field, and then select the account number linked to the UPS account created in the previous step.

Show form to fill in the UPS account number.

Click Next, and proceed to the Add App form, and fill out the fields:

App Name: Type the name to identify the app by.
Callback URL: Type the URL of the Odoo database, in the format: https://databaseName.odoo.com. Do not include www in the URL.

In the Add Products section on the right, search for and click the + (plus) icon to add the following products to the app:

Authorization (O Auth): Used to generate the authorization token to request information from the UPS API.
Address Validation: Validates addresses at the street level in the United States and Puerto Rico.
Locator: Enables search for UPS shipping locations based on type and available services.
Paperless Documents: Enables the upload of document images to link to shipments.
Shipping: Enables UPS shipping services, such as preparing packages for shipment, managing returns, and canceling scheduled shipments.
Rating: Compare delivery services and shipping rates.

Finally, click Save and accept UPS’s terms and conditions.

Client ID and Client Secret¶

With the new app created, in the Profile ‣ My Apps ‣ App page, select the app from the Credentials section to view the UPS credentials.

Show newly created app in the "My Apps" section.

In the Credentials section, copy the Client ID and Client Secret key.

Display the "Client ID" and "Client Secret" key.

Setup in Odoo¶

With the credentials obtained, configure the UPS shipping method in Odoo by going to Inventory app ‣ Configuration ‣ Shipping Methods.

On the Shipping Methods page, click the New button.

Note

For existing UPS shipping methods whose Provider is UPS Legacy, archive it and create a new shipping method using UPS.

In the Provider field, select UPS. Doing so reveals the UPS Configuration tab, where various fields must be entered. For details instructions on configuring the other fields on the shipping method, refer to the Configure third-party carrier documentation.

In the UPS Configuration tab, complete the following fields:

UPS Account Number: (required) Get the account number from the UPS portal.
UPS Client ID: (required) Get the Client ID from the UPS developer website.
UPS Client Secret: (required) Get the Client Secret key from the UPS developer website.
UPS Service Type: Select from the drop-down menu the type of shipping service.
UPS Package Type: (required) Select from the drop-down menu the package type that is supported for the shipping service.
Package Weight Unit: The unit of measure for the package weight.
Package Size Unit: The unit of measure for the package dimensions.
Label Format: Choose the label format shipping labels: PDF, ZPL, EPL, or SPL.

Show the "UPS Configuration" tab on the Shipping Methods form.

In the Options section, the following features are available:

Bill My Account: Charge the user’s UPS account for shipping in the eCommerce app.
Collect on Delivery: Collect payment from customers for shipping after the shipment is delivered.
Generate Return Label: Print the return label for the order after the delivery order is validated.
Duties paid by: Select whether duties or other fees are charged to the Sender or Recipient of the order.