--- updatedAt: 2026-05-27T04:04:04.000Z agentTools: projectIndex: https://transport-freight-management.docs.developers.aeb.com/llms.txt --- # addShipmentAttachments Adds attachments to a shipment (e.g. invoices, origin documents, etc.). # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Carrier Connect HTTP API", "description": "Thank you for using our HTTP API documentation.", "version": "3.0" }, "servers": [ { "url": "https://rz3.aeb.de/demo1cai/rest" } ], "security": [ { "SWAGGER_AUTH_KEY": [] }, { "BASIC_AUTH": [] } ], "tags": [ { "name": "Shipping", "description": "API for the CarrierEngine service" } ], "paths": { "/DLCarrierBFBean/addShipmentAttachments": { "post": { "tags": [ "Shipping" ], "summary": "addShipmentAttachments", "description": "Adds attachments to a shipment (e.g. invoices, origin documents, etc.).", "operationId": "addShipmentAttachments", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DLAddShipmentAttachmentsRequestDTO" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DLAddShipmentAttachmentsRequestDTO" } } } }, "responses": { "default": { "description": "default response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DLAddShipmentAttachmentsResponseDTO" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DLAddShipmentAttachmentsResponseDTO" } } } } }, "security": [ { "BASIC_AUTH": [] } ] } } }, "components": { "schemas": { "TextInLanguageDTO": { "type": "object", "description": "A translated text in one of the specified languages.", "properties": { "languageISOCode": { "type": "string", "description": "

2-letter ISO code of the language.

length=2

", "example": "en" }, "text": { "type": "string", "description": "The translated text.", "example": "Some free-form text" } } }, "DLShipmentReferenceDTO": { "type": "object", "description": "DTO for uniquely identifying a DLShipment within a specific client.", "properties": { "transactionId": { "type": "string", "description": "ID of the corresponding transaction in the client system.
Usually sufficient for identifying a shipment.

length=250

" }, "referenceNumber1": { "type": "string", "description": "Another client system system reference number for the shipment.

length=50

" }, "shipmentNumber": { "type": "string", "description": "The shipment number internally generated by the carrier engine.
Usually sufficient for identifying a shipment.

length=20

" } } }, "DLAddShipmentAttachmentsResponseDTO": { "type": "object", "description": " Response DTO for the addShipmentAttachments business facade method", "properties": { "hasErrors": { "type": "boolean", "description": "

True, if there are any error messages.

An error usually means that the request could not be performed.

Error details are provided in the messages[] array.

", "example": false }, "hasOnlyRetryableErrors": { "type": "boolean", "description": "

True, if there are any error messages.

Error details are provided in the messages[] array.

", "example": true }, "hasWarnings": { "type": "boolean", "description": "

True, if there are any error messages.

Error details are provided in the messages[] array.

", "example": true }, "messages": { "type": "array", "description": "

Error or warning messages at the request level.

There may be additional messages[] arrays at lower data levels as specified in the documentation.

", "items": { "$ref": "#/components/schemas/ResponseMessageDTO" } } }, "xml": { "name": "addShipmentAttachmentsResponseDTO" } }, "ResponseMessageDTO": { "type": "object", "description": "Result messages like errors or warnings.", "properties": { "messageType": { "type": "string", "description": "

Message type

If not stated otherwise, the possible types are:

Maximum length: 50

", "example": "WARNING" }, "messageIdentCode": { "type": "string", "description": "

Optional identification code for further classification of the message type.

Maximum length: 50

", "example": 5627 }, "messageTexts": { "type": "array", "description": "

Detailed message texts in the requested languages.

", "items": { "$ref": "#/components/schemas/TextInLanguageDTO" } }, "indentationLevel": { "type": "integer", "format": "int32", "description": "

The indentation level of the message.

'0' indicates a top level message.

", "example": 0 } } }, "DLAddShipmentAttachmentsRequestDTO": { "type": "object", "description": "Request DTO for the addShipmentAttachments business facade method", "properties": { "clientSystemId": { "type": "string", "description": "

Id of the sending client system.

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

Maximum length: 20

", "example": "TEST_ID" }, "clientIdentCode": { "type": "string", "description": "

Client identification code.

Maximum length: 10

", "example": "APITEST" }, "userName": { "type": "string", "description": "

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.

", "example": "API_TEST" }, "resultLanguageIsoCodes": { "type": "array", "description": "

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.

", "example": [ "en", "de" ], "items": { "type": "string" } }, "shipmentReference": { "$ref": "#/components/schemas/DLShipmentReferenceDTO", "description": "

Reference of the shipment the attachments belong to. Mandatory field.

" }, "mode": { "type": "string", "description": "Manages how the system should react if an attachment already exists. If empty mode 'ADD' will be used. The filter criteria for an existing attachment is the file name and an existing content.

Possible values:

" }, "attachments": { "type": "array", "description": "List of attachments to add.", "items": { "$ref": "#/components/schemas/DLAttachmentDTO" } } }, "required": [ "shipmentReference" ], "xml": { "name": "addShipmentAttachmentsRequestDTO" } }, "DLAttachmentDTO": { "type": "object", "description": "DTO to hold attachment data.", "properties": { "filename": { "type": "string", "description": "File name including a file extension

lenght = 250

." }, "mimeType": { "type": "string", "description": "The MIME type of the document. Possible values:
  1. \"application/pdf\" document is in PDF format
  2. \"printer/raw\" document is in printer language (e.g. ZPL or EPL) and can be directly sent to a printer
  3. \"image/format\" document is a printable image. format can be \"png\", \"jpeg\", etc.

length = 30

" }, "data": { "type": "string", "format": "byte", "description": "Attachment data/content." }, "contentType": { "type": "string", "description": "Attachment type.
Indicates the business content of the document towards the carrier. If empty, the carrier's default is used.

Possible values:

length=32

" } } } }, "securitySchemes": { "SWAGGER_AUTH_KEY": { "type": "apiKey", "name": "X-XNSG_WEB_TOKEN", "in": "header" }, "BASIC_AUTH": { "type": "http", "scheme": "basic" } } }, "x-proxy-enabled": false } ```