processPickup

post

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

Prints or reprints the manifest documents for the pickup. Mainly to be used, when manifest documents were not printed with the createPickup call or if a reprint of the documents is necessary.

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

pickupReference

object

required

The pickup containing the manifest documents to print or return in response.

creationParms

object

Only relevant if the field 'shipments' is filled. Controls how the shipments are handled that should be added to the pickup.

pickupUpdateData

object

Pickup update data. The field may be empty when the pickup should not be updated.

shipments

array of objects

Shipments to be added to the pickup.

shipments

processParms

object

required

Controls how to process the pickup, especially the handling of the manifest documents.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

defaultdefault response