You can also 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:
-
Test printing of parcel mark via sandbox
-
Modification of parcel stamp via reference fields
-
Use of the cash on delivery service
-
Volume weight calculation
-
Deactivation of address validation
In the following section you will find information about how the connection of the UPS interface to xentral works and where you can find which data.
In the first step, log in to your UPS account with your credentials by following this link: UPS Login
Navigate to the tab "Services" and select "Integrate UPS Technology".
Then click on "UPS Developer KIT".
Navigate to "Shipping API" and then to "Download APIs":
This will take you to the following view. Click here on "Step 4: Request an access key".
This access key corresponds to the API key in xentral, which must be stored in the shipping method.
Note
UPS may not allow special characters in a password, including an asterisk (*). If you have problems connecting for this reason, please change your password or contact UPS.
To use UPS as a shipping method in xentral, you must first create a new shipping method. To do this, create a new shipping method under Administration → Settings → Shipping methods → Overview → "+NEW" → UPS.
Fill in the following fields:
-
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" 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
-
API User → Enter the API user, this corresponds to your UPS portal credentials
-
API Password → Enter the API password, this corresponds to your UPS portal credentials
-
API Key → Enter the API Key from the customer portal
-
Account Number → Enter your UPS account number. You can find it 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
-
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. "011"
-
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
-
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 → By ticking, the package label will be requested in ZPL instead of PDF
-
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, Name2 and Phone fields.
