syncShipments or getShipments call.
operationId: createShipment_1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DLCreateShipmentRequestDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLCreateShipmentRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/DLCreateShipmentResponseDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLCreateShipmentResponseDTO'
security:
- BASIC_AUTH: []
/DLCarrierBFBean/deleteItem:
servers:
- url: https://rz3.aeb.de/test2bsm/rest
post:
tags:
- Shipping
summary: deleteItem
description: Deletes an existing item. Packages containing items remain in the shipment and can be packed again with processShipment. Deleting a item is not always possible. It mainly depends on the status of the package containing the item and the shipment.
operationId: deleteItem
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DLDeleteItemRequestDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLDeleteItemRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/DLDeleteItemResponseDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLDeleteItemResponseDTO'
security:
- BASIC_AUTH: []
/DLCarrierBFBean/deletePackage:
servers:
- url: https://rz3.aeb.de/test2bsm/rest
post:
tags:
- Shipping
summary: deletePackage
description: Deletes an existing package. Packed items remain unpacked in the shipment and can be packaged again with processShipment. Deleting a package is not always possible. It mainly depends on the status of the package and the shipment.
operationId: deletePackage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DLDeletePackageRequestDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLDeletePackageRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/DLDeletePackageResponseDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLDeletePackageResponseDTO'
security:
- BASIC_AUTH: []
/DLCarrierBFBean/deletePickup:
servers:
- url: https://rz3.aeb.de/test2bsm/rest
post:
tags:
- Shipping
summary: deletePickup
description: 'Cancels an existing pickup. All shipments are removed from the pickup and must be assigned to a new pickup by another createPickup call.processPackage call, a syncShipments or getShipments call.
operationId: processPackage
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DLProcessPackageRequestDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLProcessPackageRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/DLProcessPackageResponseDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLProcessPackageResponseDTO'
security:
- BASIC_AUTH: []
/DLCarrierBFBean/processPackageReturnEnclosedLabel:
servers:
- url: https://rz3.aeb.de/test2bsm/rest
post:
tags:
- Shipping
summary: processPackageReturnEnclosedLabel
description: Returns a return enclosed label in case of a return shipment.
operationId: processPackageReturnEnclosedLabel
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DLProcessPackageReturnEnclosedLabelRequestDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLProcessPackageReturnEnclosedLabelRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/DLProcessPackageReturnEnclosedLabelResponseDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLProcessPackageReturnEnclosedLabelResponseDTO'
security:
- BASIC_AUTH: []
/DLCarrierBFBean/processPickup:
servers:
- url: https://rz3.aeb.de/test2bsm/rest
post:
tags:
- Shipping
summary: processPickup
description: 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.
operationId: processPickup
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DLProcessPickupRequestDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLProcessPickupRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/DLProcessPickupResponseDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLProcessPickupResponseDTO'
security:
- BASIC_AUTH: []
/DLCarrierBFBean/processShipment:
servers:
- url: https://rz3.aeb.de/test2bsm/rest
post:
tags:
- Shipping
summary: processShipment
description: Allows to add packages or perform various operations on an existing shipment. Especially document preparation and document (label) output can be triggered.syncShipments or getShipments call.
operationId: processShipment
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DLProcessShipmentRequestDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLProcessShipmentRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/DLProcessShipmentResponseDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLProcessShipmentResponseDTO'
security:
- BASIC_AUTH: []
/DLCarrierBFBean/syncPickups:
servers:
- url: https://rz3.aeb.de/test2bsm/rest
post:
tags:
- Shipping
summary: syncPickups
description: Allows the synchronization of client system transactions with the engine pickups. By the use of a syncId it is possible to return only pickups that have changed between two syncPickups calls.
operationId: syncPickups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DLSyncPickupsRequestDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLSyncPickupsRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/DLSyncPickupsResponseDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLSyncPickupsResponseDTO'
security:
- BASIC_AUTH: []
/DLCarrierBFBean/syncShipments:
servers:
- url: https://rz3.aeb.de/test2bsm/rest
post:
tags:
- Shipping
summary: syncShipments
description: Allows the synchronization of client system transactions with the engine shipments. By the use of a syncId it is possible to return only shipments that have changed between two syncShipments calls.
operationId: syncShipments
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DLSyncShipmentsRequestDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLSyncShipmentsRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/DLSyncShipmentsResponseDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLSyncShipmentsResponseDTO'
security:
- BASIC_AUTH: []
/DLCarrierBFBean/updateCustomsData:
servers:
- url: https://rz3.aeb.de/test2bsm/rest
post:
tags:
- Shipping
summary: updateCustomsData
description: Updates customs data for one existing shipment. Updates data on shipment and item level. Updates customs relevant data only.
operationId: updateCustomsData
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DLUpdateCustomsDataRequestDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLUpdateCustomsDataRequestDTO'
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/DLUpdateCustomsDataResponseDTO'
application/xml:
schema:
$ref: '#/components/schemas/DLUpdateCustomsDataResponseDTO'
security:
- BASIC_AUTH: []
/DLCarrierBFBean/validateShipment:
servers:
- url: https://rz3.aeb.de/test2bsm/rest
post:
tags:
- Shipping
summary: validateShipment
description: Validates a shipment with the data specified in the shipment request.length=20
parameter: type: string description: An (optional) parameter for the info text.length=512
description: DTO specifying a carrier's info text for a shipment. DLGetAllCarriersRequestDTO: type: object 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 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"]' description: Request DTO to retrieve the codes and names of all available carriers for a client. xml: name: getAllCarriersRequestDTO DLPackageCumulationRequestDataDTO: required: - numberOfPackages - packageTypeIdentCode type: object properties: numberOfPackages: type: integer description: The number of packages.length=3
format: int32 packageTypeIdentCode: type: string description: IdentCode of the package type. Valid values are depending on the client's package types in the master file data.length=20
packageSpecificeContents: type: string description: The content description of the package. If left empty, the content description supplied in field 'contents' on shipment level will be used for this package.length=250
weight: $ref: '#/components/schemas/QuantityDTO' volume: $ref: '#/components/schemas/QuantityDTO' loadingMeters: type: number description: The loading meters needed for the packages.length=10, scale=3
palletPlaces: type: number description: The pallet places needed for the packages.length=10, scale=3
description: DTO for package cumulation data. DLAddShipmentAttachmentsRequestDTO: required: - shipmentReference type: object 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 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"]' shipmentReference: $ref: '#/components/schemas/DLShipmentReferenceDTO' 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:
Unique number of EDI message.
length = 25
ediDescription: type: string description:Description of the EDI message (and of the EDI setup).
length = 500
carrierEDINumber: type: string description:Number uniquely identifying the EDI message for carrier.
length = 50
isManifested: type: boolean description:Indicates that the EDI message has been transmitted to the carrier.
isManifestedWithErrors: type: boolean description:Indicates that an error occurred while transmitting the EDI message.
isManifestedWithWarnings: type: boolean description:Indicates that warnings occurred while transmitting the EDI message. However, the EDI message has been accepted by the carrier. The reasons for the warnings should be corrected during the next transmissions.
unconfirmedErrorCode: type: string description:If an error occurred while transmitting the EDI message and an error code was available, it is return in this field.
length = 10
unconfirmedMessage: type: string description:If an error occurred while transmitting the EDI message, its message is returned in this field.
length = 999
ediSetupIdentCode: type: string description:Unique identifier of the EDI definition.
length = 20
boStatus: $ref: '#/components/schemas/ComboboxEntryDTO' numberOfShipmentsInEDI: type: integer description:The number of shipping orders contained in the EDI message.
format: int32 shipmentReferences: type: array description:The shipments included in the EDI message.
items: $ref: '#/components/schemas/DLShipmentReferenceDTO' description: Response-DTO for an EDI message for a pickup. DLShipmentItemReferenceTextUCDDTO: type: object properties: type: type: string description: 'The type of the reference number or text. Valid values are:
length=30
' value: type: string description: The value of the reference number or text.length=500
description: DTO for reference numbers and texts of a certain (predefined) type. This is the same DTO like DLShipmentItemReferenceTextDTO, but supports fewer types. DLShipmentCreationParmsDTO: required: - creationMode type: object properties: creationMode: type: string description: 'Controls the creation of the shipment and/or it''s packages as a transaction in the carrier engine. This is necessary for further processing like label printing or EDI generation. Valid values are:
cancelShipment call and retransmitted with a createShipment call. The cancel step is necessary because a direct retransmission of existing shipments and packages is not allowed. Mandatory field.length=15
' description: Creation parameters for a shipment. Specifies when and how to create a shipment or it's packages. DLAttachmentDTO: type: object properties: filename: type: string description: File name including a file extensionlenght = 250
. mimeType: type: string description: 'The MIME type of the document. Possible values:format" document is a printable image. format can be "png", "jpeg", etc. length = 30
' data: type: string description: Attachment data/content. format: byte contentType: type: string description: 'Attachment type.Possible values:
length=30
' description: DTO to hold attachment data. DLValidateShipmentRequestDTO: required: - shipment - validationParms type: object 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 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"]' shipment: $ref: '#/components/schemas/DLShipmentRequestDataDTO' validationParms: $ref: '#/components/schemas/DLShipmentValidationParmsDTO' description: DTO class for shipment validation request data. xml: name: validateShipmentRequestDTO DLCancelShipmentRequestDTO: required: - processParms - shipmentReference type: object 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 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"]' shipmentReference: $ref: '#/components/schemas/DLShipmentReferenceDTO' processParms: $ref: '#/components/schemas/DLShipmentCancelParmsDTO' description: Request DTO for the cancelShipment business facade method xml: name: cancelShipmentRequestDTO DLContainerDataDTO: type: object properties: verifiedGrossMass: $ref: '#/components/schemas/QuantityDTO' verificationMethod: type: string description: 'Method for verifying the gross mass of the container. Valid values are:length=8
' verificationContactName: type: string description: Name of the person responsible for determining and passing on the VGM.length = 35
description: DTO containing data for container package types. DLProcessPackageRequestDTO: required: - packageReference - processParms type: object 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 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"]' packageReference: $ref: '#/components/schemas/DLPackageReferenceDTO' processParms: $ref: '#/components/schemas/DLPackageProcessParmsDTO' targetShipmentReference: $ref: '#/components/schemas/DLShipmentReferenceDTO' masterPackageReference: $ref: '#/components/schemas/DLMasterPackageReferenceDTO' items: type: array description: The items to be added to the package or to be modified. The field may be empty when only processing is required. items: $ref: '#/components/schemas/DLShipmentItemReferenceDTO' updateData: $ref: '#/components/schemas/DLProcessPackageUpdateRequestDataDTO' description: Request DTO for the getPackageDocuments business facade method. xml: name: processPackageRequestDTO DLPickupReferenceDTO: type: object properties: transactionId: type: string description: The transaction id of the pickup given by the client system.length=250
referenceNumber1: type: string description: Another client system system reference number for the pickup.length=50
pickupNumber: type: string description: The number of the pickup given by the carrier engine.length=20
description: DTO for uniquely identifying a shipment pickup within a client. DLPackageOperationModeDTO: required: - mode type: object properties: mode: type: string description: 'The operation mode for the operation to be performed on the package. Valid values are:
length=15
' description: 'Holds a special operation ID to be performed on the package. NOTE: this function has BETA status.' DLPackageRequestDataDTO: required: - grossWeight - packageTransactionId - packageTypeIdentCode type: object properties: packageTypeIdentCode: type: string description: IdentCode of the package type. Valid values are depending on the client's package types in the master file data.length=20
packageSpecificeContents: type: string description: The content description of the package. If left empty, the content description supplied in field 'contents' on shipment level will be used for this package.length=250
packageNumber: type: integer description: The serial number of the package within the shipment. This number is mainly used to sort the packages in lists or in business logic (e.g. to detect the "first" package as master package).length=5
format: int32 packageTransactionId: type: string description:The shipment wide unique id for the package. Is included in the response.
length=50
referenceNumber1: type: string description: Package reference number. Is included in the response.length=50
referenceNumber2: type: string description: Second package reference numberlength=50
extCarrierPackNum: type: string description: The external carrier tracking number of the packagelength=50
extCarrierPackNumBasic: type: string description: The basic external carrier tracking number of the packagelength=50
extCarrierPackNumReturn: type: string description: The external carrier return tracking number of the packagelength=50
extCarrierPackNumBasicReturn: type: string description: The basic external return carrier tracking number of the packagelength=50
grossWeight: $ref: '#/components/schemas/QuantityDTO' dimensions: $ref: '#/components/schemas/DLCuboidDimensionsDTO' alternativeVolume: $ref: '#/components/schemas/QuantityDTO' codValue: $ref: '#/components/schemas/AmountOfMoneyDTO' insuranceValue: $ref: '#/components/schemas/AmountOfMoneyDTO' additionalValues: $ref: '#/components/schemas/GenericDataRecordDTO' containedItems: type: array description: The items the package contains. Only item references are used here, the items themselves must already exist. An error will be returned, when one of the referenced items does not exist.length=50 stackability: type: string description: 'The possibility to stack packages. Valid values are:
length=10
nmfcSubCode: type: string description: The NMFC subcode of the package. Relevant for US carriers.length=2
loadingMeters: type: number description: The loading meters needed for the package.length=10, scale=3
palletPlaces: type: number description: The pallet places needed for the package.length=10, scale=3
description: DTO for package data. DLCancelShipmentResponseDTO: type: object 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' description: Response DTO for the cancelShipment business facade method xml: name: cancelShipmentResponseDTO DLCarrierListItemDTO: type: object properties: identCode: type: string description: The identCode of the entry.length=50
descriptions: type: array description: The description of the entry in the requested result languages. items: $ref: '#/components/schemas/TextInLanguageDTO' carrierType: type: string description: 'The carrier type assigns the carrier to a category that defines the support and maintenance level. Possible values:
length=20
' imprint: type: string description: The official company name (corporate name) of the carrier according to homepage. name: type: string description: Name of carrier. description: Minimum carrier info to use in lists. DLSyncShipmentsRequestDTO: type: object 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 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"]' ageInDays: type: integer description:Initializes the delta transmission of shipments (syncId must be null). Only shipments with this age or younger will be synchronized. Relevant date is the shipping date.
If this field is 0, synchronization starts with all shipments.
length=10
format: int32 syncId: type: string description:For delta-transmissions after initialization (ageInDays must be null).
Fill this field with the DLSyncShipmentsResponseDTO.syncId returned in the last call of syncShipments. As initial value use 0 or 1.
length=20
includeDocuments: type: boolean description: Controls, if the (label) documents should be included in the response. Default is 'false'. description: Request DTO for shipment synchronization. xml: name: syncShipmentsRequestDTO DLReferenceTextDTO: type: object properties: type: type: string description: 'The type of the reference number or text. Valid values are:
length=15
' value: type: string description: The value of the reference number or text.length=500
description: DTO for reference numbers and texts of a certain (predefined) type. DLSignatureDTO: type: object properties: text: type: string description: Driver's signature text.length=50
image: type: string description: Driver's signature image. format: byte mimetype: type: string description: The mimetype of the drivers signature image e.g. image/jpeg or image/png.length=250
description: DLSignatureDTO containing driver's signature data DLShipmentTotalsRequestDataDTO: type: object properties: numberOfPackagesExpected: type: integer description: 'The expected number of packages. Used to print the total number of packages on the label when documents are printed before all packages are available.length=5
' format: int32 grossWeightExpected: $ref: '#/components/schemas/QuantityDTO' loadingMeters: type: number description: The loading meters needed for the shipment. When left empty, the sum of the values specified in request field 'packageCumulations' will be used whereever the loading meters are needed on shipment level.length=10, scale=3
palletPlaces: type: number description: The pallet places needed for the shipment. When left empty, the sum of the values specified in request field 'packageCumulations' will be used whereever the pallet places are needed on shipment level.length=10, scale=3
description: DTO for shipment totals in a request. DLGetCarrierPropertiesRequestDTO: required: - carrierIdentCode type: object 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 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"]' carrierIdentCode: type: string description: Code uniquely referencing the requested carrier.length=20
description: Request DTO to retrieve various properties for a specific carrier. xml: name: getCarrierPropertiesRequestDTO DLDocumentOutputModeDTO: required: - mode type: object properties: mode: type: string description: 'The output mode for the documents. Valid values are:
length=15
' includeDocumentId: type: boolean description:Only relevant for mode RETURN. Controls, if the document ID (field DLDocumentDTO#documentId) should be filled. Defaults to "false".
includeContent: type: boolean description:Only relevant for mode RETURN. Controls, if the document content (field DLDocumentDTO#content) should be filled. Use this setting if you only need reference data of the documents but not the actual content. Defaults to "true".
description: DTO specifying the output mode for documents. DLAdditionalValueDTO: type: object properties: identCode: type: string description: The identCode of the entry.length=50
descriptions: type: array description: The description of the entry in the requested result languages. items: $ref: '#/components/schemas/TextInLanguageDTO' businessObjectClass: type: string description: 'The business object class the additional value belongs to. Possible values are:
length=10
' dataType: type: string description: 'The data type of the field. Possible values are:
length=10
' description: Information about an additional value defined for a carrier. DLProcessModeDTO: required: - mode type: object properties: mode: type: string description: 'The mode in which the operation is processed. Valid values are:
length=10
' description: DTO specifying the mode in which an operation is processed. DLPackageProcessingResultDTO: type: object properties: hasErrors: type: boolean description: True, if there are any error messages. If an error has occured the messages contain more details about the errors. hasWarnings: type: boolean description: True, if there are any warning messages. messages: type: array description: Messages for the whole request, e.g. for errors or warnings.The shipment wide unique id for the package (as specified in the request) the result is for.
length=50
referenceNumber1: type: string description: Another package reference number (as specified in the request) the result is for.length=50
carrierPackageNumber: type: string description: The package number given by the carrier. Usually the tracking number.length=50
carrierPackageNumberReturn: type: string description: The additional return tracking number given by the carrier, if the data for the possible return shipment are to be generated with the initial shipping data.length=50
carrierTrackingURL: type: string description: The tracking URL of the package.length=512
carrierTrackingURLReturn: type: string description: The additional return tracking URL of the package.length=512
carrierPackageIdentBarcode: type: string description: 'The content of the barcode identifying the package as defined by the carrier. The carrierPackageNumber is most likely part of the carrierPackageIdentBarcode and for same carrier it is identical. However, this depends solely on the carriers'' specification. NOTE: this is currently in BETA phase and only supported for a very small number of carriers.length=50
' documents: type: array description: The documents for the package. Only filled when asked for in request (documentOutputMode). items: $ref: '#/components/schemas/DLDocumentDTO' description: DTO holding result information of a package processing.syncShipments call.
DLShipmentProcessParmsDTO:
required:
- doCompletion
- documentOutputMode
- documentOutputScope
- documentPrepareScope
- processMode
- workstationId
type: object
properties:
processMode:
$ref: '#/components/schemas/DLProcessModeDTO'
documentPrepareScope:
$ref: '#/components/schemas/DLDocumentScopeDTO'
workstationId:
type: string
description: The workstation used to detect the printer for which the documents should be prepared, printed or returned.
An error will be returned when the package documents (labels) are already prepared (invoked by a previous call) and are now be be printed with a different workstationId containing an incompatible printer.
length=50
documentOutputScope: $ref: '#/components/schemas/DLDocumentScopeDTO' documentOutputMode: $ref: '#/components/schemas/DLDocumentOutputModeDTO' doCompletion: type: boolean description: 'true' or '1' = The shipment is set in status "Complete". In this status the shipment is sealed, it cannot be changed, no packages can be added anymore. The shipment is automatically assigned to a pickup or can be manually assigned, depending on the customizing.
It is required, that the documents for each package are prepared. When they are not prepared yet, the field documentPrepareScope must be set accordingly, otherwise an error is returned.
Not printed documents (labels) can be printed after completion with the processShipment call.
'false' or '0' = The shipment is left open, further packages can be added with the processShipment call. If the shipment has already been completed, nothing is done.
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' carrierNames: type: array description: Codes and names of all available carriers. items: $ref: '#/components/schemas/DLCarrierPortfolioNameDTO' description: Response DTO containing the codes and names of all available carriers. xml: name: getCarrierPortfolioNamesResponseDTO DLCreatePickupRequestDTO: required: - creationParms - pickup - processParms type: object 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 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"]' creationParms: $ref: '#/components/schemas/DLPickupCreationParmsDTO' pickup: $ref: '#/components/schemas/DLPickupRequestDataDTO' processParms: $ref: '#/components/schemas/DLPickupProcessParmsDTO' description: Request DTO for the processPickup business facade method xml: name: createPickupRequestDTO ComboboxEntryDTO: type: object properties: identCode: type: string description: The identCode of the entry.length=50
descriptions: type: array description: The description of the entry in the requested result languages. items: $ref: '#/components/schemas/TextInLanguageDTO' description: For common use in BF methods which return combobox entries, e.g. for a list of master file data. DLDeletePickupResponseDTO: type: object 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' description: Response DTO for the cancelPickup business facade method xml: name: deletePickupResponseDTO DLUpdateCustomsDataResponseDTO: type: object 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' description: Response DTO for the updateCustomsData business facade method xml: name: updateCustomsDataResponseDTO DLPackageResponseDataDTO: type: object properties: hasErrors: type: boolean description: True, if there are any error messages. If an error has occured the messages contain more details about the errors. hasWarnings: type: boolean description: True, if there are any warning messages. messages: type: array description: Messages for the whole request, e.g. for errors or warnings.length=4
format: int32 packageTransactionId: type: string description: The unique transaction id of the package maintained by the client system.length=50
referenceNumber1: type: string description: The first reference number of the package.length=50
referenceNumber2: type: string description: The second reference number of the package.length=50
carrierPackageNumber: type: string description: The package number given by the carrier. Usually the tracking number.length=50
carrierPackageIdentBarcode: type: string description: 'The content of the barcode identifying the package as defined by the carrier. The carrierPackageNumber is most likely part of the carrierPackageIdentBarcode and for same carrier it is identical. However, this depends solely on the carriers'' specification. NOTE: this is currently in BETA phase and only supported for a very small number of carriers.length=50
' carrierPackageNumberReturn: type: string description: The additional return tracking number given by the carrier, if the data for the possible return shipment are to be generated with the initial shipping data.length=50
carrierTrackingURL: type: string description: The tracking URL of the package.length=512
carrierTrackingURLReturn: type: string description: The additional return tracking URL of the package.length=512
packageTypeIdentCode: type: string description: IdentCode of the package type. Valid values are depending on the client's package types in the master file data.length=20
contents: type: string description: The description of the contents (goods) the package contains.length=250
dimensions: $ref: '#/components/schemas/DLCuboidDimensionsDTO' grossWeight: $ref: '#/components/schemas/QuantityDTO' codValue: $ref: '#/components/schemas/AmountOfMoneyDTO' insuranceValue: $ref: '#/components/schemas/AmountOfMoneyDTO' boStatus: $ref: '#/components/schemas/ComboboxEntryDTO' additionalValues: $ref: '#/components/schemas/GenericDataRecordDTO' documents: type: array description: The documents for the package. Only filled when asked for in request. items: $ref: '#/components/schemas/DLDocumentDTO' hazardousGoodsData: $ref: '#/components/schemas/DLPackageHazardousGoodsDataResponseDTO' marks: type: string description: Marks and numbers for identification of a package.length=50 stackability: type: string description: 'The possibility to stack this package. If there is no such information, the value will be empty. Otherwise the possible values are:
length=10
nmfcSubCode: type: string description: The NMFC subcode of the package. Relevant for US carriers.length=2
description: DTO for response information of a DLPackage.length=50
descriptions: type: array description: The description of the entry in the requested result languages. items: $ref: '#/components/schemas/TextInLanguageDTO' isoCode: type: string description: 'The isoCode of the Country.length=2
' name: type: string description: 'The name of the Country.length=50
' description: Response information about the supported countries from a carrier DLShipmentFilterDTO: type: object properties: carrierIdentCode: type: string description: The unique code of the carrier.length=50
shippingPtNameOrNumber: type: string description: Considers the company number and the name of the shipping point address.length=50
consigneeName: type: string description: Considers the company number and the name of the consignee's address..length=50
shippingDateFrom: type: string description: Shipping date of the shipment in the format 'yyyy-MM-dd' or 'yyyyMMdd'. The shipping date is expected to be in time zone 'UTC'.length=10
format: date-time shippingDateTo: type: string description: Shipping date of the shipment in the format 'yyyy-MM-dd' or 'yyyyMMdd'. The shipping date is expected to be in time zone 'UTC'.length=10
format: date-time isNotCompleted: type: boolean description: Controls, if only completed respectively not completed shipments should be considered. boStatusIdentCode: type: string description: 'The shipment''s current status. Possible values are:
length=7
referenceNumber: type: string description: Considers shipment reference number 1 and reference number 2.length=50
carrierNumber: type: string description: Considers the carrier tracking number of the shipment or the package.length=50
maxShipments: type: integer description: The maximum number of shipments to be returned. If no value is specified, a default of 100 is assumed.length=4
format: int32 description: DTO to set a filter for a shipment query. DLReferenceTextUCDDTO: type: object properties: type: type: string description: 'The type of the reference number or text. Valid values are:
length=15
' value: type: string description: The value of the reference number or text.length=500
description: DTO for reference numbers and texts of a certain (predefined) type. DLShipmentUpdateRequestDataDTO: type: object properties: shippingDate: type: string description: The new shipping date of the shipment in the format 'yyyy-MM-dd' or 'yyyyMMdd'. The shipping date is expected to be in timezone 'UTC'.length=10
fixedDate: type: string description: The new fixed date of the shipment in the format 'yyyy-MM-dd' or 'yyyyMMdd'. The fixed date is expected to be in timezone 'UTC'.length=10
codValue: $ref: '#/components/schemas/AmountOfMoneyDTO' insuranceValue: $ref: '#/components/schemas/AmountOfMoneyDTO' goodsValue: $ref: '#/components/schemas/AmountOfMoneyDTO' customsValue: $ref: '#/components/schemas/AmountOfMoneyDTO' invoiceValue: $ref: '#/components/schemas/AmountOfMoneyDTO' customsRegistrationNumber: type: string description: Update registration number (MRN, etc.) of the customs declaration. deprecated: true transportRegistrationNumber: type: string description: Update transport registration number like EKAER (Hungary) or SENT (Poland). deprecated: true shopId: type: string description: Update the ID of the shop to which the shipping order is sent. deprecated: true shipToServicePointID: type: string description: Update the ID of the service point at which the consignee can pick up his shipping order. shipFromServicePointID: type: string description: Update the ID of the service point at which the shipper can deliver the shipping order for the carrier to pick up. remark: type: string description: Update internal remark of the shipment. airline: type: string description: Update the airline company of the shipment. flightNumber: type: string description: Update the airline flight number of the shipment. masterAirwaybillNumber: type: string description: Update the master airwaybill number of the shipment. houseAirwaybillNumber: type: string description: Update the house airwaybill number of the shipment. portOfLoadingCode: type: string description: The code of the port or airport where the goods are loaded. portOfLoading: type: string description: The name of the port or airport where the goods are loaded. portOfDischargeCode: type: string description: The code of the port or airport where the goods are unloaded. portOfDischarge: type: string description: Update the name of the port or airport where the goods are unloaded. additionalValues: $ref: '#/components/schemas/GenericDataRecordDTO' extCarrierShipNum: type: string description: Update the external carrier tracking number of the shipment. bulkMasterReferenceNumber1: type: string description: Update the referenceNumber1 if the shipment is a bulk master. description: DTO for shipment fields which can be updated after the initial creation of the shipment DLCreateShipmentRequestDTO: required: - creationParms - processParms - shipment type: object 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 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"]' creationParms: $ref: '#/components/schemas/DLShipmentCreationParmsDTO' shipment: $ref: '#/components/schemas/DLShipmentRequestDataDTO' processParms: $ref: '#/components/schemas/DLShipmentProcessParmsDTO' description: Request DTO for the createShipment business facade method xml: name: createShipmentRequestDTO DLDocumentScopeDTO: required: - scope type: object properties: scope: type: string description: 'The scope of documents to be processed (prepared or printed). Valid values are:
length=20
' description: DTO specifying the scope of documents to be processed. DLCarrierBusinessDivisionDTO: type: object properties: identCode: type: string description: The identCode of the entry.length=50
descriptions: type: array description: The description of the entry in the requested result languages. items: $ref: '#/components/schemas/TextInLanguageDTO' description: Response information about the supported business Divisions from a carrier DLShipmentItemReferenceUCDDTO: type: object properties: itemTransactionId: type: string description: The number of the client system uniquely referencing an item in a shipment.length=50
referenceNumber1: type: string description: Another item reference number. May be used, when an item was not created by the client system and therefore has noitemTransactionId. If both fields are filled, they both must match the item. length=50
description: DTO for uniquely identifying an item within a shipment. NamedGenericDataRecordDTO: type: object properties: name: type: string description: The name of this record, i.e. the role the record plays in the enclosing record.length=15, scale=2
currencyIso: type: string description: The three letter ISO code of the currency of the amount of money.length=3
description: An amount of money with a value and an currency ISO code. DLPickupCreationParmsDTO: required: - creationMode type: object properties: creationMode: type: string description: ' Controls the creation of the pickup (if a new pickup is to create) and the handling of the shipments that should be assigned to it.
The basic requirement for a pickup to be created is that the header data (like carrier, shipping date etc.) is filled correctly. The creationMode controls how to deal with the pickup''s shipments. Valid values are:
processPickup call. Mandatory field.length=30
' description: Creation parameters for a shipment. Specifies when and how to create a pickup and the shipment it contains. DLProcessPickupResponseDTO: type: object 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' documents: type: array description: The documents (manifests) of the pickup. Only filled, when specified indocumentOutputMode of request.
items:
$ref: '#/components/schemas/DLDocumentDTO'
description: Response DTO for the printDocumentsForPickup business facade method
xml:
name: processPickupResponseDTO
DLPickupProcessParmsDTO:
required:
- doManifest
- documentOutputMode
- workstationId
type: object
properties:
doManifest:
type: boolean
description: 'true' or '1' = The shipment pickup is manifested. That means, that EDI data is sent to the carrier and the pickup is sealed, it cannot be changed, no shipments can be added or removed anymore.
'false' or '0' = The shipment pickup is left open, no EDI data is sent to the carrier yet, shipments can be added or removed using the GUI. If the pickup has already been manifested, nothing is done.
documentOutputMode: $ref: '#/components/schemas/DLDocumentOutputModeDTO' workstationId: type: string description: The workstation where the documents should be printed out in the case of direct printing.length=50
description: Process parameters for a pickup. Especially controls the handling of the manifest documents. DLProcessPackageReturnEnclosedLabelResponseDTO: type: object 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' documents: type: array description: The return labels for the package. Only filled when asked for in request (documentOutputMode). items: $ref: '#/components/schemas/DLDocumentDTO' description: Response DTO for the processPackageReturnEnclosedLabel business facade method xml: name: processPackageReturnEnclosedLabelDTO DLMasterPackageReferenceDTO: required: - packageTransactionId type: object properties: packageTransactionId: type: string description: The number of the client system uniquely referencing a master shipment package.length=50
description: DTO for uniquely identifying a master package. DLPickupFilterDTO: type: object properties: carrierIdentCode: type: string description: The unique code of the carrier.length=50
shippingPtNameOrNumber: type: string description: Considers the company number and the name of the shipping point address.length=50
shippingDateFrom: type: string description: Shipping date of the pickup in the format 'yyyy-MM-dd' or 'yyyyMMdd'. The shipping date is expected to be in timezone 'UTC'.length=10
format: date-time shippingDateTo: type: string description: Shipping date of the pickup in the format 'yyyy-MM-dd' or 'yyyyMMdd'. The shipping date is expected to be in timezone 'UTC'.length=10
format: date-time isClosed: type: boolean description: Controls, if only closed respectively not closed pickups should be considered. isManifested: type: boolean description: Controls, if only manifested respectively not manifested pickups should be considered. isWithError: type: boolean description: Controls, if only pickups with errors or without errors should be considered. isNotCompletedPattern: type: boolean description: Controls, if only completed respectively not completed pickups should be considered. boStatusIdentCode: type: string description: 'The pickup''s current status. Possible values are:
length=20
referenceNumber: type: string description: Considers pickup reference number 1 and reference number 2.length=50
transactionId: type: string description: Considers the ID uniquely referencing the corresponding pickup in the client system.length=250
transactionLabel: type: string description:Considers the human readable text which identifies the pickup business transaction in the client system (not necessarily unique).
length=250
maxPickups: type: integer description: The maximum number of pickups to be returned. If no value is specified, a default of 100 is assumed.length=4
format: int32 description: DTO to set a filter for a pickup query. DLGetCarrierPortfolioDetailsRequestDTO: type: object 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 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"]' carrierIdentCodes: type: array description: List of carriers for which the detailed information is requested. The valid codes can be retrieved with function 'getCarrierPortfolioNames'. If no list is supplied, all existing carriers will be returned. items: type: string description: List of carriers for which the detailed information is requested. The valid codes can be retrieved with function 'getCarrierPortfolioNames'. If no list is supplied, all existing carriers will be returned. description: Response DTO for carrier properties for all carriers xml: name: getCarrierPortfolioDetailsRequestDTO DLCarrierExtendedInfosDTO: type: object properties: identCode: type: string description: The identCode of the entry.length=50
descriptions: type: array description: The description of the entry in the requested result languages. items: $ref: '#/components/schemas/TextInLanguageDTO' carrierUrl: type: string description: 'The Url of the Carrier from the Carrier-website. Possible values are:
length=150
' webLogo: type: string description: 'The WebLogo of the carrier from the Carrier-website. Possible values are:
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' shipmentNumber: type: string description: The shipment number internally generated by the carrier engine.length=20
carrierShipmentNumber: type: string description: The carrier tracking number of the shipment. Only filled in case process mode is 'EXTENDED'.length=50
carrierShipmentNumberReturn: type: string description: The additional return tracking number given by the carrier, if the data for the possible return shipment are to be generated with the initial shipping data. Only filled in case process mode is 'EXTENDED'.length=50
carrierTrackingURL: type: string description: The tracking URL of the shipment.length=512
carrierTrackingURLReturn: type: string description: The additional return tracking URL of the shipment.length=512
bulkMasterShipmentNumber: type: string description: The internally generated shipment number of the bulk master if applicable. Must be used to access the bulk master shipment e.g. for adding packages, etc.length=20
collectionBookingNumber: type: string description: The booking number of a requested collection booking assigned from carrier to this shipment.length=20
packageResults: type: array description: The results on package level. Some fields are only filled in case process mode is 'EXTENDED'. items: $ref: '#/components/schemas/DLPackageProcessingResultDTO' accountInfo: $ref: '#/components/schemas/DLShipmentAccountInfoResponseDataDTO' documents: type: array description: The documents of the shipment. Only filled, when specified indocumentOutputMode of request and shipment documents for printing exist.
items:
$ref: '#/components/schemas/DLDocumentDTO'
description: Response DTO for the createShipment business facade method
xml:
name: createShipmentResponseDTO
DLPackageReturnEnclosedLabelProcessParmsDTO:
required:
- returnEnclosedLabelOutputMode
- workstationId
type: object
properties:
workstationId:
type: string
description: The workstation used to detect the printer for which the labels should be prepared, printed or returned.
An error will be returned when the package documents (labels) are already prepared (invoked by a previous call) and are now be be printed with a different workstationId containing an incompatible printer.
length=50
returnEnclosedLabelOutputMode: $ref: '#/components/schemas/DLReturnEnclosedLabelOutputModeDTO' description: Process parameters for a package enclosed return label. Specifies which operations have to be performed on a package return enclosed label. DLValidateShipmentResponseDTO: type: object 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' validationResult: type: string description: '"VALIDATION_OK" or any of the other constants to indicate the result of the validation.' description: 'Possible Result Values: VALIDATION_FAILED VALIDATION_OK VALIDATION_REQUEST_NOT_SUPPORTED VALIDATION_MISSING_DATA VALIDATION_NO_CHECK_SELECTED VALIDATION_EXECUTION_ERROR' xml: name: validateShipmentReponseDTO DLShipmentReferenceDTO: type: object properties: transactionId: type: string description: ID of the corresponding transaction in the client system.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.length=20
description: DTO for uniquely identifying a DLShipment within a specific client. DLPackageHazardousGoodsDataResponseDTO: type: object properties: hazardousGoodsType: type: string description: "Indicates the type of hazardous goods packaged in the package. Possible values are:length=2, scale=1
description: Holds hazardous goods data concerning the package. DLUpdateCustomsDataRequestDTO: required: - shipmentReference type: object 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 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"]' shipmentReference: $ref: '#/components/schemas/DLShipmentReferenceDTO' customsShipmentData: $ref: '#/components/schemas/DLUpdateCustomsShipmentRequestDataDTO' customsItemData: type: array description: Item data. The field may be empty when there's no need to update any existing item. Only customs fields for items are supported. items: $ref: '#/components/schemas/DLUpdateCustomsItemRequestDataDTO' customsReferencesTexts: type: array description: 'Updates references and texts data. The field may be empty when there''s no need to update any references and texts. This update deletes all existing references with the types included in this request from the shipment and adds the references and texts from the request to the shipment. Remember: All references of every reference type included in this request will be deleted! Only customs relevant references and texts are accepted. Therefore the following reference types are allowed only:The output mode for the return enclosed label. Valid values are:
length=15
' description: DTO specifying the output mode for return enclosed labels. ResponseMessageDTO: type: object 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 description:The indentation level of the message.
'0' indicates a top level message.
format: int32 example: 0 description: Result messages like errors or warnings. DLShipmentValidationParmsDTO: required: - validationMode type: object properties: validationMode: type: string description: 'The validation mode of the shipment. The different modes must be separated by ''|'' if more than one mode wants to be used, at the same time. Valid values are:
length=4
format: int32 itemTransactionId: type: string description: The unique transaction id of the item maintained by the client system.length=50
referenceNumber1: type: string description: The first reference number of the item.length=50
referenceNumber2: type: string description: The second reference number of the item.length=50
boStatus: $ref: '#/components/schemas/ComboboxEntryDTO' customsTariffNumber: type: string description: The customs tariff number of the shipping item's contents.length=11
description: type: string description: The shipping item's description.length=250
exportLicense: type: string description: Export license.length=50
countryOfOriginsISOCode: type: string description: Country of origins.length=2
certificateOfOrigins: type: string description: Certificate of origins.length=50
quantity: $ref: '#/components/schemas/QuantityDTO' netWeight: $ref: '#/components/schemas/QuantityDTO' grossWeight: $ref: '#/components/schemas/QuantityDTO' customsValue: $ref: '#/components/schemas/AmountOfMoneyDTO' goodsValue: $ref: '#/components/schemas/AmountOfMoneyDTO' despatchProcedureIdentCode: type: string description: 'The despatch procedure. When filled, possible values are:
length=10
' despatchProcedureNames: type: array description: The names of the despatch procedure in the requested result languages. items: $ref: '#/components/schemas/TextInLanguageDTO' referencesTexts: type: array description: Further references texts of the item. items: $ref: '#/components/schemas/DLShipmentItemReferenceTextDTO' additionalValues: $ref: '#/components/schemas/GenericDataRecordDTO' hazardousGoodsItems: type: array description: Hazardous goods items. items: $ref: '#/components/schemas/DLHazardousGoodsItemResponseDataDTO' description: DTO for shipment item data in a response. DLShipmentTotalsResponseDataDTO: type: object properties: numberOfPackages: type: integer description: The exact number of packages of the shipment. This value only is available when the shipment has been completed, so that the number of packages is known for sure.length=5
format: int32 numberOfPackagesExpected: type: integer description: 'The expected number of packages entered by user or ERP system Used to print the total number of packages on the label when documents are printed before all packages are available. Note: Should not be changed after the first label is printed. Otherwise the data on the label will be inconsistent.length=5
' format: int32 grossWeight: $ref: '#/components/schemas/QuantityDTO' grossWeightExpected: $ref: '#/components/schemas/QuantityDTO' loadingMeters: type: number description: The loading meters needed for the shipment. This value is only reliable when the shipment has been completed, so that all packages are known for sure.length=10, scale=3
palletPlaces: type: number description: The pallet places meters needed for the shipment. This value is only reliable when the shipment has been completed, so that all packages are known for sure.length=10, scale=3
description: DTO for shipment totals in a request. DLShipmentResponseDataDTO: type: object properties: hasErrors: type: boolean description: True, if there are any error messages. If an error has occured the messages contain more details about the errors. hasWarnings: type: boolean description: True, if there are any warning messages. messages: type: array description: Messages for the whole request, e.g. for errors or warnings.length=20
transactionId: type: string description:ID uniquely referencing the corresponding business transaction in the client system.
length=250
organizationUnitClientSystem: type: string description: Additional criteria two separate different organisational units within one Engine's client.length=255
shipmentNumber: type: string description: The shipment number internally generated by the carrier engine.length=20
carrierShipmentNumber: type: string description: The carrier tracking number of the shipment.length=50
carrierShipmentNumberReturn: type: string description: The additional return tracking number given by the carrier, if the data for the possible return shipment are to be generated with the initial shipping data.length=50
carrierTrackingURL: type: string description: The tracking URL of the shipment.length=512
carrierTrackingURLReturn: type: string description: The additional return tracking URL of the shipment.length=512
bulkMasterShipmentNumber: type: string description: The internally generated shipment number of the bulk master if applicable. Must be used to access the bulk master shipment e.g. for adding packages, etc.length=20
revisionNumber: type: integer description: Revision number.length=3
format: int32 referenceNumber1: type: string description: Reference number 1.length=50
referenceNumber2: type: string description: Reference number 2.length=50
customsRegistrationNumber: type: string description: Registration number (MRN, etc.) of the customs declaration. The number is assigned by the customs authorities.length=35
deprecated: true transportRegistrationNumber: type: string description: Transport registration number like EKAER (Hungary) or SENT (Poland). The number is assigned by the local authorities.length=35
deprecated: true shopId: type: string description: The ID of the shop to which the shipping order is sent.length=35
deprecated: true shipToServicePointID: type: string description: The ID of the service point at which the consignee can pick up his shipping order.length=35
shipFromServicePointID: type: string description: The ID of the service point at which the shipper can deliver the shipping order for the carrier to pick up.length=35
remark: type: string description: Optional textual remark. Used for internal purposes only. The information is not forwarded to any carrier.length=1000
pickupNumber: type: string description: Pickup number. Is empty, when the shipment is not yet assigned to a pickup.length=20
pickupTransactionId: type: string description:ID uniquely referencing the corresponding pickup in the client system. Is empty, when the shipment is not yet assigned to a pickup.
length=250
boStatus: $ref: '#/components/schemas/ComboboxEntryDTO' isCompleted: type: boolean description:Indicates that the shipment is complete.
carrierNames: type: array description:The name of the carrier in the requested languages.
length (of the texts in TextInLanguageDTO) = 50
items: $ref: '#/components/schemas/TextInLanguageDTO' carrierIdentCode: type: string description: The unique code of the carrier.length=50
carrierServiceNames: type: array description: The name of the carrier service, for example 'DHL Express National 08:00' in the requested languages.length (of the texts in TextInLanguageDTO) = 50
items: $ref: '#/components/schemas/TextInLanguageDTO' carrierServiceCode: type: string description: The unique code of the carrier service.length=50
freightCosts: $ref: '#/components/schemas/AmountOfMoneyDTO' shippingDate: type: string description: Shipping date in the format 'yyyy-MM-dd'.length=10
shippingPt: $ref: '#/components/schemas/DLPartyDTO' shippingPtContact: $ref: '#/components/schemas/DLPersonDTO' consignee: $ref: '#/components/schemas/DLPartyDTO' consigneeContact: $ref: '#/components/schemas/DLPersonDTO' altInvoiceRecipient: $ref: '#/components/schemas/DLPartyDTO' altInvoiceRecipientContact: $ref: '#/components/schemas/DLPersonDTO' termsOfDeliveryCode: type: string description: IdentCode of the terms of delivery. Valid values are depending on the client's terms of delivery in the master file data.length=20
incotermDestination: type: string description: The incoterm destination of the shipment. The incoterm is included within the terms of delivery. Depending on the incoterm, it makes sense to specify a incoterm destination.length=50
portOfLoadingCode: type: string description: The code of the port or airport where the goods are loaded. The field is only relevant for air or sea freight shipments.length=5
portOfLoading: type: string description: The name of the port or airport where the goods are loaded. The field is only relevant for air or sea freight shipments.length=50
portOfDischargeCode: type: string description: The code of the port or airport where the goods are unloaded. The field is only relevant for air or sea freight shipments.length=5
portOfDischarge: type: string description: The name of the port or airport where the goods are unloaded. The field is only relevant for air or sea freight shipments.length=50
securityStatus: type: string description: 'The security status of air freight for cargo/post or passenger aircraft transport. Valid values are:
length=12
' fixedDate: type: string description: Fixed delivery date of the shipment in the format 'yyyy-MM-dd'.Important: Only the date portion is transmitted to the carrier interfaces. The time portion is ignored, so it does not matter which time is passed.
length=10
latestRequestedDeliveryDate: type: string description: Latest requested delivery date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in timezone 'UTC'.length=19
earliestRequestedDeliveryDate: type: string description: Earliest requested delivery date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in timezone 'UTC'.length=19
latestCollectionBookingDate: type: string description: Latest collection booking date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in timezone 'UTC'.length=19
earliestCollectionBookingDate: type: string description: Earliest collection booking date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in timezone 'UTC'.length=19
collectionBookingNumber: type: string description: The booking number of a requested collection booking assigned from carrier to this shipment.length=20
pickupAddress: $ref: '#/components/schemas/DLPartyDTO' pickupAddressContact: $ref: '#/components/schemas/DLPersonDTO' altReturnAddress: $ref: '#/components/schemas/DLPartyDTO' altReturnAddressContact: $ref: '#/components/schemas/DLPersonDTO' notifyAddress: $ref: '#/components/schemas/DLPartyDTO' notifyAddressContact: $ref: '#/components/schemas/DLPersonDTO' coverAddress: $ref: '#/components/schemas/DLPartyDTO' coverAddressContact: $ref: '#/components/schemas/DLPersonDTO' customsAgent: $ref: '#/components/schemas/DLPartyDTO' customsAgentContact: $ref: '#/components/schemas/DLPersonDTO' alternativeCarrierAddress: $ref: '#/components/schemas/DLPartyDTO' alternativeCarrierAddressContact: $ref: '#/components/schemas/DLPersonDTO' importerAddress: $ref: '#/components/schemas/DLPartyDTO' importerAddressContact: $ref: '#/components/schemas/DLPersonDTO' exporterAddress: $ref: '#/components/schemas/DLPartyDTO' exporterAddressContact: $ref: '#/components/schemas/DLPersonDTO' valueAddedServices: type: array description: Value added services of the shipment. items: $ref: '#/components/schemas/DLValueAddedServiceDTO' carrierInfoTexts: type: array description: Carrier info texts for the shipment. items: $ref: '#/components/schemas/DLShipmentCarrierInfoTextDTO' payerOfChargRole: type: string description: 'The payer of charges. Possible values are:
length=10
' payerOfCharg: $ref: '#/components/schemas/DLPartyDTO' payerOfChargContact: $ref: '#/components/schemas/DLPersonDTO' payerOfChargAccountNo: type: string description: The payer of charges account number.length=50
payerOfDutRole: type: string description: 'The payer of duties and taxes. Possible values are:
length=10
' payerOfDut: $ref: '#/components/schemas/DLPartyDTO' payerOfDutContact: $ref: '#/components/schemas/DLPersonDTO' payerOfDutAccountNo: type: string description: The payer of duties and taxes account number.length=50
altPayerOfTaxRole: type: string description: 'The alternative payer of taxes. Possible values are:
length=10
' altPayerOfTax: $ref: '#/components/schemas/DLPartyDTO' altPayerOfTaxContact: $ref: '#/components/schemas/DLPersonDTO' altPayerOfTaxAccountNo: type: string description: The alternative payer of taxes account number.length=50
contents: type: string description: Additional content discriptionlength=250
goodsValue: $ref: '#/components/schemas/AmountOfMoneyDTO' customsValue: $ref: '#/components/schemas/AmountOfMoneyDTO' insuranceValue: $ref: '#/components/schemas/AmountOfMoneyDTO' codValue: $ref: '#/components/schemas/AmountOfMoneyDTO' isDocumentShipment: type: boolean description:Indicates whether the shipment is a document shipment or not.
Note that this flag also defines which services can be used for the shipment.
numberOfPackages: type: integer description: The number of packageslength=5
format: int32 shipmentTotals: $ref: '#/components/schemas/DLShipmentTotalsResponseDataDTO' accountInfo: $ref: '#/components/schemas/DLShipmentAccountInfoResponseDataDTO' additionalValues: $ref: '#/components/schemas/GenericDataRecordDTO' packages: type: array description: Information about the packages of the shipment. items: $ref: '#/components/schemas/DLPackageResponseDataDTO' items: type: array description: Information about the items of the shipment. items: $ref: '#/components/schemas/DLShipmentItemResponseDataDTO' referencesTexts: type: array description: 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). items: $ref: '#/components/schemas/DLReferenceTextDTO' transportEquipments: type: array description: The transport equipment of the shipment. items: $ref: '#/components/schemas/DLTransportEquipmentDTO' templateName: type: string description: Information about the template initially used when creating the shipment. Empty if no template was used. isHazardousGoodsShipment: type: boolean description: Indicates whether the shipment is a hazardous goods shipment or not. isContainingSpecialSubstances: type: boolean description: Indicates whether the shipment is containing special substances or not. documents: type: array description: Documents for the shipment items: $ref: '#/components/schemas/DLDocumentDTO' houseAirwaybillNumber: type: string description: The house airwaybill number identifies a single shipping order within the cargo of an aircraft.length=35
masterAirwaybillNumber: type: string description: The master airwaybill number identifies the cargo of a complete aircraft.length=35
airline: type: string description: The name of the airline company.length=35
flightNumber: type: string description: The flight number specifies a specific flight of an airline.length=20
description: DTO for response information of a DLShipment.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 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"]' shipmentReferences: type: array description:The list of shipment references for which detail information is requested. Cannot be used with the filter at the same time.
items: $ref: '#/components/schemas/DLShipmentReferenceDTO' includeDocuments: type: boolean description: Controls, if the (label) documents should be included in the response of each shipment. Default is 'false'. withCanceledShipments: type: boolean description: Controls, if canceled shipments should also be returned. Default is 'true'. filter: $ref: '#/components/schemas/DLShipmentFilterDTO' description: DTO to search for shipments and request detail information about them. xml: name: getShipmentsRequestDTO DLHazardousGoodsItemResponseDataDTO: type: object properties: unNumber: type: string description: UN numberlength=8
hazardRegulation: type: string description: 'Hazardous regulation to be applied. Valid values are:length=10
' technicalName: type: string description: Technical name
length=250
hazardAdditionalDescription: type: string description: Additional descriptionlength=250
hazardousGoodsType: type: string description: "The type of hazardous goods. Possible values are:
length=10
' subriskClass1: type: string description: 'Sub risk 1 hazardous class. Valid values are:
length=10
' subriskClass2: type: string description: 'Sub risk 2 hazardous class.Valid values are:
length=10
' classificationCode: type: string description: Classification code
length=4
tunnelCode: type: string description: Tunnel code
length=10
packagingGroup: type: string description: 'Hazardous packaging group. Valid values are:
length=10
' packingInstruction: type: string description: IATA packing instruction. Consists of the instruction code (up to three digits with optional prefix Y) optionally followed by a section identification (up to two upper case characters).
length=10
specialProvision: type: string description: 'Special provisions for the carriage of hazardous goods. Consists of the provision code (up to three digits) or the chapter specification (up to three digits), optionally followed by sub-chapters (up to two digits or one digit and an upper case character). Chapter and subchapters must be separated by a dot. Also possible are 3 capital letters + hyphen, followed by further numbers or letters or 1 capital letter followed by numbers. Example Values are:length=20
' multiplicator: type: string description: Hazardous multiplicatorlength=10
packageTypeIdentCode: type: string description: IdentCode of the package type. Valid values are depending on the client's package types in the master file data.
length=20
hazardWeight: $ref: '#/components/schemas/QuantityDTO' hazardNetQuantity: $ref: '#/components/schemas/QuantityDTO' netExplosiveWeight: $ref: '#/components/schemas/QuantityDTO' numberOfPackages: type: integer description: Number of packageslength=10
format: int32 hazardLabel: type: string description: Hazardous labellength=10
transportCategory: type: string description: Transport categorylength=4
specialSubstanceType: type: string description: 'Special Substance type. Valid Values are:
length=30
' hazardPoints: type: integer description: Hazardous points
length=5
format: int32 flashPoint: type: string description: Flash pointlength=20
emergencyContact: $ref: '#/components/schemas/DLPersonDTO' transportAuthorization: type: string description: Transport authorization. Additional information that may be required by regulation about a hazardous material such as DOT-SP number (Special Permit), LAA number...length=250
marinePollutant: type: string description: 'Indicates if the substance is a marine pollutant according to IMDG or CFR. Valid Values are:length=20
' controlTemperature: type: string description: The control temperature according to IMDG or CFR.
length=4
emergencyTemperature: type: string description: The emergency temperature according to IMDG or CFR.
length=4
isEnvironmentallyHazardous: type: boolean description: Indicates if the substance is environmentally hazardous according to ADR or IATA. isReportableQuantity: type: boolean description: Indicates if package contains hazardous materials in an amount that needs to be reported. isTransportByCargoAircraftOnly: type: boolean description: Indicates if the transportation is only allowed in the cargo aircraft. additionalValues: $ref: '#/components/schemas/GenericDataRecordDTO' description: DTO for response information of a DLHazardousGoodsItem. DLDeletePackageResponseDTO: type: object 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' description: Response DTO for the deletePackage business facade method xml: name: deletePackageResponseDTO DLGetPickupsResponseDTO: type: object 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' pickups: type: array description: The resulting pickups. items: $ref: '#/components/schemas/DLPickupResponseDataDTO' description: Data Transfer Object for pickup search result. xml: name: getPickupsResponseDTO DLShipmentItemRequestDataDTO: required: - itemTransactionId type: object properties: itemNumber: type: integer description: The serial number of the item within the shipment. This number is mainly used to sort the items in lists or in business logic.length=4
format: int32 itemTransactionId: type: string description:The shipment wide unique id for the item. Is included in the response.
length=50
referenceNumber1: type: string description: Item reference number. Is included in the response.length=50
referenceNumber2: type: string description: Second item reference numberlength=50
customsTariffNumber: type: string description: The customs tariff number of the shipping item's contents.length=11
description: type: string description: The shipping item's description.length=250
exportLicense: type: string description: Export license.length=50
countryOfOriginsISOCode: type: string description: Country of origins.length=2
certificateOfOrigins: type: string description: Certificate of origins.length=50
quantity: $ref: '#/components/schemas/QuantityDTO' netWeight: $ref: '#/components/schemas/QuantityDTO' grossWeight: $ref: '#/components/schemas/QuantityDTO' customsValue: $ref: '#/components/schemas/AmountOfMoneyDTO' goodsValue: $ref: '#/components/schemas/AmountOfMoneyDTO' despatchProcedureIdentCode: type: string description: 'The despatch procedure. Possible values are:
length=10
' referencesTexts: type: array description: Further references texts for the item. Multiple references texts with same type are allowed. items: $ref: '#/components/schemas/DLShipmentItemReferenceTextDTO' additionalValues: $ref: '#/components/schemas/GenericDataRecordDTO' hazardousGoodsItems: type: array description: Hazardous goods items. items: $ref: '#/components/schemas/DLHazardousGoodsItemRequestDataDTO' description: DTO for shipment item data in a request. DLGetCarrierPortfolioNamesRequestDTO: type: object 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 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"]' additionalInfos: type: array description: List of additional infos which are requested for all carriers. If no list is supplied, no additional infos will be returned. items: type: string description: List of additional infos which are requested for all carriers. If no list is supplied, no additional infos will be returned. description: Request DTO to retrieve the codes and names of all available carriers. xml: name: getCarrierPortfolioNamesRequestDTO DLGetCarrierPropertiesResponseDTO: type: object 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' carrierIdentCode: type: string description: The carrier as specified in the request.length=20
carrierType: type: string description: 'The carrier type assigns the carrier to a category that defines the support and maintenance level. Possible values:
length=20
' descriptions: type: array description: The description of the carrier in the requested result languages. items: $ref: '#/components/schemas/TextInLanguageDTO' services: type: array description: The services the carrier offers. items: $ref: '#/components/schemas/DLServiceDTO' valueAddedServices: type: array description: The value added services the carrier offers. items: $ref: '#/components/schemas/DLValueAddedServiceDTO' additionalValues: type: array description: The possible additional values defined for the carrier. An additional value represents a field only used by that carrier, often in combination with the use of special services or value added services.DLShipmentRequestDataDTO.additionalValues as part of the createShipment call.
items:
$ref: '#/components/schemas/DLAdditionalValueDTO'
infoTexts:
type: array
description: The informational texts the carrier offers. These texts are used to submit additional information to the carrier how to handle the goods. Often they are used instead of services.
items:
$ref: '#/components/schemas/DLCarrierInfoTextDTO'
isUsingAltCarrierAddress:
type: boolean
description: Indicates if the carrier requires the specification of an alternative carrier address.
despatchCountries:
type: array
description: The despatch countries the carrier is supporting. Check first 'isDespatchCountriesGlobal'. If the carrier operates globally, this list contains all countries.
items:
$ref: '#/components/schemas/DLCarrierDespatchCountryDTO'
businessDivisions:
type: array
description: The business divisions in which the carrier is working.
items:
$ref: '#/components/schemas/DLCarrierBusinessDivisionDTO'
networks:
type: array
description: The networks the carrier is member of.
items:
$ref: '#/components/schemas/DLCarrierNetworkDTO'
extendedInfos:
$ref: '#/components/schemas/DLCarrierExtendedInfosDTO'
isDespatchCountriesGlobal:
type: boolean
description: Indicates if the carrier operates globally. Therefore the list of despatchCountries contains all countries.
imprint:
type: string
description: The official company name (corporate name) of the carrier according to homepage.
name:
type: string
description: Name of carrier.
description: Response DTO containing the properties of a specific carrier.
xml:
name: getCarrierPropertiesResponseDTO
DLDeleteItemRequestDTO:
required:
- shipmentItemReference
type: object
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 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"]' shipmentItemReference: $ref: '#/components/schemas/DLShipmentItemReferenceDTO' description: Request DTO for the deleteItem business facade method xml: name: deleteItemRequestDTO DLProcessPackageResponseDTO: type: object 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' carrierPackageNumber: type: string description: The carrier tracking number of the package.length=50
carrierPackageIdentBarcode: type: string description: 'The content of the barcode identifying the package as defined by the carrier. The carrierPackageNumber is most likely part of the carrierPackageIdentBarcode and for same carrier it is identical. However, this depends solely on the carriers'' specification. NOTE: this is currently in BETA phase and only supported for a very small number of carriers.length=50
' carrierPackageNumberReturn: type: string description: The additional return tracking number given by the carrier, if the data for the possible return shipment are to be generated with the initial shipping data.length=50
documents: type: array description: The documents for the package. Only filled when asked for in request (documentOutputMode). items: $ref: '#/components/schemas/DLDocumentDTO' description: Response DTO for the getPackageDocuments business facade method xml: name: processPackageResponseDTO DLTransportEquipmentReferenceDTO: required: - equipmentTransactionId type: object properties: identification: type: string description: The identification of the transport equipment.length=50
equipmentTransactionId: type: string description: The number of the client system uniquely referencing a transport equipment in a shipment.length=50
description: DTO for uniquely identifying a transport equipment within a shipment. GenericDataFieldDTO: type: object properties: name: type: string description:Name of this field, i.e. the role the field plays in the enclosing record.
When the same name is repeated in the context of the same parent record, it is assumed that the parent defines this element as a repeatable (array) element.
value: type: string description:Value of the field.
The format follows the conventions of xml schema encoding, see http://www.w3.org/TR/xmlschema-2/.
Data type of the field.
This is not strictly necessary since the receiving entity should be able to infer the structure with its own meta data; it may be used however for sanity checks.
The format follows the conventions of xml schema encoding, see http://www.w3.org/TR/xmlschema-2/.
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 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"]' ageInDays: type: integer description:Initializes the delta transmission of pickups (syncId must be null). Only pickups with this age or younger will be synchronized. Relevant date is the shipping date.
If this field is 0, synchronization starts with all pickups.
length=10
format: int32 syncId: type: string description:For delta-transmissions after initialization (ageInDays must be null).
Fill this field with the DLSyncShipmentPickupsResponseDTO.syncId returned in the last call of synchPickups. As initial value use 0 or 1.
length=20
includeDocuments: type: boolean description: Controls, if the documents should be included in the response. Default is 'false'. includeDriverSignature: type: boolean description: Controls, if the signature of the driver should be included in the response. Default is 'false'. description: Request DTO for pickup synchronization. xml: name: syncPickupsRequestDTO DLPartyDTO: type: object properties: companyNumber: type: string description: Company Numberlength=20
name: type: string description: Name of the company (first address line)length=40
name2: type: string description: Address name line 2length=40
name3: type: string description: Address name line 3length=40
name4: type: string description: Address name line 4length=40
street: type: string description: Street (line 1) of the address.length=40
street2: type: string description: Street (line 2) of the address.length=40
postcode: type: string description: Postcode of the street address.length=10
city: type: string description: City of the address.length=40
district: type: string description: District (city line 2) of the address.length=40
countryISOCode: type: string description: Country of addresslength=2
county: type: string description: County of the addresslength=40
poBox: type: string description: PO-Box.length=10
postcodePOBox: type: string description: Postcode of the poBox address.length=10
cityPOBox: type: string description: City of the po-box address.length=40
emailAddress: type: string description: Email address of the address.length=256
phone: type: string description: Phone number of receptionlength=20
fax: type: string description: Fax number of receptionlength=20
initFromCompanyMasterFileData: type: boolean description: Flag controlling how the party will be filled.The shipment wide unique id for the packed shipment item.
length=50
shipmentReference: $ref: '#/components/schemas/DLShipmentReferenceDTO' itemTransactionId: type: string description: The number of the client system uniquely referencing an item in a shipment.length=50
referenceNumber1: type: string description: Another item reference number. May be used, when an item was not created by the client system and therefore has noitemTransactionId. If both fields are filled, they both must match the item. length=50
quantityValue: type: number description: It is not supported in case of deleting an item.The prepare mode for the package documents. Valid values are:
length=20
' description: DTO specifying the prepare mode for documents on package level. DLDocumentDTO: type: object properties: documentId: type: string description: Unique identification of the document.length = 50
documentType: type: string description: 'The ident code of the document type the document belongs to.length = 50
' mimeType: type: string description: 'The MIME type of the document. Possible values:format" document is a printable image. format can be "png", "jpeg", etc. length = 30
' printerModel: type: string description: Only filled for "printer/raw" mime type. Specifies the printer model the content is usable for.length = 80
printerId: type: string description: Only filled for "printer/raw" mime type. The ID can be used to identify a special printer by the ERP system.length = 80
resolution: type: integer description: Only filled for "image" mime types. Specifies resolution of the image.length = 8
format: int32 content: type: string description: The document content format: byte description: DTO for a document to be printed out by the client system. DLDeleteItemResponseDTO: type: object 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' description: Response DTO for the deleteItem business facade method xml: name: deleteItemResponseDTO DLUpdateCustomsShipmentRequestDataDTO: type: object properties: customsValue: $ref: '#/components/schemas/AmountOfMoneyDTO' goodsValue: $ref: '#/components/schemas/AmountOfMoneyDTO' invoiceValue: $ref: '#/components/schemas/AmountOfMoneyDTO' description: Request DTO for a few shipment fields which can be updated after the initial creation of the shipment. DLShipmentCancelParmsDTO: required: - processMode type: object properties: processMode: $ref: '#/components/schemas/DLProcessModeDTO' description: Parameters for the cancle operation for a shipment. DLPickupResponseDataDTO: type: object properties: hasErrors: type: boolean description: True, if there are any error messages. If an error has occured the messages contain more details about the errors. hasWarnings: type: boolean description: True, if there are any warning messages. messages: type: array description: Messages for the whole request, e.g. for errors or warnings.length=20
transactionId: type: string description:ID uniquely referencing the corresponding pickup in the client system.
length=250
transactionLabel: type: string description:Human readable text which identifies the pickup business transaction in the client system (not necessarily unique).
length=250
pickupNumber: type: string description:Pickup number.
length=20
referenceNumber1: type: string description:Reference number 1.
length=50
referenceNumber2: type: string description:Reference number 2.
length=50
licensePlateNumber1: type: string description:First license plate number.
length=50
licensePlateNumber2: type: string description:Second license plate number.
length=50
driverSignature: $ref: '#/components/schemas/DLSignatureDTO' carrierIdentCode: type: string description:The unique code of the pickup's carrier.
length=20
carrierNames: type: array description:The name of the carrier in the requested languages.
length (of the texts in TextInLanguageDTO) = 50
items: $ref: '#/components/schemas/TextInLanguageDTO' carrierServiceNames: type: array description: The name of the carrier service, for example 'DHL Express National 08:00' in the requested languages.length (of the texts in TextInLanguageDTO) = 50
items: $ref: '#/components/schemas/TextInLanguageDTO' carrierServiceCode: type: string description: The unique code of the carrier service.length=50
accountInfo: $ref: '#/components/schemas/DLShipmentAccountInfoResponseDataDTO' shippingDate: type: string description: Shipping date in the format 'yyyy-MM-dd'.length=10
shippingPt: $ref: '#/components/schemas/DLPartyDTO' shippingPtContact: $ref: '#/components/schemas/DLPersonDTO' boStatus: $ref: '#/components/schemas/ComboboxEntryDTO' isClosed: type: boolean description: Indicates whether the pickup has been compiled. In that case no further shipping orders will be assigned to it. isManifested: type: boolean description: Indicates whether the pickup has been manifested. isManifestedWithWarnings: type: boolean description: Indicates that warnings occurred while transmitting at least one of the EDI messages. isManifestDocumentsCreated: type: boolean description: Indicates that the manifest documents have been created. entryCertificateTS: type: string description: Transfer timestamp of the entry certificate relevant documents to the VCP in format "yyyy-MM-dd HH:mm:ss". numberOfPackages: type: integer description: The number of packages actually included in the pickup.length=5
format: int32 numberOfShipments: type: integer description: The number of shipments actually included in the pickup.length=5
format: int32 additionalValues: $ref: '#/components/schemas/GenericDataRecordDTO' shipmentReferences: type: array description: The shipments included in the pickup. items: $ref: '#/components/schemas/DLShipmentReferenceDTO' documents: type: array description: The (manifest) documents for the pickup. Only filled when asked for in request. items: $ref: '#/components/schemas/DLDocumentDTO' edis: type: array description: The EDI messages of the pickup. items: $ref: '#/components/schemas/DLShipmentPickupEDIDTO' description: DTO for response information of a DLShipmentPickup. DLTransportEquipmentDTO: required: - equipmentTransactionId - equipmentTypeIdentCode type: object properties: identification: type: string description: The identification of the transport equipment, e.g. the container number.length=50
equipmentTransactionId: type: string description: The shipment wide unique id for the transport equipment. Is included in the response.length=50
equipmentTypeIdentCode: type: string description: IdentCode of the equipment type (Container, pallet etc.). All entries in the client's package type master file data are allowed. So the valid values are depending on the configured entries there.length=20
grossWeight: $ref: '#/components/schemas/QuantityDTO' dimensions: $ref: '#/components/schemas/DLCuboidDimensionsDTO' containerData: $ref: '#/components/schemas/DLContainerDataDTO' sealNumbers: type: array description: Seal (serial numbers and/or barcodes) of the transport equipment.length = 35
items: type: string description: Seal (serial numbers and/or barcodes) of the transport equipment.length = 35
description: DTO representing a specific transport equipment such as a containers or a pallets. DLCarrierNetworkDTO: type: object properties: identCode: type: string description: The identCode of the entry.length=50
descriptions: type: array description: The description of the entry in the requested result languages. items: $ref: '#/components/schemas/TextInLanguageDTO' description: Response information about the networks in which the carrier is involved. DLGetShipmentsResponseDTO: type: object 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' shipments: type: array description: The resulting shipments. items: $ref: '#/components/schemas/DLShipmentResponseDataDTO' description: Data Transfer Object for shipment search result. xml: name: getShipmentsResponseDTO DLHazardousGoodsItemRequestDataDTO: required: - hazardRegulation type: object properties: transactionId: type: string description:The shipment wide unique id for the hazardous goods item.
length=50
unNumber: type: string description: UN numberlength=8
hazardRegulation: type: string description: 'Hazardous regulation to be applied. Valid values are:
length=10
' technicalName: type: string description: Technical name
length=250
hazardAdditionalDescription: type: string description: Additional description
length=250
hazardousGoodsType: type: string description: "Indicates the type of hazardous goods packaged in the package. Valid values are:
length=10
' subriskClass1: type: string description: 'Sub risk 1 hazardous class. Valid values are:
length=10
' subriskClass2: type: string description: 'Sub risk 2 hazardous class. Valid values are:
length=10
' classificationCode: type: string description: Classification code
length=4
tunnelCode: type: string description: Tunnel restriction code
length=10
packagingGroup: type: string description: 'Hazardous packaging group. Valid Values are:
length=10
' packingInstruction: type: string description: 'IATA packing instruction. Consists of the instruction code (up to three digits with optional prefix Y) optionally followed by a section identification (up to two upper case characters). Instruction code and section must be separated by an underscore. The section identification is mandatory for lithium batteries otherwise the instruction code alone is sufficient. Example Values are:
length=10
' specialProvision: type: string description: 'Special provisions for the carriage of hazardous goods. Consists of the provision code (up to three digits) or the chapter specification (up to three digits), optionally followed by sub-chapters (up to two digits or one digit and an upper case character). Chapter and subchapters must be separated by a dot. Also possible are 3 capital letters + hyphen, followed by further numbers or letters or 1 capital letter followed by numbers. Example Values are:length=20
' multiplicator: type: string description: 'Hazardous multiplicator. Valid Values are:length=10
' packageTypeIdentCode: type: string description: IdentCode of the package type. Valid values are depending on the client's package types in the master file data.
length=20
hazardWeight: $ref: '#/components/schemas/QuantityDTO' hazardNetQuantity: $ref: '#/components/schemas/QuantityDTO' netExplosiveWeight: $ref: '#/components/schemas/QuantityDTO' numberOfPackages: type: integer description: Number of packageslength=10
format: int32 hazardLabel: type: string description: Hazardous labellength=10
transportCategory: type: string description: 'Transport category. Valid Values are:length=4
' specialSubstanceType: type: string description: 'Special Substance type. Valid Values are:
length=30
' hazardPoints: type: integer description: Hazardous points
length=5
format: int32 flashPoint: type: string description: Flash pointlength=20
specialProvisionMarking: type: string description: 'Indicates if the special provision has to be marked. Valid Values are:length=20
' emergencyContact: $ref: '#/components/schemas/DLPersonDTO' transportAuthorization: type: string description: Transport authorization. Additional information that may be required by regulation about a hazardous material such as DOT-SP number (Special Permit), LAA number...
length=250
packingInstructionMarking: type: string description: 'Indicates if the packing instruction has to be marked. Valid Values are:length=20
' marinePollutant: type: string description: 'Indicates if the substance is a marine pollutant according to IMDG or CFR. When no value is given, default is NO_POLLUTANT. Valid Values are:
length=20
' controlTemperature: type: string description: The control temperature according to IMDG or CFR.
length=4
emergencyTemperature: type: string description: The emergency temperature according to IMDG or CFR.
length=4
isEnvironmentallyHazardous: type: boolean description: Indicates if the substance is environmentally hazardous according to ADR or IATA. isReportableQuantity: type: boolean description: Indicates if package contains hazardous materials in an amount that needs to be reported. isTransportByCargoAircraftOnly: type: boolean description: Indicates if the transportation is only allowed in the cargo aircraft. isNotRegulated: type: boolean description: Indicates if no hazardous goods exist in accordance with the regulations. additionalValues: $ref: '#/components/schemas/GenericDataRecordDTO' description: DTO for request information of a DLHazardousGoodsItem. TextInLanguageDTO: type: object 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 description: A translated text in one of the specified languages. DLGetCarrierPortfolioDetailsResponseDTO: type: object 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' carriers: type: array description: The list of all requested carriers with their detail information. items: $ref: '#/components/schemas/DLGetCarrierPropertiesResponseDTO' description: Response DTO for all available carriers with their detail information. xml: name: getCarrierPortfolioDetailsResponseDTO DLCreatePickupResponseDTO: type: object 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' pickupNumber: type: string description: The pickup number internally generated by the carrier engine.length=20
documents: type: array description: The documents (manifests) of the pickup. Only filled, when specified indocumentOutputMode of request.
items:
$ref: '#/components/schemas/DLDocumentDTO'
description: Response DTO for the processPickup business facade method
xml:
name: createPickupResponseDTO
DLShipmentRequestDataDTO:
required:
- carrierIdentCode
- consignee
- contents
- referenceNumber1
- serviceCode
- shippingDate
- shippingPt
- termsOfDeliveryCode
- transactionId
type: object
properties:
transactionId:
type: string
description: ID uniquely referencing the corresponding business transaction in the client system.
length=250
transactionLabel: type: string description:Human readable text which identifies a business transaction (not necessarily unique).
length=250
organizationUnitClientSystem: type: string description: Additional criteria two separate different organisational units within one Engine's client.length=255
masterShipmentTransactionId: type: string description:ID uniquely referencing the corresponding master shipment in the client system if the shipment is part of a bulk shipment.
isDocumentShipment: type: boolean description:Indicates whether the shipment is a document shipment or not.
Note that this flag also defines which services can be used for the shipment.
templateName: type: string description: Name of the template that is used for initializing data from a shipment template. If a field is filled in the template and in the dto, the value from the dto will be used.length=100
referenceNumber1: type: string description: First reference number.length=50
referenceNumber2: type: string description: Second reference number.length=50
customsRegistrationNumber: type: string description: Registration number (MRN, etc.) of the customs declaration. The number is assigned by the customs authorities.length=35
deprecated: true transportRegistrationNumber: type: string description: Transport registration number like EKAER (Hungary) or SENT (Poland). The number is assigned by the local authorities.length=35
deprecated: true consigneePalletExchangeRegNo: type: string description: The consignee pallet exchange registration number. The number is assigned by the carrier if pallet exchange is supported.length=50
numberOfExchangePallets: type: integer description: The number of exchange pallets. Used for the pallet exchange system if supported by carrier.length=5
format: int32 shopId: type: string description: The ID of the shop to which the shipping order is sent.length=35
deprecated: true shipToServicePointID: type: string description: The ID of the service point at which the consignee can pick up his shipping order.length=35
shipFromServicePointID: type: string description: The ID of the service point at which the shipper can deliver the shipping order for the carrier to pick up.length=35
remark: type: string description: Optional textual remark. Used for internal purposes only. The information is not forwarded to any carrier.length=1000
shippingDate: type: string description: Shipping date of the shipment in the format 'yyyy-MM-dd' or 'yyyyMMdd'. The shipping date is expected to be in the time zone of the shipping point.length=10
contents: type: string description: Additional content discriptionlength=250
extCarrierShipNum: type: string description: The external carrier tracking number of the shipment.length=50
extCarrierShipNumBasic: type: string description: The basic external carrier tracking number of the shipment.length=50
extCarrierShipNumReturn: type: string description: The external carrier return tracking number of the shipment.length=50
extCarrierShipNumBasicReturn: type: string description: The basic external carrier return tracking number of the shipment.length=50
shippingPt: $ref: '#/components/schemas/DLPartyDTO' shippingPtContact: $ref: '#/components/schemas/DLPersonDTO' customsValue: $ref: '#/components/schemas/AmountOfMoneyDTO' consignee: $ref: '#/components/schemas/DLPartyDTO' consigneeContact: $ref: '#/components/schemas/DLPersonDTO' altInvoiceRecipient: $ref: '#/components/schemas/DLPartyDTO' altInvoiceRecipientContact: $ref: '#/components/schemas/DLPersonDTO' carrierIdentCode: type: string description: Carrier of the shipment.length=20
serviceCode: type: string description: Service to apply on the shipment. Service must be available within the carrier identified bycarrierIdentCode. length=20
termsOfDeliveryCode: type: string description: IdentCode of the terms of delivery. Valid values are depending on the client's terms of delivery in the master file data.length=20
incotermDestination: type: string description: The incoterm destination of the shipment. The incoterm is included within the terms of delivery. Depending on the incoterm, it makes sense to specify a incoterm destination.length=50
portOfLoadingCode: type: string description: The code of the port or airport where the goods are loaded. The field is only relevant for air or sea freight shipments.length=5
portOfLoading: type: string description: The name of the port or airport where the goods are loaded. The field is only relevant for air or sea freight shipments.length=50
portOfDischargeCode: type: string description: The code of the port or airport where the goods are unloaded. The field is only relevant for air or sea freight shipments.length=5
portOfDischarge: type: string description: The name of the port or airport where the goods are unloaded. The field is only relevant for air or sea freight shipments.length=50
securityStatus: type: string description: 'The security status of air freight for cargo/post or passenger aircraft transport. Valid values are:
length=12
' fixedDate: type: string description: Fixed delivery date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in the time zone of the delivery point.Important: Only the date portion is transmitted to the carrier interfaces. The time portion is ignored, so it does not matter which time is passed.
length=19
earliestCollectionBookingDate: type: string description: Earliest collection booking date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in the time zone of the shipping point.length=19
latestCollectionBookingDate: type: string description: Latest collection booking date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in the time zone of the shipping point.length=19
latestRequestedDeliveryDate: type: string description: Latest requested delivery date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in the time zone of the delivery point.length=19
earliestRequestedDeliveryDate: type: string description: Earliest requested delivery date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in the time zone of the delivery point.length=19
airline: type: string description: The name of the airline company.length=35
flightNumber: type: string description: The flight number specifies a specific flight of an airline.length=20
houseAirwaybillNumber: type: string description: The house airwaybill number identifies a single shipping order within the cargo of an aircraft.length=35
masterAirwaybillNumber: type: string description: The master airwaybill number identifies the cargo of a complete aircraft.length=35
pickupAddress: $ref: '#/components/schemas/DLPartyDTO' pickupAddressContact: $ref: '#/components/schemas/DLPersonDTO' altReturnAddress: $ref: '#/components/schemas/DLPartyDTO' altReturnAddressContact: $ref: '#/components/schemas/DLPersonDTO' notifyAddress: $ref: '#/components/schemas/DLPartyDTO' notifyAddressContact: $ref: '#/components/schemas/DLPersonDTO' coverAddress: $ref: '#/components/schemas/DLPartyDTO' coverAddressContact: $ref: '#/components/schemas/DLPersonDTO' customsAgent: $ref: '#/components/schemas/DLPartyDTO' customsAgentContact: $ref: '#/components/schemas/DLPersonDTO' alternativeCarrierAddress: $ref: '#/components/schemas/DLPartyDTO' alternativeCarrierAddrContact: $ref: '#/components/schemas/DLPersonDTO' importerAddress: $ref: '#/components/schemas/DLPartyDTO' importerAddressContact: $ref: '#/components/schemas/DLPersonDTO' exporterAddress: $ref: '#/components/schemas/DLPartyDTO' exporterAddressContact: $ref: '#/components/schemas/DLPersonDTO' payerOfChargRole: type: string description: 'The payer of charges. Valid values are:
length=10
' payerOfCharg: $ref: '#/components/schemas/DLPartyDTO' payerOfChargContact: $ref: '#/components/schemas/DLPersonDTO' payerOfChargAccountNo: type: string description: The payer of charges account number. Only used, when initPayerOfChargAccNoFromCompanyMasterData = false.length=50
initPayerOfChargAccNoFromCompanyMasterData: type: boolean description: Flag controlling how the 'payerOfChargAccountNo' field will be filled.The payer of duties and taxes. Valid values are:
length=10
' payerOfDut: $ref: '#/components/schemas/DLPartyDTO' payerOfDutContact: $ref: '#/components/schemas/DLPersonDTO' payerOfDutAccountNo: type: string description: The payer of duties and taxes account number. Only used, when initPayerOfDutAccNoFromCompanyMasterData = false.length=50
initPayerOfDutAccNoFromCompanyMasterData: type: boolean description: Flag controlling how the 'payerOfDutAccountNo' field will be filled.The alternative payer of taxes. Valid values are:
length=10
' altPayerOfTax: $ref: '#/components/schemas/DLPartyDTO' altPayerOfTaxContact: $ref: '#/components/schemas/DLPersonDTO' altPayerOfTaxAccountNo: type: string description: The alternative payer of taxes account number. Only used, when initAltPayerOfTaxAccNoFromCompanyMasterData = false.length=50
initAltPayerOfTaxAccNoFromCompanyMasterData: type: boolean description: Flag controlling how the 'altPayerOfTaxAccountNo' field will be filled.length=10, scale=3
palletPlaces: type: number description: The pallet places needed for the shipment. If a value is given, it overwrites the pallet places in 'packageCumulations'.length=10, scale=3
packages: type: array description: Packages of the shipment. items: $ref: '#/components/schemas/DLPackageRequestDataDTO' packageCumulations: type: array description: Packages cumulations of the shipment. items: $ref: '#/components/schemas/DLPackageCumulationRequestDataDTO' items: type: array description: Shipment items. items: $ref: '#/components/schemas/DLShipmentItemRequestDataDTO' referencesTexts: type: array description: 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). items: $ref: '#/components/schemas/DLReferenceTextDTO' transportEquipments: type: array description: The transport equipments used for the shipment. items: $ref: '#/components/schemas/DLTransportEquipmentDTO' valueAddedServices: type: array description: Value added services for the shipment. items: $ref: '#/components/schemas/DLValueAddedServiceReferenceDTO' carrierInfoTexts: type: array description: Carrier info texts for the shipment. items: $ref: '#/components/schemas/DLShipmentCarrierInfoTextDTO' additionalValues: $ref: '#/components/schemas/GenericDataRecordDTO' description: DTO for shipment data in a request. DLProcessShipmentResponseDTO: type: object 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' carrierShipmentNumber: type: string description: The carrier tracking number of the shipment.length=50
carrierShipmentNumberReturn: type: string description: The additional return tracking number given by the carrier, if the data for the possible return shipment are to be generated with the initial shipping data.length=50
carrierTrackingURL: type: string description: The tracking URL of the shipment.length=512
carrierTrackingURLReturn: type: string description: The additional return tracking URL of the shipment.length=512
packageResults: type: array description: The results on package level. items: $ref: '#/components/schemas/DLPackageProcessingResultDTO' documents: type: array description: The documents of the shipment. Only filled, when specified indocumentOutputMode of request and shipment documents for printing exist. This also works for reprint.
items:
$ref: '#/components/schemas/DLDocumentDTO'
description: Response DTO for the processShipment business facade method.length=50
customerNumberAtCarrier: type: string description: Account number of the shipper assigned from the carrier.length=25
singlePackageHandlingActivated: type: boolean description: Indicates whether package by package printing is possible for the carrier. description: Holds information from the account used for the shipment DLGetAllCarriersResponseDTO: type: object 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' carriers: type: array description: The list of available carriers. items: $ref: '#/components/schemas/DLCarrierListItemDTO' description: Response DTO containing a list of available carrier for a client. xml: name: getAllCarriersResponseDTO DLGetPickupsRequestDTO: type: object 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 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"]' pickupReferences: type: array description:The list of pickups references for which detail information is requested. Cannot be used with the filter at the same time.
items: $ref: '#/components/schemas/DLPickupReferenceDTO' includeDocuments: type: boolean description: Controls, if the documents should be included in the response of each pickup. Default is 'false'. includeDriverSignature: type: boolean description: Controls, if the signature of the driver should be included in the response of each pickup. Default is 'false'. filter: $ref: '#/components/schemas/DLPickupFilterDTO' description: DTO to search for pickups and request detail information about them. xml: name: getPickupsRequestDTO DLPackageHazardousGoodsDataRequestDTO: required: - hazardousGoodsType type: object properties: hazardousGoodsType: type: string description: "Indicates the type of hazardous goods packaged in the package. Valid values are:length=2, scale=1
description: Holds hazardous goods data concerning the package. DLPickupRequestDataDTO: required: - referenceNumber1 - shipments - shippingDate - shippingPt - transactionId type: object properties: transactionId: type: string description:ID uniquely referencing the corresponding business transaction for the pickup in the client system.
length=250
transactionLabel: type: string description:Human readable text which identifies the pickup business transaction in the client system (not necessarily unique).
length=250
referenceNumber1: type: string description: First reference number.length=50
referenceNumber2: type: string description: Second reference number.length=50
licensePlateNumber1: type: string description: First license plate number.length=50
licensePlateNumber2: type: string description: Second license plate number.length=50
driverSignature: $ref: '#/components/schemas/DLSignatureDTO' carrierIdentCode: type: string description: Carrier of the pickup.length=20
shippingDate: type: string description: Shipping date in the format 'yyyy-MM-dd'. The shipping date is expected to be in the time zone of the shipping point.length=10
shippingPt: $ref: '#/components/schemas/DLPartyDTO' shippingPtContact: $ref: '#/components/schemas/DLPersonDTO' shipments: type: array description: The shipments contained in the pickup. All shipments must belong to the pickup's carrier (specified in fieldcarrierIdentCode) and the pickup's shipping point (specified in field shippingPoint).
items:
$ref: '#/components/schemas/DLShipmentReferenceDTO'
description: DTO for pickup data.
DLSyncShipmentsResponseDTO:
type: object
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' syncId: type: string description: Sync id for delta transmission of shipments. Use this syncId in subsequent calls tosyncShipments. length=20
isComplete: type: boolean description: True, if the synchronization is complete. False if not. Because a maximum of 100 shipments is returned with one call of syncShipments, the result may be incomplete.
To get ALL shipments make repeated calls of syncShipments, always passing the last returned DLSyncShipmentsResponseDTO.syncId.
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 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"]' packageReference: $ref: '#/components/schemas/DLPackageReferenceDTO' description: Request DTO for the deletePackage business facade method xml: name: deletePackageRequestDTO DLServiceDTO: type: object properties: identCode: type: string description: The identCode of the entry.length=50
descriptions: type: array description: The description of the entry in the requested result languages. items: $ref: '#/components/schemas/TextInLanguageDTO' isInternationalAllowed: type: boolean description: Returns true when service is available for international transports. isDomesticAllowed: type: boolean description: Returns true when service is available for domestic transports. isPackageOriented: type: boolean description: Returns true when service is package oriented. isDocumentService: type: boolean description: Returns true when service is used for the transport of documents. isGoodsService: type: boolean description: Returns true when service is used for the transport of goods. isFixedDateService: type: boolean description: Returns true when service allows a fixed date delivery. description: Information about a service a carrier offers. DLProcessShipmentRequestDTO: required: - processParms - shipmentReference type: object 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 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"]' creationParms: $ref: '#/components/schemas/DLShipmentCreationParmsDTO' shipmentReference: $ref: '#/components/schemas/DLShipmentReferenceDTO' shipmentTotals: $ref: '#/components/schemas/DLShipmentTotalsRequestDataDTO' shipmentUpdateData: $ref: '#/components/schemas/DLShipmentUpdateRequestDataDTO' packages: type: array description: 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. items: $ref: '#/components/schemas/DLPackageRequestDataDTO' packageCumulations: type: array description: 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. items: $ref: '#/components/schemas/DLPackageCumulationRequestDataDTO' items: type: array description: 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: $ref: '#/components/schemas/DLShipmentItemRequestDataDTO' referencesTexts: type: array description: 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). items: $ref: '#/components/schemas/DLReferenceTextDTO' transportEquipments: type: array description: 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. items: $ref: '#/components/schemas/DLTransportEquipmentDTO' processParms: $ref: '#/components/schemas/DLShipmentProcessParmsDTO' carrierInfoTexts: type: array description: Carrier info texts for the shipment. items: $ref: '#/components/schemas/DLShipmentCarrierInfoTextDTO' description: Request DTO for the processShipment business facade method xml: name: processShipmentRequestDTO DLCarrierPortfolioNameDTO: type: object properties: identCode: type: string description: The identCode of the entry.length=50
descriptions: type: array description: The description of the entry in the requested result languages. items: $ref: '#/components/schemas/TextInLanguageDTO' carrierType: type: string description: 'The carrier type assigns the carrier to a category that defines the support and maintenance level. Possible values:
length=20
' despatchCountries: type: array description: The despatch countries the carrier is supporting. Check first 'isDespatchCountriesGlobal'. If the carrier operates globally, this list contains all countries. items: $ref: '#/components/schemas/DLCarrierDespatchCountryDTO' businessDivisions: type: array description: The business divisions in which the carrier is working. items: $ref: '#/components/schemas/DLCarrierBusinessDivisionDTO' isDespatchCountriesGlobal: type: boolean description: Indicates if the carrier operates globally. Therefore the list of despatchCountries contains all countries. imprint: type: string description: The official company name (corporate name) of the carrier according to homepage. name: type: string description: Name of carrier. description: DTO for the code and name of a carrier. DLProcessPackageReturnEnclosedLabelRequestDTO: required: - packageReference - processParms type: object 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 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"]' packageReference: $ref: '#/components/schemas/DLPackageReferenceDTO' processParms: $ref: '#/components/schemas/DLPackageReturnEnclosedLabelProcessParmsDTO' description: Request DTO for the processPackageReturnEnclosedLabel business facade method. xml: name: processPackageReturnEnclosedLabelDTO DLPackageReferenceDTO: required: - packageTransactionId - shipmentReference type: object properties: shipmentReference: $ref: '#/components/schemas/DLShipmentReferenceDTO' packageTransactionId: type: string description: The number of the client system uniquely referencing a package in a shipment.length=50
referenceNumber1: type: string description: Another package reference number. May be used, when a package was not created by the client system and therefore has nopackageTransactionId. If both fields are filled, they both must match the package. length=50
description: DTO for uniquely identifying a package. The context settingsclientIdentCode and clientSystemId are also applied when filled.
DLDeletePickupRequestDTO:
required:
- pickupReference
type: object
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 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"]' pickupReference: $ref: '#/components/schemas/DLPickupReferenceDTO' description: Request DTO for the cancelShipment business facade method xml: name: deletePickupRequestDTO DLShipmentItemReferenceTextDTO: type: object properties: type: type: string description: 'The type of the reference number or text. Valid values are:
length=30
' value: type: string description: The value of the reference number or text.length=500
description: DTO for reference texts of shipment items. DLUpdateCustomsItemRequestDataDTO: required: - shipmentItemReference type: object properties: shipmentItemReference: $ref: '#/components/schemas/DLShipmentItemReferenceUCDDTO' customsTariffNumber: type: string description: The customs tariff number of the shipping item's contents.length=11
description: type: string description: The shipping item's description.length=250
countryOfOriginsISOCode: type: string description: Country of origins.length=2
certificateOfOrigins: type: string description: Certificate of origins.length=50
customsValue: $ref: '#/components/schemas/AmountOfMoneyDTO' goodsValue: $ref: '#/components/schemas/AmountOfMoneyDTO' customsReferencesTexts: type: array description: 'Updates reference texts data. The field may be empty when there''s no need to update any references and texts.length=20
description: DTO to reference a value added service within a carrier. DLSyncPickupsResponseDTO: type: object 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' syncId: type: string description: Sync id for delta transmission of pickups. Use this syncId in subsequent calls tosyncPickups. length=20
isComplete: type: boolean description: True, if the synchronization is complete. False if not. Because a maximum of 100 pickups is returned with one call of syncPickups, the result may be incomplete.
To get ALL pickups make repeated calls of syncPickups, always passing the last returned DLSyncShipmentPickupsResponseDTO.syncId.
The workstation used to detect the printer for which the documents should be prepared, printed or returned.
An error will be returned when the package documents (labels) are already prepared (invoked by a previous call) and are now be be printed with a different workstationId containing an incompatible printer.
length=50
documentOutputMode: $ref: '#/components/schemas/DLDocumentOutputModeDTO' operationMode: $ref: '#/components/schemas/DLPackageOperationModeDTO' description: Process parameters for a package. Specifies which operations have to be performed on a package. DLCarrierInfoTextDTO: type: object properties: identCode: type: string description: The identCode of the entry.length=50
descriptions: type: array description: The description of the entry in the requested result languages. items: $ref: '#/components/schemas/TextInLanguageDTO' description: Information about an additional info text a carrier offers. QuantityDTO: type: object properties: value: multipleOf: 0.001 maximum: 999999999999.999 type: number description: The value of the quantity. unit: maxLength: 10 type: string description: " \t\t\tIdentifier of the quantity unit. Use quantity units known from your AEB application or alternatively domain specific or legacy quantity codes, but not the UNECE code.\n \t\t\tFor UNECE unit codes use the 'uneceUnit' field, if supported.\n\n \t\t\tWeight unit codes:\n \t\t\t* kg - Kilogram\n \t* gr - Gram\n \t* t - Metric ton\n \t* lb - Pound\n \t* oz - Ounce\n\n \tLength unit codes:\n \t* m - Meter\n \t* mm - Milimeter\n \t* cm - Centimeter\n \t* dm - Decimeter\n \t* km - Kilometer\n \t* ft - Foot\n \t* in - Inch\n \t* mi - Mile\n \t* nm - Nanometer\n \t* µm - Micrometer\n\n \tVolume unit codes:\n \t* ccm - Cubic centimeter\n \t* cdm - Cubic decimeter\n \t* m3 - Cubic meter\n \t* ml - Milliliter\n \t* cl - Centiliter\n \t* hl - Hectoliter\n \t* l - Liter\n \t* cuin - Cubic inch\n \t* cuft - Cubic foot\n\n \tQuantity unit codes:\n \t* St - Piece\n \t* Paar - Pair\n\n \tDensity unit codes:\n \t* g/ccm - grams per cubic centimeter\n \t* kg/m3 - kilogram per cubic meter\n\n \tTime unit codes:\n \t* h - Hour\n \t* stu - Hour\n \t* std - Hour\n \t* oph - Operational hour\n \t* s - Second\n \t* min - Minute\n \t* 15m - 15 mins\n \t* d - Day\n \t* tag - Day\n \t* wch - Week\n \t* mon - Month\n \t* jhr - Year\n \t* mis - Millisecond\n \t* ms - Microsecond\n \t* ns - Nanosecond\n \t* ps - Picosecond\n\n \tArea unit codes:\n \t\t\t* qm - Square meter\n \t* qmm - Square millimeter\n \t* qcm - Square centimeter\n \t* qdm - Square decimeter\n" example: kg uneceUnit: maxLength: 3 type: string description: " \t\t\tIdentifier of the quantity unit based on 'Recommendation No. 20 - Units of Measure used in International Trade'.length=15, scale=2
width: type: number description: Represents the width of the dimensions.length=15, scale=2
height: type: number description: Represents the height of the dimensions.length=15, scale=2
identCode: type: string description: Identifier of the quantity unit (must be unique). Only "cm" is supported yet.length=10
description: DLCuboidDimensionsDTO with length, width, height and identCode. DLProcessPickupRequestDTO: required: - pickupReference - processParms type: object 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 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"]' pickupReference: $ref: '#/components/schemas/DLPickupReferenceDTO' creationParms: $ref: '#/components/schemas/DLPickupCreationParmsDTO' pickupUpdateData: $ref: '#/components/schemas/DLPickupUpdateRequestDataDTO' shipments: type: array description: Shipments to be added to the pickup. items: $ref: '#/components/schemas/DLShipmentReferenceDTO' processParms: $ref: '#/components/schemas/DLPickupProcessParmsDTO' description: Request DTO for the printDocumentsForPickup business facade method xml: name: processPickupRequestDTO DLPersonDTO: type: object properties: name: type: string description: 'Name of contact. > `length=80`' phone: type: string description: 'Phone number. > `length=20`' fax: type: string description: 'Fax number. > `length=20`' email: type: string description: 'Email address. > `length=256`' description: DLPersonDTO containing contact data. DLValueAddedServiceDTO: type: object properties: identCode: type: string description: The identCode of the entry.length=50
descriptions: type: array description: The description of the entry in the requested result languages. items: $ref: '#/components/schemas/TextInLanguageDTO' valueAddedServiceType: type: string description: 'The type of the value added service. Possible values:
length=20
' description: Response information about a value added service. DLAddShipmentAttachmentsResponseDTO: type: object 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' description: ' Response DTO for the addShipmentAttachments business facade method' xml: name: addShipmentAttachmentsResponseDTO securitySchemes: SWAGGER_AUTH_KEY: type: apiKey name: X-XNSG_WEB_TOKEN in: header BASIC_AUTH: type: http scheme: basic x-refined-from: - aeb-bsm-openapi.json - aeb-carrier-connect-openapi.json x-proxy-enabled: false