Language: Deutsch · English

Nuclet: UPS (not yet available)

Data sheet and documentation entry point for the UPS Nuclet (generating UPS labels and tracking shipments).

CONCEPT INTEGRATORS UPDATED: JUL 2026 APPLIES TO NUCLOS 4.2026.X

On this page

Machine-translated – under review

This page was machine-translated from German as a first draft and is currently under review. The authoritative source remains the German original (see the language switch above).

Releases

Version	Date	Notes	Compatibility
1.0.0	December 2017	First version (in development)	from Nuclos 4.23.3

Overview

The "UPS" Nuclet offers the ability UPS-Labels to generate and thus trigger a shipment via UPS. The parcel is thereby collected from the sender's address.
In addition, it contains a tracking system which records whether a parcel is already in transit or has already been delivered to the destination. You can also cancel requested deliveries.

Optional: the Nuclet is furthermore able to change the status of the business object - to which the UPS label is attached - depending on the status of the delivery.

Note: To use the "UPS" Nuclet you need a UPS-Account and a UPS Access Key. To do so, visit the UPS page for developers and follow steps 1 and 4 under "Getting started".

Integration

Step

Description

1

Download the Extensions listed below that are required for using the Nuclet and copy
them into the subfolder server. Please note the instructions for installing extensions (see Scriptlets#EinenOrdnerextensionsanlegen).

TODO: link WIKI entry Extensions!

2

Import the "UPS" Nuclet (see Nuclet import).

3

Run the job "Initial Dataload UPS" manually (see Job control - checking job execution).
This creates various UPS shipping methods in the business object of the same name business object .

4

Set the integration points, to link the "UPS" Nuclet with your existing system.

Call: Menu -> Configuration -> Integration point -> Start search

In order to use the Nuclet, you must set the following integration points:
Sender address, contact, customer, country, delivery address, delivery note and employee

For this, enter the corresponding target business object attributes (see: Function of an integration point).

Note: If you own the Nuclet: Basisnuclet für Handelsunternehmen , the integration points are set automatically.

5

Enter your UPS account data in the corresponding Nuclet-dependent parameters under "Value".

Call: Menu -> Configuration -> Nuclet Management -> Nuclet "UPS"

Name of the parameter	Note
UPS User ID	You can find your user ID in your account information under "User ID".
UPS Password	This is your password, with which you also log in on the main page of UPS log in
UPS Account Number	You can find the account number in the confirmation email after you have created an account with UPS.
UPS Accesskey	You can find the UPS Access Key in the confirmation email after you have requested it on the UPS page for developers .

Note: With the parameter "UPS Test Environment" you can test the generation of the labels. To do so, enter the value "Y" for the parameter.
This is already set by default. Once you have completed the tests and want to use the service, enter the value "N".

6
(optional)

If you want the Nuclet to change the status of the business object - to which the UPS label is attached -,
then set the necessary Nuclet-dependent parameters.

Name of the parameter	Note
State model name	Name of the status model of the business object, to which the UPS label is attached.
Status for "Ready to send"	Name of the status that should be set before a UPS label is generated and the parcel can be collected.
Status for "In Transit"	Name of the status that should be set when the parcel is being delivered.
Status for "Delivered"	Name of the status that should be set when the parcel has been delivered.

Note: The parameters are set to "null" by default.
Sofern "State model name" is "null", no state transitions take place, regardless of what the other status parameters contain.

7

(optional)

If you wish, you can attach the business object "UPS Label" als Subform to the desired business object .