Important
UPS is changing their authentication method from access keys to OAuth and will only accept OAuth authentication from June 3, 2024 onwards. You can use the UPS (OAuth) shipping method with Xentral version 23.15.2 or higher.
You can connect the shipping service provider UPS to Xentral and use it there. This article describes the individual setup points for your successful connection.
A general overview of the shipping methods and parcel labels you can use in Xentral can be found here.
UPS offers you the following features, among others:
-
Modification of parcel stamp via reference fields
-
Use of the cash on delivery service
-
Volume weight calculation
-
Deactivation of address validation
To connect UPS:
Note
If you have multiple old UPS shipping methods you want to migrate, you can first connect a new UPS (OAuth) shipping method as described below and then change the Module in your old UPS shipping methods to UPS(Oauth).
Save and manually enter your information into the new fields. You can try this with a test account before changing one of your active shipping methods.
-
Activate OAuth authentication for your UPS account by following the instructions on the UPS developer website, where you can also log in to activate your account.
-
Go to Settings > Stock > Shipment Labels/ Carrier and click Add Carrier.
-
Select UPS (OAuth).
-
Select Show additional settings and then click Connect next to UPS Oauth Connection. You will be redirected to UPS.
-
Enter your login credentials for UPS and follow their instructions. Afterwards you will be redirected to your Xentral instance. The button next to UPS Oauth Connection now says Info.
To disconnect the interface, click Info and then Revoke authorization.
-
Configure your settings as needed.
Fill in the following fields:
Note
Do not use special characters like & or * in this shipping method as it might lead to errors when creating shipping labels.
-
Designation → Freely select a designation for the shipping method. This is displayed in xentral among others in the order for selection in the drop-down menu
-
Type → Specify the type/field description. You can generally choose this as long as it is not necessary for the store mapping or other mappings. Ideally, you should keep the default setting
-
Module → Select UPS (Oauth) from the drop-down menu
-
Project → Optionally select a project, provided that a separate UPS shipping type is created for each project
-
Active → Check the box to activate the shipping method and make it visible and usable
-
No postage check → By checking this box, no postage check will be performed in the order
-
Printer parcel label → Select from the drop-down menu the default printer that prints the parcel labels
-
Printer Export → Select from the drop-down menu the default printer that prints the export documents
-
Shipping Mail → From the drop-down menu, select the behavior of the shipping mail. "Default behavior" means that a default tracking mail will be sent, "no shipping mail" means that no tracking mail will be sent for this shipping type, and "custom text template" means that a custom shipping confirmation text template will be used for this shipping type, regardless of project and logistics process
-
UPS Oauth Connection → The adjacent button has two functions: If it displays Connect, you can click on it to Connect the UPS interface as described above. If it displays Info, you can click on it to get information about your UPS OAuth account and revoke access to the API, if needed.
-
Account Number → Enter your UPS Account number. You can find it in your UPS account under My profile > Payment options.
-
Sender Name → Enter the name of the sender. This name must match the name in My Profile → My Information → My Addresses
-
Sender contact → Enter the name of the contact person on the sender's side
-
Sender Street → Enter the street of the sender
-
Sender house number → Enter the house number of the sender
-
Sender postal code → Enter the postal code of the sender
-
Sender city → Enter the city of the sender
-
Sender state → Enter the state of the sender
-
Sender Country → Enter the country of the sender using the two-digit ISO 3166-1 code, e.g. DE for Germany.
-
Sender e-mail → Enter the e-mail address of the sender
-
Sender phone → Enter the phone number of the sender
-
Sender Internet → Enter the website of the sender
-
Sender tax ID → Enter the tax ID of the sender
-
Default weight → Enter the default weight of your shipments. This will appear in the shipping dialog
-
Length → Enter the length of your standard items in cm
-
Width → Enter the width of your standard items in cm
-
Height → Specify the height of your standard items in cm
-
Standard Service Code → Enter the standard service code from the customer portal, e.g. "11"
Note
If you are using multiple UPS products with different service codes, you need to create a separate shipping method for each code.
Here is a list of the most common service codes:
-
Express = 07
-
Expedited = 08
-
UPS Standard = 11
-
Express Plus = 54
-
UPS Saver = 65
-
UPS Express 12:00 = 74
You can find a list of all service codes in the UPS developer documentation by expanding the Service section.
-
-
Standard Service Description → Enter the standard service description from the customer portal, e.g. "UPS Standard"
-
Standard Package Code → Enter the standard package code from the customer portal, e.g. "02"
-
Standard Package Description → You can enter the standard package description freely, e.g. "Customer Supplied"
-
Reference to Label 1 → Enter the text that appears on the package label. Optionally use the variables {Delivery note}, {Order}, {PROJECT}, {YOUR ORDER NUMBER} and {INTERNET}
-
Reference to Label 2 → Enter the text that appears on the package label. Optionally use the variables {Delivery note}, {Order}, {PROJECT}, {YOUR ORDER NUMBER} and {INTERNET}
-
Volume weight → By ticking, the volume weight is calculated from the dimensions and transferred
-
Deactivate address validation → By checking this box you deactivate the address validation by UPS, i.e. the address will not be checked by UPS
-
Export reason → Enter the export reason. You have to enter this reason only for foreign shipments.
Valid values for this field are: SALE, GIFT, SAMPLE, RETURN, REPAIR, INTERCOMPANYDATA, Any other reason. You can find further information in the UPS developer documentation. If you leave this field empty, SALE is entered automatically as the Export reason when a shipment is exported.
-
Logging → Check this box to log the output and response in an XML file, the file is located in the userdata/tmp folder
-
Apply tracking → If checked, the tracking number will be automatically inserted into the field after creating the parcel label and does not need to be scanned from the parcel label anymore
-
ZPL as output format → If this option is activated, the package label will be requested in ZPL format instead of PDF . ZPL (Zebra Programming Language) is a specific file format for Zebra printers. Important: ZPL files do not have a file ending by default and cannot be opened manually because they are directly processed by the label printer. If you want to check the content of a ZPL file, you can do so with a so-called ZPL Viewer (available online).
-
UPS Sandbox (test mode) → By checking this box you can test the package label printing with the UPS Sandbox. SAMPLE" will be printed on the package label
-
UPS Quantum View Notify → By checking this box you can use the UPS arrival notification
When finished, click Save at the bottom right.
As soon as you have made all settings as described above, you can test the package mark printing in the shipping center or also in a single delivery bill. To do this, select the shipping type "UPS" from the drop-down menu in the "Delivery bill" tab of the delivery bill.
Click on the "Save" button before navigating to the parcel tag dialog.
Click on the "Shipping label" tab in the delivery bill, enter yourself as the recipient and print a parcel label for the items contained via "Print shipping label".
If you want to use the cash on delivery service, you can activate it by checking the "Cash on delivery" box.
After your test print has been completed, you can cancel the parcel stamp in the UPS business customer portal.
Note
When shipping abroad, you must fill in the Name, Name3 (c/o) and Phone fields.
Make sure that the Do not hand the phone number over to the shipping company check box in the GDPR settings section is NOT selected under Settings > Set up your system > System settings.
The following error messages might appear when using the shipping method:
-
The request is not well formed - Some of your information in the shipping method contains at least one special character (e.g., & or *). Please check if your username, password, or other information contain special characters and remove them.
-
Missing or invalid ShipTo PhoneNumber Code: 120209 - This error message occurs, when there are problems with the provided phone number. There are two possible reasons for this:
-
The phone number is incorrect in some way (e.g., too short) or missing.
-
The phone number can't be transferred because of your GDPR settings.
Go to Settings > Set up your system > System settings and make sure that the Do not hand the phone number over to the shipping company check box in the GDPR settings section is NOT selected.
-
-
failed to refresh oauth token - Your authentication was rejected by UPS. This error can be fixed by renewing your authentication in the following way: