processItem

post

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

Allows to perform operations on an existing item.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request DTO for the processItem business facade method.

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

itemReference

object

Reference to the item to be processed.

itemUpdateData

object

Item update data. The field may be empty when the item should not be updated. Notably, the item can be updated even if it is already (partially) packed into a package. The caller is responsible for ensuring that the item data is not changed in a way that leads to inconsistencies.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

defaultdefault response