createShipment

post

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

Creates a shipment with the data specified in the shipment request.
An error will be returned when the shipment exists already.
Optionally various operations like label preparation and label output can be applied on the shipment. A complete processing including the pickup assignment is also possible.
The operations are handled asynchronously, so 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

required

Controls how to create the shipment.

shipment

object

required

The data necessary to create the shipment.

processParms

object

required

Controls how to process the shipment after it has been created.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

defaultdefault response