processShipment

post

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

Allows to add packages or perform various operations on an existing shipment. 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 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

creationParms

object

Controls how to create the new packages of the shipment. The field may be empty when no packages are specified in field 'packages'.

shipmentReference

object

required

Reference of the shipment to be processed. Mandatory field.

shipmentTotals

object

Shipment totals. The field may be empty.

shipmentUpdateData

object

Shipment update data. The field may be empty when the shipment should not be updated.
Unlike the data in field 'shipmentTotals', this field contains information that may influence pickup handling and EDI content.

packages

array of objects

The packages to be added to the shipment. The field may be empty when only processing is required and no new packages are to be added to the shipment.

packages

packageCumulations

array of objects

The package cumulations to be added to the shipment. The field may be empty when only processing is required and no new package cumulations are to be added to the shipment.

packageCumulations

items

array of objects

The items to be added to the shipment. The field may be empty when only processing is required and no new items are to be added to the shipment.

items

referencesTexts

array of objects

Further references and texts for the shipment. Multiple references or texts with same type are allowed (e.g. to specify all different delivery note numbers contained in the shipment).

referencesTexts

transportEquipments

array of objects

The transport equipments to be added to the shipment. The field may be empty when only processing is required and no new transport equipments are to be added to the shipment.

transportEquipments

processParms

object

required

The operations to be performed on the referenced shipment.

carrierInfoTexts

array of objects

Carrier info texts for the shipment.

carrierInfoTexts

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

defaultdefault response