processPackage

post

https://rz3.aeb.de/demo1cai/rest/DLCarrierBFBean/processPackage

Allows to perform various operations on an existing package. Especially document preparation and document (label) output can be triggered.
When the request is specified to handle the operations asynchronously, operation processing errors and label documents are not part of the response. They can be retrieved with a further processPackage call, a syncShipments or getShipments call.

Body Params

clientSystemId

string

Id of the sending client system.

e.g. Installation ID of the sending host or ERP system.

Maximum length: 20

clientIdentCode

string

Client identification code.

Maximum length: 10

userName

string

User who initiated the request from the client system.

If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.

If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.

Actual authentication is handled separately via the request's headers, so no password is required in the request's data.

resultLanguageIsoCodes

array of strings

2-letter ISO codes of the languages in which texts will be returned.

English ('en') and German ('de') are typically supported by default. Other languages may be supported.

Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.

resultLanguageIsoCodes

packageReference

object

required

The package to be processed.

processParms

object

required

The operations to be performed on the referenced package.

targetShipmentReference

object

A package can be moved to a different shipment. The operationMode "MOVE_PACKAGE" must be used.

masterPackageReference

object

Referencing the corresponding master package in the client system.

items

array of objects

The items to be added to the package or to be modified. The field may be empty when only processing is required.

items

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

defaultdefault response