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 that you can use in Xentral can be found here.
UPS offers the following features:
-
Modification of the parcel label via reference fields
-
Use of the service Cash on delivery
-
Calculation of volumetric weight
-
Disabling the address validation
Follow these steps to connect UPS:
Note
If you have several old UPS connections that you want to migrate to UPS (OAuth), you can first connect a new UPS (OAuth) shipping method as described below, then change the module to UPS(Oauth) in your old UPS shipping method.
Save and manually enter your information in the new fields, you can test this with a trial account before changing any of your active shipping methods.
-
Enable OAuth authentication with UPS by following the instructions on the UPS developer website. You can log in directly to the UPS developer website and activate your account for OAuth there.
-
Navigate to Settings > Warehouse > Package Marks and click Add Package Mark.
-
Select UPS (OAuth).
-
If necessary, click Show additional settings, and then click Connect next to Ups Oauth Connection. You will be redirected to UPS.
-
Enter your UPS login details and follow the instructions. You will then be redirected back to your Xentral instance. The button next to Ups Oauth Connection will now display the word Info.
To disable the interface, click Info, and then click on Revoke authorization.
-
Carry out your settings as needed.
Fill in the following fields:
Note
Do not use special characters such as & or * in this shipping method, as this can lead to errors when creating the parcel label.
-
Designation → Freely select a description for the shipping method. This will be displayed in Xentral e.g. in the order for selection in the drop-down menu
-
Type → Specify a type. You can generally choose this as you like, unless it is required for shop mapping or other mappings. Ideally, however, you keep the default
-
Module → Select UPS (OAuth) from the drop-down menu
-
Project → Optionally select a project, provided a separate UPS shipping method is created for each project
-
Active → By checking, you activate the shipping method and make it visible and usable
-
No postage check → Checking does not perform a postage check on behalf
-
Printer parcel label → Select the default printer that prints the parcel labels from the drop-down menu
-
Printer export → From the drop-down menu, select the default printer that prints the export papers
-
Shipping mail → Set the rules for sending shipping notifications to your customers by email as soon as the shipment is on its way. The following three options are available to you: Default behavior: The logistics settings from the project are used. These settings can be set in the Settings > Basic Settings > Projects > Open Project > Tab: Settings > Tab: Logistics / Shipping. In the Level 1 (Pick/Pick) and Level 2 (Pack) areas, you define the steps called Email, where your customers are informed of the status of order processing. No shipping mail: For this shipping method, no shipping information is sent by email. Custom text template: For this shipping method, the selected text template is sent by email. You must create this template in advance in the Settings > Basic Settings > Documents > Text Templates menu, then select the desired template from the Text Template drop-down menu. This selection does not use the project logistics settings for this shipping method.
-
Oops Oauth Connection → The button next to it has two functions: if it shows Connect, click it to connect the interface as described in the Connecting the UPS interface section. If it shows info, you can click to get information about your UPS OAuth account and revoke access to the API if necessary.
-
Account number → Enter your UPS account number, which can be found in your UPS account under My Profile > Payment Options
-
Sender Name → Enter the name of the sender, which must match the name under My Profile → My Information → My Addresses
-
Sender Contact Person → Enter the name of the contact person on the side of the sender
-
Sender Street → Enter the street of the sender
-
Sender House number → Enter the house number of the sender
-
Sender Postcode → Enter the sender's postcode
-
Sender Location → Enter the location of the sender
-
Sender State → Enter the state of the sender
-
Sender Country → Enter the country of the sender as a two-digit ISO 3166-1 code, e.g. DE for Germany.
-
Sender Email → Enter the email address of the sender
-
Sender Phone → Enter the sender's phone number
-
Sender Internet → Enter the sender's website
-
Sender Tax ID → Enter the tax ID of the sender
-
Default weight → Specify the default weight of your shipments. This will appear in the shipping dialog
-
Adjust weight in → To create the shipping label, an accurate calculation of the total weight of the shipment including packaging material is required. For Xentral, the shipment weight is automatically calculated in the background by adding the total weight of the items contained in the order. With the present option, a weight you specify is added to this weight. This creates a total value for the shipping declaration, which is taken into account when creating the shipping label and is automatically reported to UPS. Decide whether the additional weight of the packaging material should be expressed in kg or Xentral. Use the following setting called Adjust weight To define the extra weight more precisely.
-
Adjust weight to → Use this setting to specify your details for the Adjust weight in setting. Enter the additional weight of the shipment in kilograms or percent depending on the previous selection. Which calculation method and specific values you choose depends on the packaging type of your products and the packaging materials you use.
-
Length → Specify the length of your standard shipments in cm
-
Width → Specify the width of your standard shipments in cm
-
Height → Specify the height of your standard shipments in cm
-
Standard Service Code → Enter the standard service code from the customer portal, e.g. 11
Note
If you use multiple UPS services with different service codes, you must create a separate shipping method for each code.
The following list contains the most commonly used 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 collapsing 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 freely assign the Standard Package Description, e.g. Customer Supplied
-
Reference 1 on Label → Enter the text that appears on the parcel label. Optionally, use a variable {DELIVERY NOTE}, {ORDER}, {PROJECT}, {YOUR ORDER NUMBER}, and {INTERNET}. Note that only one variable may be entered in the field.
-
Reference 2 on Label → Enter the text that appears on the parcel label. Optionally, use a variable {DELIVERY NOTE}, {ORDER}, {PROJECT}, {YOUR ORDER NUMBER}, and {INTERNET}. Note that only one variable may be entered in the field.
-
Volume weight → By activating this option, the volume weight is calculated from the measurements and transferred
-
Deactivate address validation → Checking disables address validation by UPS, i.e. the address is not verified by UPS
-
Export reason → Enter the export reason. You only need to enter this reason for shipments abroad.
Valid values for this field are: SALE, GIFT, SAMPLE, RETURN, REPAIR, INTERCOMPANYDATA, Any other reason. See the UPS developer documentation for more information. If you leave this field blank, SALE will automatically be entered as the export reason.
-
Logging → Checking logs the output and response in an XML file. The file can be found in the userdata/tmp folder
-
Save trackingn number to sales order → Checking automatically inserts the tracking number into the field after creating the shipping label and no longer requires scanning by the shipping label
-
ZPL as the output format → Checking requests the package label in ZPL format, not as PDF. ZPL (Zebra Programming Language) is a special file format for Zebra label printers. Important: ZPL files do not receive an extension by default and cannot be opened manually because they are intended for direct processing by the label printer. If you want to check the contents of a ZPL file, you can do so with a so-called ZPL Viewer (available online).
-
UPS Sandbox (Test Mode) → By checking the box, you can test the shipping label printing with the UPS Sandbox and then SAMPLE is printed on the package mark
-
UPS Quantum View Notify → Activate this option to use UPS arrival prediction
Finally, click on Save at the bottom right.
Once you have carried out all settings, you can test the parcel label printing in the shipping center or in an individual delivery note. Go to the delivery note and select the shipping method UPS from the corresponding drop-down menu in the Delivery note tab:
Click on Save before navigating to the parcel label dialog.
Afterwards, click on the Parcel label tab in the delivery note and print a shipping label for the included items using the Print parcel label button.
If you want to use the Cash on delivery service, you can activate it by checking the COD box.
After your test print is complete, you can cancel the parcel label in the UPS Business Customer Portal.
Note
When shipping abroad, you must fill in the Name, Name3 (c/o) and Phone fields.
Under Settings > Set up your system > System settings in the GDPR Settings area, make sure that there is NO check mark for phone not handed over to the shipping company.
The following error messages may occur when using the shipping method:
-
The request is not well formed - Some of your data in the shipping method contains at least one special character (e.g. & or *). Please check if your username, password or other data contains special characters and remove them.
-
Missing or invalid ShipTo PhoneNumber Code: 120209 - This error message occurs when there are problems with the specified phone number.
-
The phone number is incorrect (e.g. too short) or missing in some way.
-
The phone number cannot be transferred due to your GDPR settings.
Under Settings > Set up your system > System settings in the GDPR Settings area, make sure that there is NO check mark for phone not handed over to the shipping company.
-
-
failed to refresh oauth token - Your authentication was rejected by UPS. You can resolve this error by renewing your authentication as follows: