openapi: 3.2.0 info: title: BSM (TEST2) HTTP LISBF20 Bean API description: Thank you for using our HTTP API documentation. version: '1.0' servers: - url: https://rz3.aeb.de/test2bsm/rest security: - SWAGGER_AUTH_KEY: [] - BASIC_AUTH: [] tags: - name: LISBF20Bean description: Business facade for LIS, version 2.0 paths: /LISBF20Bean/calculateTargetTime: post: tags: - LISBF20Bean summary: calculateTargetTime description: Determines the event chain for the given plan and performs a backward calculation starting with the given delivery date in the request. The resulting shipping date is returned in the response. operationId: calculateTargetTime requestBody: content: application/json: schema: $ref: '#/components/schemas/TargetTimeCalculationRequestDTO' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/TargetTimeCalculationResponseDTO' security: - BASIC_AUTH: [] /LISBF20Bean/getConsignments: post: tags: - LISBF20Bean summary: getConsignments description: Returns a list of consignments for the given requestDTO operationId: getConsignments requestBody: content: application/json: schema: $ref: '#/components/schemas/LISConsignmentRequest20DTO' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/LISExpConsignmentList20DTO' security: - BASIC_AUTH: [] /LISBF20Bean/getDocumentCategories: post: tags: - LISBF20Bean summary: getDocumentCategories description: Returns the document categories for a requested client. operationId: getDocumentCategories requestBody: content: application/json: schema: $ref: '#/components/schemas/GetDocumentCategoriesRequestDTO' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/GetDocumentCategoriesResponseDTO' security: - BASIC_AUTH: [] /LISBF20Bean/getEventDefinitions: post: tags: - LISBF20Bean summary: getEventDefinitions description: Returns all event definitions found for the given requestDTO. operationId: getEventDefinitions requestBody: content: application/json: schema: $ref: '#/components/schemas/LISEventDefinitionRequest20DTO' responses: default: description: default response content: application/json: schema: type: array items: $ref: '#/components/schemas/LISEventDefinition20DTO' security: - BASIC_AUTH: [] /LISBF20Bean/getMODocument: post: tags: - LISBF20Bean summary: getMODocument description: Returns a document by its key. The key can be determined by calling the sync or export. It is mentioned in LISExpDocumentMetadata20DTO operationId: getMODocument requestBody: content: application/json: schema: $ref: '#/components/schemas/GetMODocumentRequestDTO' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/GetMODocumentResponseDTO' security: - BASIC_AUTH: [] /LISBF20Bean/getOrderFulfillmentPlans: post: tags: - LISBF20Bean summary: getOrderFulfillmentPlans description: Returns all order fulfillment plans for the given requestDTO. The order fulfilment steps of a plan come sorted by their sequence number. The events of a step come partially sorted. The milestone events sorted by their sort number. Then the monitored events unsorted. operationId: getOrderFulfillmentPlans requestBody: content: application/json: schema: $ref: '#/components/schemas/LISOrderFulfillmentRequest20DTO' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/LISOrderFulfillmentResult20DTO' security: - BASIC_AUTH: [] /LISBF20Bean/getQuickSearchResult: post: tags: - LISBF20Bean summary: getQuickSearchResult description: "Perform a quick search for the given requestDTO.\n The search will deliver the same results that would be obtained when a search term (reference number) would be entered in the quick search application GUI (located in the assistent pane of the Assist4Monitoring & Alerting desktop). Therefore the user's settings of the user specified in the requestDTO will be applied while conducting the search." operationId: getQuickSearchResult requestBody: content: application/json: schema: $ref: '#/components/schemas/LISQuickSearchRequest20DTO' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/LISExpQuickSearchResult20DTO' security: - BASIC_AUTH: [] /LISBF20Bean/getTrackingEvents: post: tags: - LISBF20Bean summary: getTrackingEvents description: Returns all tracking events for the given requestDTO. operationId: getTrackingEvents requestBody: content: application/json: schema: $ref: '#/components/schemas/LISTrackingEventExportRequest20DTO' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/LISExpTrackingEventList20DTO' security: - BASIC_AUTH: [] /LISBF20Bean/getTrackingObjectEvents: post: tags: - LISBF20Bean summary: getTrackingObjectEvents description: Returns the events of a single tracking object referenced in the requestDTO. The allowed tracking object types in the reference DTO are 'CONS' and 'HANDUNIT'. operationId: getTrackingObjectEvents requestBody: content: application/json: schema: $ref: '#/components/schemas/LISTrackingObjectEventRequest20DTO' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/LISExpTrackingObjectEventList20DTO' security: - BASIC_AUTH: [] /LISBF20Bean/getUniqueConsignment: post: tags: - LISBF20Bean summary: getUniqueConsignment description: Returns detailed information of a single consignment referenced in the requestDTO operationId: getUniqueConsignment requestBody: content: application/json: schema: $ref: '#/components/schemas/LISUniqueConsignmentRequest20DTO' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/LISExpConsignment20DTO' security: - BASIC_AUTH: [] /LISBF20Bean/lisBfDummyMethod: post: tags: - LISBF20Bean summary: lisBfDummyMethod description: Dummy method for testing. operationId: lisBfDummyMethod parameters: - name: argument in: query description: argument schema: type: string responses: default: description: default response content: application/text: schema: type: string security: - BASIC_AUTH: [] /LISBF20Bean/receiveAreaDependSchedule: post: tags: - LISBF20Bean summary: receiveAreaDependSchedule description: Receive a "Area depend schedule" message. This creates a area depend schedule in the system. operationId: receiveAreaDependSchedule requestBody: content: application/json: schema: $ref: '#/components/schemas/LISAreaDependScheduleDTO' responses: default: description: default response content: application/json: {} security: - BASIC_AUTH: [] /LISBF20Bean/receiveConsignment: post: tags: - LISBF20Bean summary: receiveConsignment description: Receive a "Consignment" message. This creates a consignment in the system. operationId: receiveConsignment requestBody: content: application/json: schema: $ref: '#/components/schemas/LISConsignment20DTO' responses: default: description: default response content: application/json: {} security: - BASIC_AUTH: [] /LISBF20Bean/receiveConsignmentWithTransports: post: tags: - LISBF20Bean summary: receiveConsignmentWithTransports description: Receive a "ConsignmentWithTransports" message. This creates a shipment in the system. operationId: receiveConsignmentWithTransports requestBody: content: application/json: schema: $ref: '#/components/schemas/LISConsignmentWithTransports20DTO' responses: default: description: default response content: application/json: {} security: - BASIC_AUTH: [] /LISBF20Bean/receiveEventCodeList: post: tags: - LISBF20Bean summary: receiveEventCodeList description: Receive a "Event code list" message. operationId: receiveEventCodeList requestBody: content: application/json: schema: $ref: '#/components/schemas/LISEventCodeListDTO' responses: default: description: default response content: application/json: {} security: - BASIC_AUTH: [] /LISBF20Bean/receiveHandlingUnits: post: tags: - LISBF20Bean summary: receiveHandlingUnits description: Receive a "HandlingUnits" message. That message can contain one or more handling units at the same time. operationId: receiveHandlingUnits requestBody: content: application/json: schema: $ref: '#/components/schemas/LISHandlingUnitReceiveRequest20DTO' responses: default: description: default response content: application/json: {} security: - BASIC_AUTH: [] /LISBF20Bean/receiveMaterialMasterFile: post: tags: - LISBF20Bean summary: receiveMaterialMasterFile description: Receive a "MaterialMasterFile" message. This creates a master data entries for materials. operationId: receiveMaterialMasterFile requestBody: content: application/json: schema: $ref: '#/components/schemas/LISMaterialMasterFileDTO' responses: default: description: default response content: application/json: {} security: - BASIC_AUTH: [] /LISBF20Bean/receiveMultiReferenceTrackingObjectDocuments: post: tags: - LISBF20Bean summary: receiveMultiReferenceTrackingObjectDocuments description: Receive a "TrackingObjectDocument" message with multiple references. operationId: receiveMultiReferenceTrackingObjectDocuments requestBody: content: application/json: schema: $ref: '#/components/schemas/LISMultiReferenceTrackingObjectDocuments20DTO' responses: default: description: default response content: application/json: {} security: - BASIC_AUTH: [] /LISBF20Bean/receiveOrder: post: tags: - LISBF20Bean summary: receiveOrder description: Receive a "Order" message. This creates an order in the system. operationId: receiveOrder requestBody: content: application/json: schema: $ref: '#/components/schemas/LISOrder20DTO' responses: default: description: default response content: application/json: {} security: - BASIC_AUTH: [] /LISBF20Bean/receivePhysicalTransport: post: tags: - LISBF20Bean summary: receivePhysicalTransport description: Receive a "Physical Transport" message. operationId: receivePhysicalTransport requestBody: content: application/json: schema: $ref: '#/components/schemas/LISPhysicalTransport20DTO' responses: default: description: default response content: application/json: {} security: - BASIC_AUTH: [] /LISBF20Bean/receiveTrackingEvent: post: tags: - LISBF20Bean summary: receiveTrackingEvent description: Receive a "Tracking event" message. This creates a tracking event in the system. operationId: receiveTrackingEvent requestBody: content: application/json: schema: $ref: '#/components/schemas/LISTrackingEvent20DTO' responses: default: description: default response content: application/json: {} security: - BASIC_AUTH: [] /LISBF20Bean/receiveTrackingEventList: post: tags: - LISBF20Bean summary: receiveTrackingEventList description: Receive a "Tracking event list" message. This is a list containing multiple tracking events. operationId: receiveTrackingEventList requestBody: content: application/json: schema: $ref: '#/components/schemas/LISTrackingEventList20DTO' responses: default: description: default response content: application/json: {} security: - BASIC_AUTH: [] /LISBF20Bean/receiveTrackingObjectDocuments: post: tags: - LISBF20Bean summary: receiveTrackingObjectDocuments description: Receive a "TrackingObjectDocument" message. operationId: receiveTrackingObjectDocuments requestBody: content: application/json: schema: $ref: '#/components/schemas/LISTrackingObjectDocuments20DTO' responses: default: description: default response content: application/json: {} security: - BASIC_AUTH: [] /LISBF20Bean/receiveTransport: post: tags: - LISBF20Bean summary: receiveTransport description: Receive a "Transport" message. This creates a Transport in the system. operationId: receiveTransport requestBody: content: application/json: schema: $ref: '#/components/schemas/LISTransport20DTO' responses: default: description: default response content: application/json: {} security: - BASIC_AUTH: [] /LISBF20Bean/receiveTransportUnit: post: tags: - LISBF20Bean summary: receiveTransportUnit description: Receive a "TransportUnit" message. operationId: receiveTransportUnit requestBody: content: application/json: schema: $ref: '#/components/schemas/LISTransportUnit20DTO' responses: default: description: default response content: application/json: {} security: - BASIC_AUTH: [] /LISBF20Bean/resetConsignmentWithTransports: post: tags: - LISBF20Bean summary: resetConsignmentWithTransports description: Reset the status of a LISConsignment and all its transports. operationId: resetConsignmentWithTransports requestBody: content: application/json: schema: $ref: '#/components/schemas/LISConsignmentReferenceWithClientDTO' responses: default: description: default response content: application/json: {} security: - BASIC_AUTH: [] /LISBF20Bean/syncConsignments: post: tags: - LISBF20Bean summary: syncConsignments description: Allows the synchronization of client system transactions with the engine consignments. By the use of a `syncId` it is possible to return only `consignments` that have changed between two `syncConsignment` calls. operationId: syncConsignments requestBody: content: application/json: schema: $ref: '#/components/schemas/LISConsignmentSyncRequestDTO' responses: default: description: default response content: application/json: schema: $ref: '#/components/schemas/LISConsignmentSyncResponseDTO' security: - BASIC_AUTH: [] components: schemas: LISMODocumentCategoryDTO: type: object properties: identCode: type: string description: 'The ident code of the document category for the binary. Please see product documentation or an admin for possible document categories. > `length=15`' description: A single binary document category. LISExpConsignmentHead20DTO: type: object properties: consignmentNumber: type: string description: The number of the consignment.
length=40
termsOfDelivery: $ref: '#/components/schemas/LISTermsOfDeliveryDTO' shipperReference: type: string description: The reference number of the consignment given by the supplier (shipper) to the forwarder.length=40
consignmentType: type: string description: One of a list of constants for the type of consignments.length=20
orderer: $ref: '#/components/schemas/LISPartyDTO' buyer: $ref: '#/components/schemas/LISPartyDTO' consignee: $ref: '#/components/schemas/LISPartyLongDTO' supplier: $ref: '#/components/schemas/LISPartyDTO' shippingPoint: $ref: '#/components/schemas/LISPartyLongDTO' forwarderPickup: $ref: '#/components/schemas/LISPartyDTO' forwarderDeliv: $ref: '#/components/schemas/LISPartyDTO' carrierPickup: $ref: '#/components/schemas/LISPartyDTO' carrierDeliv: $ref: '#/components/schemas/LISPartyDTO' intConsignee: $ref: '#/components/schemas/LISPartyDTO' org1: $ref: '#/components/schemas/LISPartyShortDTO' expectedShippingDate: $ref: '#/components/schemas/LISDateAndZoneDTO' expectedDeliveryDate: $ref: '#/components/schemas/LISDateAndZoneDTO' actualShippingDate: $ref: '#/components/schemas/LISDateAndZoneDTO' actualDeliveryDate: $ref: '#/components/schemas/LISDateAndZoneDTO' fromWarehouse: $ref: '#/components/schemas/LISWarehouseDTO' toWarehouse: $ref: '#/components/schemas/LISWarehouseDTO' grossWeight: $ref: '#/components/schemas/LISQuantityDTO' netWeight: $ref: '#/components/schemas/LISQuantityDTO' volume: $ref: '#/components/schemas/LISQuantityDTO' freightChargeBuyer: $ref: '#/components/schemas/LISAmountOfMoneyDTO' freightChargeSupplier: $ref: '#/components/schemas/LISAmountOfMoneyDTO' goodsValue: $ref: '#/components/schemas/LISAmountOfMoneyDTO' totalValue: $ref: '#/components/schemas/LISAmountOfMoneyDTO' despatchType: $ref: '#/components/schemas/LISDespatchTypeDTO' note: type: string description: The note of the consignment.length=950
loadingMetre: type: number description: The loading meter of the consignment.length=15, scale=3
palletSlots: type: number description: The pallet slots of the consignment.length=10, scale=1
goodsDescription: type: string description: The description of the goods of the consignment.length=250
earliestShippingDate: $ref: '#/components/schemas/LISDateAndZoneDTO' latestShippingDate: $ref: '#/components/schemas/LISDateAndZoneDTO' plannedShippingDate: $ref: '#/components/schemas/LISDateAndZoneDTO' earliestDeliveryDate: $ref: '#/components/schemas/LISDateAndZoneDTO' latestDeliveryDate: $ref: '#/components/schemas/LISDateAndZoneDTO' plannedDeliveryDate: $ref: '#/components/schemas/LISDateAndZoneDTO' priority: type: string description: The priority of the consignment.length=40
uniqueCustomsRefNo: type: string description: Unique Customs reference number (URN).length=20
customsEntryNo: type: string description: Customs entry number (CEN).length=20
uniqueCustRefNoPerCons: type: string description: Unique Customs reference number per consignment (UCR).length=20
deliveryBookingRef: type: string description: The delivery booking reference of the consignment.length=20
forwarderPickupRef: type: string description: The forwarder pickup reference of the consignment.length=20
forwarderDelivRef: type: string description: The forwarder delivery reference of the consignment.length=20
carrierPickupRef: type: string description: The carrier pickup reference of the consignment.length=20
carrierDelivRef: type: string description: The carrier delivery reference of the consignment.length=20
masterWayBill_lastTransport: type: string description: The master waybill number of the last transport.length=40
podSignature_lastTransport: type: string description: The signer of the last transport.length=20
numberOfHandlingUnits: type: integer description: Number of handling units of the consignment.length=10
format: int32 publicURL: type: string description: The url of the public application of the consignment dataSourceIDHost: type: string description: The ID which describes the type of the original business object in the origin system. It can be used to re-identify the object if it is exported/synchronized with the origin system.length=250
toFilterCriteria: type: string description: Additional filter criteria. Free definable text that can be used as an additional filter criteria for the search in filters.length=100
description: The consignment header data to be sent to a partner system. LISHandlingUnitWrapper20DTO: type: object properties: handlingUnit: $ref: '#/components/schemas/LISHandlingUnitExt20DTO' documents: type: array description: Documents of the handling unit. items: $ref: '#/components/schemas/LISBinaryDTO' archivedDocuments: type: array description: The storage data of the archived documents of the handling unit. items: $ref: '#/components/schemas/LISArchiveDocumentDTO' description: DTO that bundles a handling unit together to documents. LISHUTrackingEventExternalTargetDateDTO: type: object properties: eventIdentCode: type: string description: The identCode of the event. targetDate: $ref: '#/components/schemas/LISDateAndZoneDTO' transportReferences: type: array description: The sequence number of the transport. items: $ref: '#/components/schemas/LISTrackingObjectReferenceField20DTO' description: DTO containing the event code of a milestone and new target date for this milestone. Additionally a reference to a transport as it is connected to a handling unit DTO, but meant to update a HUTL. LISEventCodeListHeadDTO: type: object properties: identCode: type: string description: Short form of the event code list. description: type: string description: Description of the event code list. description: Header data of the event code list. LISExpConsignmentList20DTO: type: object properties: consignments: type: array description: The list of consignments found. May be incomplete, see 'isCompleteList'. items: $ref: '#/components/schemas/LISExpConsignmentListEntry20DTO' resultStatus: type: string description: "Flag showing the state of success of the conducted search. Possible values are:length=40
orderItemNumberSupplier: type: string description: The item number of the supplier.length=40
projectNumberBuyer: type: string description: A project number (e.g. promotion deal number) given by the buyer .length=40
projectNumberSupplier: type: string description: A project number (e.g. promotion deal number) given by the supplier .length=40
expectedDeliveryDate: $ref: '#/components/schemas/LISDateAndZoneDTO' actualDeliveryDate: $ref: '#/components/schemas/LISDateAndZoneDTO' orderACKDate: $ref: '#/components/schemas/LISDateAndZoneDTO' consignee: $ref: '#/components/schemas/LISPartyLongDTO' org1: $ref: '#/components/schemas/LISPartyShortDTO' fromWarehouse: $ref: '#/components/schemas/LISWarehouseDTO' toWarehouse: $ref: '#/components/schemas/LISWarehouseDTO' material: $ref: '#/components/schemas/LISMaterialDTO' quantityOrdered: $ref: '#/components/schemas/LISQuantityDTO' quantityGranted: $ref: '#/components/schemas/LISQuantityDTO' quantityPOD: $ref: '#/components/schemas/LISQuantityDTO' goodsValue: $ref: '#/components/schemas/LISAmountOfMoneyDTO' note: type: string description: The note of the order item.length=40
expectedShippingDate: $ref: '#/components/schemas/LISDateAndZoneDTO' actualShippingDate: $ref: '#/components/schemas/LISDateAndZoneDTO' salesNetPrice: $ref: '#/components/schemas/LISAmountOfMoneyDTO' purchaseNetPrice: $ref: '#/components/schemas/LISAmountOfMoneyDTO' cataloguePrice: $ref: '#/components/schemas/LISAmountOfMoneyDTO' dimensions: $ref: '#/components/schemas/LISDimensionsDTO' callNumber: type: string description: The call number of the item.length=40
earliestDeliveryDate: $ref: '#/components/schemas/LISDateAndZoneDTO' latestDeliveryDate: $ref: '#/components/schemas/LISDateAndZoneDTO' earliestShippingDate: $ref: '#/components/schemas/LISDateAndZoneDTO' latestShippingDate: $ref: '#/components/schemas/LISDateAndZoneDTO' handoverLoc: $ref: '#/components/schemas/LISLocationDTO' volume: $ref: '#/components/schemas/LISQuantityDTO' unitVolume: $ref: '#/components/schemas/LISQuantityDTO' grossWeight: $ref: '#/components/schemas/LISQuantityDTO' unitGrossWeight: $ref: '#/components/schemas/LISQuantityDTO' netWeight: $ref: '#/components/schemas/LISQuantityDTO' unitNetWeight: $ref: '#/components/schemas/LISQuantityDTO' genericIdentifier: type: array description: The generic Identifiers (Strings) that can be used to identify this OrderItem.length=40
items: type: string description: The generic Identifiers (Strings) that can be used to identify this OrderItem.length=40
description: An item of a purchase order. LISExpTrackingEvent20DTO: type: object properties: documents: type: array description: The documents of the event items: $ref: '#/components/schemas/LISExpMODocument20DTO' documentMetadata: type: array description: The meta data of the documents of the event items: $ref: '#/components/schemas/LISExpDocumentMetadata20DTO' identCode: type: string description: Status identCode of the event.length=20
description: type: string description: Description of the event in the requested language. Equals identCode, when the event is not customized or when the language can't be determined (e.g. when used in a request without language parameter).length=250
reason: type: string description: The code of the reason for the eventlength=20
reasonResponsiblePartner: type: string description: The responsible party for the reason of the eventlength=20
actualDate: $ref: '#/components/schemas/LISDateAndZoneDTO' actualLocation: $ref: '#/components/schemas/LISLocationDTO' plannedLocation: $ref: '#/components/schemas/LISLocationDTO' actualSender: $ref: '#/components/schemas/LISPartyDTO' plannedSender: $ref: '#/components/schemas/LISPartyDTO' info: type: string description: Additional information about the event.length=1000
expectedDate: $ref: '#/components/schemas/LISDateAndZoneDTO' plannedDate: $ref: '#/components/schemas/LISDateAndZoneDTO' sendDate: $ref: '#/components/schemas/LISDateAndZoneDTO' eventType: type: string description: 'The event type of the event
One of these values:length=40
shortName: type: array description: The short name of the event in the requested languages.length=50 (text)
items: $ref: '#/components/schemas/TextInLanguageDTO' name: type: array description: The name of the event in the requested languages.length=250 (text)
items: $ref: '#/components/schemas/TextInLanguageDTO' eventTypeMultiLang: type: array description:The event type of the event in the requested languages
items: $ref: '#/components/schemas/TextInLanguageDTO' description: DTO to export trackingevent data to partner systems like the Message Engine Logistics. LISDurationDTO: type: object properties: endTo: $ref: '#/components/schemas/LISTimeDTO' durationValue: type: integer description: Value of the duration. format: int32 durationUnit: type: string description: 'String containing the unit of the duration. Possible duration units: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' categories: type: array description: The returned categories of the requested client. xml: wrapped: true items: $ref: '#/components/schemas/LISExpMODocumentCategoryDTO' description: Response for a document categories request. LISRequestIdentification20DTO: required: - client - language - user type: object properties: client: maxLength: 10 type: string description: 'The ident code of the client the request is made for. > `length=10`' user: maxLength: 20 type: string description: The login name of the user making the request. language: type: string description: The language to be used. enum: - DE - EN description: DTO suppliying the identification information for making requests. LISOrder20DTO: type: object properties: metaData: $ref: '#/components/schemas/LISMessageMetaDataDTO' head: $ref: '#/components/schemas/LISOrderHead20DTO' items: type: array description: The items of the purchase order. items: $ref: '#/components/schemas/LISOrderItem20DTO' documents: type: array description: Documents of the purchase order. items: $ref: '#/components/schemas/LISBinaryDTO' archivedDocuments: type: array description: The storage data of the archived documents of the purchase order items: $ref: '#/components/schemas/LISArchiveDocumentDTO' isWithoutReferenceItem: type: boolean description: Indication whether the order should use (and create) a reference item. Default is `false` default: false isDataComplete: type: boolean description: 'Indication whether the order is data complete. If left empty: default for new objects is `false`.' description: DTO for order messages Version 2.0 LISArchiveDocumentDTO: type: object properties: documentName: type: string description: 'the name of the document e.g. a file name with extension. > `length=500`' mimetype: type: string description: the mimetype of the archived document e.g. application/pdf or image/jpeg byteSize: type: integer description: the byte size of the archived document format: int32 documentStorageID: type: string description: 'the unique storage id of the document in the archive system. > `length=50`' roles: type: array description: the roles for the binary to be displayed in the application items: $ref: '#/components/schemas/LISBinaryRoleDTO' documentCategories: type: array description: the documentCategories for the binary to be displayed in the application items: $ref: '#/components/schemas/LISMODocumentCategoryDTO' languageIsoCodes: type: array description: the languages for the binary to be displayed in the application items: type: string description: the languages for the binary to be displayed in the application additionalFields: type: array description: Additional fields of the document items: $ref: '#/components/schemas/LISAdditionalFieldDTO' description: DTO for document data that has been stored in an archive system e.g. Assist4ContentStorage and shall be accessed via VCP LISOrderFulfillmentPlan20DTO: type: object properties: hostCode: type: string description: The host code of the order fulfillment plan. Not always filled. Can be used to map the plan to an external object in the system of the caller. quantity: $ref: '#/components/schemas/LISQuantityDTO' isNotStartedFulfillment: type: boolean description: Marks a plan whose fulfillment has not yet begun. ofSteps: type: array description: The order fulfillment steps of the plan items: $ref: '#/components/schemas/LISOrderFulfillmentStep20DTO' description: DTO representing an order fulfillment plan LISTrackingObjectDocuments20DTO: type: object properties: metaData: $ref: '#/components/schemas/LISMessageMetaDataDTO' toReference: $ref: '#/components/schemas/LISTrackingObjectReference20DTO' documents: type: array description: The documents as binaries items: $ref: '#/components/schemas/LISBinaryDTO' archivedDocuments: type: array description: The storage data of the archived documents of the events items: $ref: '#/components/schemas/LISArchiveDocumentDTO' fileSystemDocuments: type: array description: File system data of the documents of the events items: $ref: '#/components/schemas/LISFileSystemDocumentDTO' description: A document message for a tracking object. LISHandlingUnitReceiveRequest20DTO: type: object properties: metaDataDTO: $ref: '#/components/schemas/LISMessageMetaDataDTO' handlingUnitWrapper: type: array description: Handling units of the message (can be more than one!). items: $ref: '#/components/schemas/LISHandlingUnitWrapper20DTO' documents: type: array description: Common documents for all the handling units. items: $ref: '#/components/schemas/LISBinaryDTO' archivedDocuments: type: array description: The storage data of the archived documents of the consignment items: $ref: '#/components/schemas/LISArchiveDocumentDTO' description: RequestDTO for handling of handling units, used in ILISBF20. LISUniqueConsignmentRequest20DTO: type: object properties: identificationDTO: $ref: '#/components/schemas/LISRequestIdentification20DTO' referenceDTO: $ref: '#/components/schemas/LISTrackingObjectReference20DTO' dataExtent: type: array description: 'Parameter used to request additional data for a consignment. If left empty, only header data for a consignment will be returned. > Possible values: > `INCLUDE_TRACKINGINFO`, `INCLUDE_CONSIGNMENT_ITEMS`, `INCLUDE_TRANSPORTS`, `INCLUDE_HANDLING_UNITS`, `INCLUDE_CONSIGNMENT_EVENTS`, `INCLUDE_HAZARDOUS_GOODS_DATA`' items: type: string description: 'Parameter used to request additional data for a consignment. If left empty, only header data for a consignment will be returned. > Possible values: > `INCLUDE_TRACKINGINFO`, `INCLUDE_CONSIGNMENT_ITEMS`, `INCLUDE_TRANSPORTS`, `INCLUDE_HANDLING_UNITS`, `INCLUDE_CONSIGNMENT_EVENTS`, `INCLUDE_HAZARDOUS_GOODS_DATA`' description: DTO with parameters to request details for a specific consignment LISAreaDependScheduleFilterLCHandlingDTO: type: object properties: sortNumber: type: integer description: sortNumber of the schedule filter format: int32 areaPreviousEventIdentCode: type: string description: identCode of the area (previous event) of the schedule filter areaActualEventIdentCode: type: string description: identCode of the area (actual event) of the schedule filter dayTypeSchedules: type: array description: dayTypeSchedules of the schedule filter items: $ref: '#/components/schemas/LISDayTypeScheduleDTO' periodicStartSchedules: type: array description: periodicStartSchedules of the schedule filter items: $ref: '#/components/schemas/LISPeriodicStartScheduleDTO' usesPeriodicStartSchedule: type: boolean description: uses Departure Schedule of the schedule filter trackingObjectFilter: $ref: '#/components/schemas/LISTrackingObjectFilterLCHandlingDTO' description: DTO for handling AreaDependScheduleFilters LISEventDefinitionRequest20DTO: type: object properties: trackingObjectType: type: string description: The tracking object type of the event definitions. enum: - ORDER - CONS - TRANSLEG - HUTRANSLEG language: type: string description: The language iso code. Determines which language the values in the response will have. client: type: string description: The name of the client for which the event definitions shall be returned. description: Contains alle fields that are necessary to return a collection of LISEventDefinition20DTO's LISExpMODocumentCategoryIdentifierDTO: type: object properties: identCode: type: string description: The ident code of the document category.> `length=15` description: A unique identifier for a document category. LISTransportUnit20DTO: type: object properties: metaData: $ref: '#/components/schemas/LISMessageMetaDataDTO' head: $ref: '#/components/schemas/LISTransportUnitHead20DTO' references: type: array description: References for the transport unit, e.g. physical transports, which are associated with the transport unit. items: $ref: '#/components/schemas/LISTrackingObjectReference20DTO' isDataComplete: type: boolean description: 'Indication whether the transport unit is data complete. If left empty: default for new objects is `false`.' description: A transport unit message send by a partner. * LISTrackingObjectFilterLCStorageDTO: type: object properties: storageTypeIdentCode: type: string description: identCode of the storageType to filter location: $ref: '#/components/schemas/LISLocationDTO' description: 'DTO for TOFLCStorage.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: Response for a document categories request. LISPhysicalTransport20DTO: type: object properties: metaData: $ref: '#/components/schemas/LISMessageMetaDataDTO' head: $ref: '#/components/schemas/LISPhysicalTransportHead20DTO' references: type: array description: 'References for the physical transport The transport legs, which are associated with the physical transport. The associated transport units can be send in the `transportUnits` field' items: $ref: '#/components/schemas/LISTrackingObjectReference20DTO' documents: type: array description: Documents of the physical transport. items: $ref: '#/components/schemas/LISBinaryDTO' transportUnits: type: array description: Transport units of the physical transport items: $ref: '#/components/schemas/LISTransportUnitHead20DTO' archivedDocuments: type: array description: The storage data of the archived documents of the physical transport items: $ref: '#/components/schemas/LISArchiveDocumentDTO' isDataComplete: type: boolean description: 'Indication whether the transport is data complete. If left empty: default for new objects is `false`.' description: Phyiscal transport message. DateAndZoneDTO: type: object properties: dateInTimezone: type: string description: 'String representation of the date/time stamp in the format yyyy-MM-dd HH:mm:ss
Length: 19
' timezone: type: string description: 'Time zone of the time stamp.
Examples of valid time zones: "GMT+01:00" or "GMT-02:00".
Maximum length: 50
' description: Date and timezone. LISExpConsignmentListEntry20DTO: type: object properties: trackingInfo: $ref: '#/components/schemas/LISExpTrackingInfo20DTO' consignmentNumber: type: string description: The number of the consignment.length=40
forwarderDeliv: $ref: '#/components/schemas/LISPartyShortDTO' consignee: $ref: '#/components/schemas/LISPartyLongDTO' description: An entry in a consignment list e.g. retrieved by a search request. A consignment list entry is similar to a consignment head DTO, but contains only a small subset of the consigment fields. So it is optimized for bigger lists. LISConsignmentSyncRequestDTO: 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"]' syncId: type: string description: 'For delta-transmissions after initialization. Fill this field with the `syncId` returned in the last call of `syncConsignments`. > `length=20`' dataExtent: type: array description: 'Parameter used to request additional data for a consignment. If left empty, only header data for a consignment will be returned. > Possible values: `INCLUDE_TRACKINGINFO`, `INCLUDE_CONSIGNMENT_ITEMS`, `INCLUDE_TRANSPORTS`, `INCLUDE_HANDLING_UNITS`, `INCLUDE_CONSIGNMENT_EVENTS`, `INCLUDE_TRACKING_EVENTS`, `INCLUDE_DOCUMENTS`, `INCLUDE_HU_TRANSPORTS`, `INCLUDE_HAZARDOUS_GOODS_DATA`' items: type: string description: 'Parameter used to request additional data for a consignment. If left empty, only header data for a consignment will be returned. > Possible values: `INCLUDE_TRACKINGINFO`, `INCLUDE_CONSIGNMENT_ITEMS`, `INCLUDE_TRANSPORTS`, `INCLUDE_HANDLING_UNITS`, `INCLUDE_CONSIGNMENT_EVENTS`, `INCLUDE_TRACKING_EVENTS`, `INCLUDE_DOCUMENTS`, `INCLUDE_HU_TRANSPORTS`, `INCLUDE_HAZARDOUS_GOODS_DATA`' description: Request DTO for consignment synchronization. LISExpMODocumentCategoryTextDTO: required: - languageISOCode type: object properties: languageISOCode: type: string description: ISO code of the language of the description.length=2
example: de name: type: string description: The localized name of the document category.> `length=50` description: type: string description: The localized description of the document category.> `length=250` description: Texts for a document category LISConsignmentWithTransports20DTO: type: object properties: metaData: $ref: '#/components/schemas/LISMessageMetaDataDTO' head: $ref: '#/components/schemas/LISConsignmentHead20DTO' items: type: array description: The items of the consignment. items: $ref: '#/components/schemas/LISConsignmentItem20DTO' handlingUnits: type: array description: The handling units of the consignment. items: $ref: '#/components/schemas/LISHandlingUnit20DTO' consItemInHandlingUnits: type: array description: Which consignment items are packed in which handling units. items: $ref: '#/components/schemas/LISConsItemInHandlingUnit20DTO' documents: type: array description: Documents of the consignment. items: $ref: '#/components/schemas/LISBinaryDTO' archivedDocuments: type: array description: The storage data of the archived documents of the consignment items: $ref: '#/components/schemas/LISArchiveDocumentDTO' isWithoutReferenceItem: type: boolean description: Indication whether the consignment should use (and create) a reference item isDataComplete: type: boolean description: 'Indication whether the consignment is data complete. Possible values: true or false. If left empty: default for new objects is ''false''.' transports: type: array description: The tranports of the consignment. items: $ref: '#/components/schemas/LISTransport20DTO' description: DTO for a consignment with all transports. LISPeriodicStartScheduleDTO: type: object properties: startTime: $ref: '#/components/schemas/LISTimeDTO' duration: $ref: '#/components/schemas/LISDurationDTO' startDayType: type: string description: 'String containing the start day type (Using one of the DAY_TYPE constants). Determines which departure schedule will be used.length=40
shipperReferenceTransport: type: string description: Reference number for the forwarder given by the shipper.length=40
forwarder: $ref: '#/components/schemas/LISPartyDTO' handlingUnitNumberFrom: type: string description: The number of the handling unit given by the supplier. RFF-Segment below PAC segment.length=40
equipmentNumber: type: string description: The number of the equipment.length=40
globalTransactionNumber: type: string description: Global unique number to identity the transport clearly.length=40
supplier: $ref: '#/components/schemas/LISPartyDTO' carrierReference: type: string description: Reference number of the carrierlength=40
forwarderReference: type: string description: Reference number of the forwarderlength=40
houseAirwayBillNumber: type: string description: House airwa bill number of the transportlength=40
masterWayBillNumberTransport: type: string description: The master waybill number of the transport given by the forwarder.length=40
deliveryNoteNumber: type: string description: The delivery note number.length=40
globalUnitNumber: type: string description: Unique number to identify a handlingunit Without this number no hu tracking is possiblelength=100
masterWayBillNumberHandlingUnit: type: string description: The master waybill number of the handling unit SG13/RFF Segment, Element 1154length=40
serialShippingContainerCode: type: string description: The serial shipping container code of the handling unitlength=40
shipperReferenceHandlingUnit: type: string description: Reference number for the forwarder given by the shipper within the handling unit.length=40
carrier: $ref: '#/components/schemas/LISPartyDTO' despatchType: $ref: '#/components/schemas/LISDespatchTypeDTO' endLoc: $ref: '#/components/schemas/LISLocationDTO' meansOfTransport: $ref: '#/components/schemas/LISMeansOfTransportDTO' podSignatureName: type: string description: POD signature name of the transport.length=20
priority: type: string description: The priority of the transport.length=40
serviceType: $ref: '#/components/schemas/LISServiceTypeDTO' startLoc: $ref: '#/components/schemas/LISLocationDTO' transportLegType: $ref: '#/components/schemas/LISTransportTypeDTO' termsOfDelivery: $ref: '#/components/schemas/LISTermsOfDeliveryDTO' plannedShippingDate: $ref: '#/components/schemas/LISDateAndZoneDTO' plannedArrivalDate: $ref: '#/components/schemas/LISDateAndZoneDTO' actualShippingDate: $ref: '#/components/schemas/LISDateAndZoneDTO' actualArrivalDate: $ref: '#/components/schemas/LISDateAndZoneDTO' grossWeight: $ref: '#/components/schemas/LISQuantityDTO' netWeight: $ref: '#/components/schemas/LISQuantityDTO' equipmentType: $ref: '#/components/schemas/LISEquipmentTypeDTO' toFilterCriteria: type: string description: Additional filter criteria. Free definable text that can be used as an additional filter criteria for the search in filters.length=100
description: DTO to export handling unit transport data to partner systems like the Message Engine Logistics. LISCESDocumentDTO: type: object properties: name: type: string description: 'The name of the document. This might be a file name with extension, but can be some abstract number, too. Corresponds to the messagePoolId in the CES. > `length=200`' contentType: type: string description: 'The content type of the stored document e.g. EDIFACT or CSV Note: The content of this field will be stored in the description of the document. > `length=30`' byteSize: type: integer description: 'the byte size of the stored document. > `length=10`' format: int32 documentKey: type: string description: 'The key of the document. This is calculated from the configurationIdentCode and the digest in CES. > `length=100`' receivedAt: $ref: '#/components/schemas/DateAndZoneDTO' contentInfo: type: string description: CESProvidedTrackingData.contentInfo, e.g. "PushApi", or the converter identifier contentSource: type: string description: Information about the technical source of the data content. roles: type: array description: the roles for the binary to be displayed in the application items: $ref: '#/components/schemas/LISBinaryRoleDTO' documentCategories: type: array description: the documentCategories for the binary to be displayed in the application items: $ref: '#/components/schemas/LISMODocumentCategoryDTO' languageIsoCodes: type: array description: the languages for the binary to be displayed in the application items: type: string description: the languages for the binary to be displayed in the application additionalFields: type: array description: Additional fields of the document items: $ref: '#/components/schemas/LISAdditionalFieldDTO' description: DTO for document data that has been stored in a CES partner server and shall be accessed via VCP LISAreaDependScheduleFilterOrderItemDTO: type: object properties: sortNumber: type: integer description: sortNumber of the schedule filter format: int32 areaPreviousEventIdentCode: type: string description: identCode of the area (previous event) of the schedule filter areaActualEventIdentCode: type: string description: identCode of the area (actual event) of the schedule filter dayTypeSchedules: type: array description: dayTypeSchedules of the schedule filter items: $ref: '#/components/schemas/LISDayTypeScheduleDTO' periodicStartSchedules: type: array description: periodicStartSchedules of the schedule filter items: $ref: '#/components/schemas/LISPeriodicStartScheduleDTO' usesPeriodicStartSchedule: type: boolean description: uses Departure Schedule of the schedule filter trackingObjectFilter: $ref: '#/components/schemas/LISTrackingObjectFilterOrderItemDTO' description: DTO for order item AreaDependScheduleFilters LISTrackingEventReferenceField20DTO: type: object properties: referenceField: type: string description: 'ReferenceField can hold one of the constants REF_FIELD-XYZ constants. It depends on the trackingEventType which field makes sense. > Valid values: > `ORDER_NO`: To be used when the type type of order number is unknown. It might be order number buyer or supplier. If the type of order number is known, use `ORDER_NO_BUYER` or `ORDER_NO_SUPPLIER` instead.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' planResults: type: array description: The results for the given plans in the request. If a target time calculation for a particular plan was not possible, no result will be included in this response. items: $ref: '#/components/schemas/TargetTimeCalculationPlanResultDTO' diagnosisLogs: type: array description: If requested, the diagnosis logs of the plans will be put here. items: $ref: '#/components/schemas/TargetTimeCalculationDiagnosisLogDTO' description: Response of a target time calculation LISTrackingObjectEventRequest20DTO: type: object properties: identificationDTO: $ref: '#/components/schemas/LISRequestIdentification20DTO' referenceDTO: $ref: '#/components/schemas/LISTrackingObjectReference20DTO' description: DTO with parameters to request the tracking events for a specific tracking object LISMaterialMasterFileHeadDTO: required: - globalTradeItemNumber type: object properties: globalTradeItemNumber: type: string description: Globaly unique identifier of the material. materialNumber: type: string description: Number of the material used by the origin party. unitCode: type: string description: The default unit code of the material. brandName: type: string description: Name of the brand of the material. productGroup1: type: string description: First product group of the material. productGroup2: type: string description: Second product group of the material. productGroup3: type: string description: Third product group of the material. originParty: $ref: '#/components/schemas/LISPartyDTO' refSupplierMaterial: $ref: '#/components/schemas/LISMaterialDTO' refSupplier: $ref: '#/components/schemas/LISPartyDTO' refBuyerMaterial: $ref: '#/components/schemas/LISMaterialDTO' refBuyer: $ref: '#/components/schemas/LISPartyDTO' firstOrderDate: $ref: '#/components/schemas/LISDateAndZoneDTO' lastPossibleOrderDate: $ref: '#/components/schemas/LISDateAndZoneDTO' dimensions: $ref: '#/components/schemas/LISDimensionsDTO' volume: $ref: '#/components/schemas/LISQuantityDTO' grossWeight: $ref: '#/components/schemas/LISQuantityDTO' netWeight: $ref: '#/components/schemas/LISQuantityDTO' minimalOrderQuantity: $ref: '#/components/schemas/LISQuantityDTO' minimalSalesQuantity: $ref: '#/components/schemas/LISQuantityDTO' storageCode: type: string description: Storage code of the material. e.g. Warehouse products or warehouse-to-store products. materialStatusIdentCode: type: string description: 'Identification code of the status of the material. e.g. A: active, D: discontinued, N: not to be ordered' cataloguePrice: $ref: '#/components/schemas/LISAmountOfMoneyDTO' netPrice: $ref: '#/components/schemas/LISAmountOfMoneyDTO' unitPriceBasisValue: type: number description: The basis value of the unit price e.g. 20 $ per 100 pce. countryOfOriginISOCode: type: string description: ISO Code of the country of origin of the material. substituteMaterial: $ref: '#/components/schemas/LISMaterialDTO' commodityCode: type: string description: Commodity code of the material. Conditionally. materialDescriptionLong: $ref: '#/components/schemas/LISTextTranslationDTO' materialDescriptionShort: $ref: '#/components/schemas/LISTextTranslationDTO' description: DTO for the material master file items. LISAreaDependScheduleFilterOrderDTO: type: object properties: sortNumber: type: integer description: sortNumber of the schedule filter format: int32 areaPreviousEventIdentCode: type: string description: identCode of the area (previous event) of the schedule filter areaActualEventIdentCode: type: string description: identCode of the area (actual event) of the schedule filter dayTypeSchedules: type: array description: dayTypeSchedules of the schedule filter items: $ref: '#/components/schemas/LISDayTypeScheduleDTO' periodicStartSchedules: type: array description: periodicStartSchedules of the schedule filter items: $ref: '#/components/schemas/LISPeriodicStartScheduleDTO' usesPeriodicStartSchedule: type: boolean description: uses Departure Schedule of the schedule filter trackingObjectFilter: $ref: '#/components/schemas/LISTrackingObjectFilterOrderDTO' description: DTO for order AreaDependScheduleFilters LISPartyShortDTO: type: object properties: globalLocationNumber: type: string description: 'Global Reference number of the party. > `length=20`' partyNumberBuyer: type: string description: 'Reference number of the party from the viewpoint of the buyers IT. > `length=40`' partyNumberSupplier: type: string description: 'Reference number of the party from the viewpoint of the suppliers IT. > `length=40`' partyNumberForwarder: type: string description: 'Reference number of the party from the viewpoint of the forwarders IT. > `length=40`' name: type: string description: 'Address name line 1. > `length=40`' description: Data transfer object to denote parties, e.g. buyer or seller, without address data. GetMODocumentResponseDTO: 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' document: $ref: '#/components/schemas/GetMODocumentDTO' description: Data Transfer Object for a get document result. LISTransportHead20DTO: type: object properties: idTransport: type: string description: 'Transport id. The technical unique ID of the transport. This field is used to reference the transport and to link it to other objects. It should not be filled with functional data and is not a prominent feature in the gui. However this is a mandatory field if the `idRefScheme` is set to `ID_REF_SCHEME_IDREFFIELDS`. > `length=150`' refConsignment: type: string description: 'Consignment reference. This field references the id of a consignment `idConsignment`. It is used to connect this transport to a specific consignment with exactly the same id. The field should not be filled with functional data and is not a prominent feature in the gui. > `length=150`' consignmentNumber: type: string description: 'The number of the consignment. > `length=40`' shipperReference: type: string description: 'Reference number for the forwarder given by the shipper. > `length=40`' masterWayBillNumber: type: string description: 'The master waybill number of the transport given by the forwarder. > `length=40`' plannedDepartureDate: $ref: '#/components/schemas/LISDateAndZoneDTO' plannedArrivalDate: $ref: '#/components/schemas/LISDateAndZoneDTO' actualDepartureDate: $ref: '#/components/schemas/LISDateAndZoneDTO' actualArrivalDate: $ref: '#/components/schemas/LISDateAndZoneDTO' serviceType: $ref: '#/components/schemas/LISServiceTypeDTO' goodsValue: $ref: '#/components/schemas/LISAmountOfMoneyDTO' freightCh: $ref: '#/components/schemas/LISAmountOfMoneyDTO' freightChPartner: $ref: '#/components/schemas/LISAmountOfMoneyDTO' numberOfHandlingUnits: type: integer description: "Number of handling units.\n > `length=10`" format: int32 netWeightKG: $ref: '#/components/schemas/LISQuantityDTO' grossWeightKG: $ref: '#/components/schemas/LISQuantityDTO' volumenM3: $ref: '#/components/schemas/LISQuantityDTO' loadingMetre: type: number description: 'Loading metres. > `length=15`, `scale=3`' transportLegType: $ref: '#/components/schemas/LISTransportTypeDTO' meansOfTransport: $ref: '#/components/schemas/LISMeansOfTransportDTO' startLoc: $ref: '#/components/schemas/LISLocationDTO' endLoc: $ref: '#/components/schemas/LISLocationDTO' forwarder: $ref: '#/components/schemas/LISPartyDTO' supplier: $ref: '#/components/schemas/LISPartyDTO' isForwSendingPUP: type: boolean description: True, if the forwarder sends the event PUP (Pickup). If the value is null, this will be computed from the forwarder master file data in LIS. isForwSendingPOD: type: boolean description: True, if the forwarder sends the event POD (Proof of Delivery). If the value is null, this will be computed from the forwarder master file data in LIS. globalTransactionNumber: type: string description: 'Global unique number to identity the transport clearly. > `length=40`' totalNumberOfTransportLegs: type: integer description: 'The total number of transport legs of the corresponding transport. > `length=10`' format: int32 sequenceNumber: type: integer description: 'The sequence number of this tansport leg in the corresponding transport. > `length=10`' format: int32 chargeableWeightKG: $ref: '#/components/schemas/LISQuantityDTO' distanceKM: type: number description: 'The distance of the transport in KM. > `length=10`, `scale=3`' palletFootprint: type: number description: 'Pallet footprint of the transport. > `length=15`, `scale=3`' shippingPoint: $ref: '#/components/schemas/LISPartyLongDTO' consignee: $ref: '#/components/schemas/LISPartyLongDTO' buyer: $ref: '#/components/schemas/LISPartyDTO' org1: $ref: '#/components/schemas/LISPartyShortDTO' costCenter: $ref: '#/components/schemas/LISPartyShortDTO' despatchType: $ref: '#/components/schemas/LISDespatchTypeDTO' termsOfDelivery: $ref: '#/components/schemas/LISTermsOfDeliveryDTO' note: type: string description: 'The note of the transport. > `length=950`' expectedDepartureDate: $ref: '#/components/schemas/LISDateAndZoneDTO' expectedArrivalDate: $ref: '#/components/schemas/LISDateAndZoneDTO' houseAirwayBillNumber: type: string description: 'House airway bill number. > `length=40`' priority: type: string description: 'The priority of the transport. > `length=40`' carrier: $ref: '#/components/schemas/LISPartyDTO' carrierReference: type: string description: 'Carrier reference of the transport. > `length=40`' forwarderReference: type: string description: 'Forwarder reference of the transport. > `length=40`' installationIDHost: type: string description: 'The ID of the sending system. It is used for the re-export of tracking events to the sending system. > `length=30`' dataSourceIDHost: type: string description: 'The ID which describes the type of the original business object in the sending system. It is used for the re-export of tracking events to the sending system. > `length=30`' additionalFields: type: array description: Additional fields of the transport leg items: $ref: '#/components/schemas/LISAdditionalFieldDTO' externalTargetDates: type: array description: The external target dates for specific tracking events. items: $ref: '#/components/schemas/LISTrackingEventExternalTargetDateDTO' toFilterCriteria: type: string description: 'Additional filter criteria for the transport. > `length=100`' description: DTO for transport legs. LISTrackingEventExportRequest20DTO: required: - eventType type: object properties: client: type: string description: The client of the events to export. This is a mandatory field. identCode: type: string description: The identCode of the events to export. Can be empty. blockSize: type: integer description: Number of events to be exported with this request. If 0 all events will be exported format: int32 eventType: type: string description: 'The event type of the events to export. Can be left empty to not filter for an eventType. > Possible Values: > `MILESTONE` for milestone events > `INFO` for info events > `WARNING` for warning events > `ERROR` for error events > `FATERROR` for fatal errors > `CANCELED` for canceled events > `MONITORED` for monitored events' enum: - MILESTONE - INFO - WARNING - ERROR - FATERROR - CANCELED - MONITORED trackingObjectType: type: string description: 'The tracking object type of the events to export. Can be left empty to not filter for a tracking object type.> Possible values: > `CONS` for shipment events > `TRANSLEG` for transport events > `HUTRANSLEG` for handling unit transport events > `ORDER` for orders > `ORDERITEM` for order items > `HANDUNIT` for handling units' enum: - CONS - TRANSLEG - HUTRANSLEG - ORDER - ORDERITEM - HANDUNIT installationIDHost: type: string description: The ID of the sending system. It is used for the re-export of tracking events to the sending system. dataSourceIDHost: type: string description: The ID which describes the type of the original business object in the sending system. It is used for the re-export of tracking events to the sending system. syncID: type: number description: Provides synchronisation data for the received tracking events by the invoking system description: The request DTO for a tracking event export GetMODocumentRequestDTO: required: - key 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"]' key: maxLength: 50 minLength: 20 type: string description: The key of the document to fetch. See LISExpDocumentMetadata20DTO.key description: Data transfer object to request one or several documents. LISTextTranslationDTO: type: object properties: translations: type: array description: The translated texts. items: $ref: '#/components/schemas/LISTextTranslationItemDTO' description: DTO for text translations. LISTrackingEvent20DTO: type: object properties: metaData: $ref: '#/components/schemas/LISMessageMetaDataDTO' head: $ref: '#/components/schemas/LISTrackingEventHead20DTO' references: type: array description: Data about Tracking event type and used reference number. The different references will be handled in a loop. Which means that they will be concatenated with `OR` items: $ref: '#/components/schemas/LISTrackingEventReference20DTO' documents: type: array description: Documents of the event. items: $ref: '#/components/schemas/LISBinaryDTO' archivedDocuments: type: array description: The storage data of the archived documents of the event items: $ref: '#/components/schemas/LISArchiveDocumentDTO' fileSystemDocuments: type: array description: File system data of the documents of the events items: $ref: '#/components/schemas/LISFileSystemDocumentDTO' cesDocuments: type: array description: CES partner system data of the documents of the events items: $ref: '#/components/schemas/LISCESDocumentDTO' description: DTO for Tracking events (envelope) LISHazardousGoodsItem20DTO: 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 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) 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/LISQuantityDTO' hazardNetQuantity: $ref: '#/components/schemas/LISQuantityDTO' netExplosiveWeight: $ref: '#/components/schemas/LISQuantityDTO' numberOfPackages: type: integer description: Number of packages -->do we really want to keept this fieldlength=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
isSpecialProvisionRequired: type: boolean description: Indicates if the special provision has to be marked. emergencyContact: $ref: '#/components/schemas/ContactDTO' 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
isPackingInstructionRequired: type: boolean description: Indicates if the packing instruction has to be marked. 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.
additionalFields:
type: array
description: Additional fields of the hazardous goods item
items:
$ref: '#/components/schemas/LISAdditionalFieldDTO'
description: This DTO describes a hazardous goods item.
LISTrackingObjectFilterConsignmentDTO:
type: object
properties:
consignmentTypeIdentCode:
type: string
description: identCode for the consignment type
despatchType:
$ref: '#/components/schemas/LISDespatchTypeDTO'
expectedShippingDateFrom:
$ref: '#/components/schemas/LISDateAndZoneDTO'
expectedShippingDateTo:
$ref: '#/components/schemas/LISDateAndZoneDTO'
areaRefShipPointIdentCode:
type: string
description: identCode of refShipPoint area
areaRefConsigneeIdentCode:
type: string
description: identCode of refConsignee area
carrierDelivery:
$ref: '#/components/schemas/LISPartyShortDTO'
forwarderDelivery:
$ref: '#/components/schemas/LISPartyShortDTO'
carrierPickup:
$ref: '#/components/schemas/LISPartyShortDTO'
forwarderPickup:
$ref: '#/components/schemas/LISPartyShortDTO'
priority:
type: string
description: Priority for the filter
areaRefOrdererIdentCode:
type: string
description: identCode of refOrderer area
refOrderer:
$ref: '#/components/schemas/LISPartyShortDTO'
toFilterCriteria:
type: string
description: additional filter criteria
description: DTO for TOFConsignment
LISExpMODocumentCategoryDTO:
type: object
properties:
identifier:
$ref: '#/components/schemas/LISExpMODocumentCategoryIdentifierDTO'
texts:
type: array
description: The names and descriptions of the document category in different languages.
xml:
wrapped: true
items:
$ref: '#/components/schemas/LISExpMODocumentCategoryTextDTO'
description: A single document category.
TargetTimeCalculationPlanResultStepDTO:
type: object
properties:
sequenceNumber:
type: integer
description: The sequence number of the step in a chain of steps. Used to sort the steps in the correct order.
format: int32
hostCode:
type: string
description: The host code of the order fulfillment step. Same as in request.
earliestStartDate:
$ref: '#/components/schemas/LISDateAndZoneDTO'
latestStartDate:
$ref: '#/components/schemas/LISDateAndZoneDTO'
earliestEndDate:
$ref: '#/components/schemas/LISDateAndZoneDTO'
latestEndDate:
$ref: '#/components/schemas/LISDateAndZoneDTO'
description: A single step of a target time calculation, identifiable by sequence number or host code
LISAreaDependScheduleFilterLCStorageDTO:
type: object
properties:
sortNumber:
type: integer
description: sortNumber of the schedule filter
format: int32
areaPreviousEventIdentCode:
type: string
description: identCode of the area (previous event) of the schedule filter
areaActualEventIdentCode:
type: string
description: identCode of the area (actual event) of the schedule filter
dayTypeSchedules:
type: array
description: dayTypeSchedules of the schedule filter
items:
$ref: '#/components/schemas/LISDayTypeScheduleDTO'
periodicStartSchedules:
type: array
description: periodicStartSchedules of the schedule filter
items:
$ref: '#/components/schemas/LISPeriodicStartScheduleDTO'
usesPeriodicStartSchedule:
type: boolean
description: uses Departure Schedule of the schedule filter
trackingObjectFilter:
$ref: '#/components/schemas/LISTrackingObjectFilterLCStorageDTO'
description: DTO for storage AreaDependScheduleFilters
LISConsignmentHead20DTO:
type: object
properties:
idConsignment:
type: string
description: 'Consignment id. The technical unique ID of the consignment. This field is used to reference the consignment and to link it to its items and units. It should not be filled with functional data and is not a prominent feature in the gui.
However this is a mandatory field if the `idRefScheme` in the Metadata is set to `ID_REF_SCHEME_IDREFFIELDS`.
> `length=150`'
consignmentNumber:
type: string
description: 'The number of the consignment.
> `length=40`'
termsOfDelivery:
$ref: '#/components/schemas/LISTermsOfDeliveryDTO'
shipperReference:
type: string
description: 'The reference number of the consignment given by the supplier (shipper) to the forwarder.
> `length=40`'
consignmentType:
type: string
description: 'One of a list of constants for the type of consignments. The consignment type will influence the status list and event chain.
> `length=20`'
orderer:
$ref: '#/components/schemas/LISPartyDTO'
buyer:
$ref: '#/components/schemas/LISPartyDTO'
consignee:
$ref: '#/components/schemas/LISPartyLongDTO'
supplier:
$ref: '#/components/schemas/LISPartyDTO'
shippingPoint:
$ref: '#/components/schemas/LISPartyLongDTO'
forwarderPickup:
$ref: '#/components/schemas/LISPartyDTO'
forwarderDeliv:
$ref: '#/components/schemas/LISPartyDTO'
carrierPickup:
$ref: '#/components/schemas/LISPartyDTO'
carrierDeliv:
$ref: '#/components/schemas/LISPartyDTO'
org1:
$ref: '#/components/schemas/LISPartyShortDTO'
costCenter:
$ref: '#/components/schemas/LISPartyShortDTO'
expectedShippingDate:
$ref: '#/components/schemas/LISDateAndZoneDTO'
expectedDeliveryDate:
$ref: '#/components/schemas/LISDateAndZoneDTO'
actualShippingDate:
$ref: '#/components/schemas/LISDateAndZoneDTO'
actualDeliveryDate:
$ref: '#/components/schemas/LISDateAndZoneDTO'
fromWarehouse:
$ref: '#/components/schemas/LISWarehouseDTO'
toWarehouse:
$ref: '#/components/schemas/LISWarehouseDTO'
grossWeight:
$ref: '#/components/schemas/LISQuantityDTO'
netWeight:
$ref: '#/components/schemas/LISQuantityDTO'
volume:
$ref: '#/components/schemas/LISQuantityDTO'
freightChargeBuyer:
$ref: '#/components/schemas/LISAmountOfMoneyDTO'
freightChargeSupplier:
$ref: '#/components/schemas/LISAmountOfMoneyDTO'
goodsValue:
$ref: '#/components/schemas/LISAmountOfMoneyDTO'
totalValue:
$ref: '#/components/schemas/LISAmountOfMoneyDTO'
despatchType:
$ref: '#/components/schemas/LISDespatchTypeDTO'
note:
type: string
description: 'The note of the consignment.
> `length=950`'
loadingMetre:
type: number
description: 'The loading meter of the consignment.
> `length=15`, `scale=3`'
palletSlots:
type: number
description: 'The pallet slots of the consignment.
> `length=10`, `scale=1`'
goodsDescription:
type: string
description: 'The description of the goods of the consignment.
> `length=250`'
earliestShippingDate:
$ref: '#/components/schemas/LISDateAndZoneDTO'
latestShippingDate:
$ref: '#/components/schemas/LISDateAndZoneDTO'
plannedShippingDate:
$ref: '#/components/schemas/LISDateAndZoneDTO'
earliestDeliveryDate:
$ref: '#/components/schemas/LISDateAndZoneDTO'
latestDeliveryDate:
$ref: '#/components/schemas/LISDateAndZoneDTO'
plannedDeliveryDate:
$ref: '#/components/schemas/LISDateAndZoneDTO'
priority:
type: string
description: 'The priority of the consignment.
> `length=40`'
uniqueCustomsRefNo:
type: string
description: 'Unique Customs reference number (URN).
> `length=20`'
customsEntryNo:
type: string
description: 'Customs entry number (CEN).
> `length=20`'
uniqueCustRefNoPerCons:
type: string
description: 'Unique Customs reference number per consignment (UCR).
> `length=20`'
deliveryBookingRef:
type: string
description: 'The delivery booking reference of the consignment.
> `length=20`'
forwarderPickupRef:
type: string
description: 'The forwarder pickup reference of the consignment.
> `length=20`'
forwarderDelivRef:
type: string
description: 'The forwarder delivery reference of the consignment.
> `length=20`'
carrierPickupRef:
type: string
description: 'The carrier pickup reference of the consignment.
> `length=20`'
carrierDelivRef:
type: string
description: 'The carrier delivery reference of the consignment.
> `length=20`'
isOrderShippingConsignment:
type: boolean
description: 'Controls the update of order shipping data with consignment data.
Should be set to true, if it is the first consignment in a chain of consignments for the delivery of an order or if the chain contains only one consignment.
If left empty: default for new consignments is ''true'', in updates the value remains unchanged.'
isOrderDeliveryConsignment:
type: boolean
description: 'Controls the update of order delivery data with consignment data.
Should be set to true, if it is the last consignment in a chain of consignments for the delivery of an order or if the chain contains only one consignment.
If left empty: default for new consignments is ''true'', in updates the value remains unchanged.'
intermediateConsignee:
$ref: '#/components/schemas/LISPartyDTO'
installationIDHost:
type: string
description: 'The ID of the sending system. It is used for the re-export of tracking events to the sending system.
> `length=30`'
dataSourceIDHost:
type: string
description: 'The ID which describes the type of the original business object in the sending system. It is used for the re-export of tracking events to the sending system.
> `length=250`'
additionalFields:
type: array
description: Additional fields of the consignment
items:
$ref: '#/components/schemas/LISAdditionalFieldDTO'
externalTargetDates:
type: array
description: The external target dates for specific tracking events.
items:
$ref: '#/components/schemas/LISTrackingEventExternalTargetDateDTO'
toFilterCriteria:
type: string
description: 'Additional filter criteria for the consignment.
> `length=100`'
transactionLabel:
type: string
description: 'Human readable text which identifies a consignment in the sending system.
> `length=250`'
description: 'Header data of the consignment. Valid for all items unless redefined there.
Version 2.0
Renamed fields compared to 1.0:
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. LISExpConsignmentItem20DTO: type: object properties: documents: type: array description: The documents of the consignment item items: $ref: '#/components/schemas/LISExpMODocument20DTO' genericIdentifier: type: array description: The generic Identifiers (Strings) that can be used to identify this ConsignmentItem.length=40
items: type: string description: The generic Identifiers (Strings) that can be used to identify this ConsignmentItem.length=40
documentMetadata: type: array description: The meta data of the documents of the consignment item items: $ref: '#/components/schemas/LISExpDocumentMetadata20DTO' itemNumber: type: string description: The number of the item within the consignment (given by the supplier).length=40
orderItemNumberBuyer: type: string description: The item number of the buyer of the order.length=40
orderItemNumberSupplier: type: string description: The item number of the supplier of the purchase order.length=40
orderNumberBuyer: type: string description: The order number of the buyer.length=40
orderNumberSupplier: type: string description: The order number of the supplier.length=40
projectNumberBuyer: type: string description: A project number (e.g. promotion deal number) given by the buyer .length=40
projectNumberSupplier: type: string description: A project number (e.g. promotion deal number) given by the supplier .length=40
deliveryNoteNumber: type: string description: A delivery note number given by the supplier.length=40
deliveryNoteDate: $ref: '#/components/schemas/LISDateAndZoneDTO' invoiceNumber: type: string description: A invoice number given by the supplier.length=40
invoiceDate: $ref: '#/components/schemas/LISDateAndZoneDTO' orderer: $ref: '#/components/schemas/LISPartyDTO' buyer: $ref: '#/components/schemas/LISPartyDTO' consignee: $ref: '#/components/schemas/LISPartyLongDTO' shippingPoint: $ref: '#/components/schemas/LISPartyLongDTO' org1: $ref: '#/components/schemas/LISPartyShortDTO' costCenter: $ref: '#/components/schemas/LISPartyShortDTO' fromWarehouse: $ref: '#/components/schemas/LISWarehouseDTO' toWarehouse: $ref: '#/components/schemas/LISWarehouseDTO' material: $ref: '#/components/schemas/LISMaterialDTO' quantitySendBySupplier: $ref: '#/components/schemas/LISQuantityDTO' quantityReceivedByBuyer: $ref: '#/components/schemas/LISQuantityDTO' distanceKM: type: integer description: The distance of the transport-chain in units of km.length=10, scale=3
format: int32 grossWeight: $ref: '#/components/schemas/LISQuantityDTO' netWeight: $ref: '#/components/schemas/LISQuantityDTO' volume: $ref: '#/components/schemas/LISQuantityDTO' note: type: string description: The note of the consignment item.length=950
orderDateBuyer: $ref: '#/components/schemas/LISDateAndZoneDTO' orderDateSupplier: $ref: '#/components/schemas/LISDateAndZoneDTO' goodsValue: $ref: '#/components/schemas/LISAmountOfMoneyDTO' salesNetPrice: $ref: '#/components/schemas/LISAmountOfMoneyDTO' purchaseNetPrice: $ref: '#/components/schemas/LISAmountOfMoneyDTO' cataloguePrice: $ref: '#/components/schemas/LISAmountOfMoneyDTO' dimensions: $ref: '#/components/schemas/LISDimensionsDTO' callNumber: type: string description: The call number of the item.length=40
customsStatus: type: string description: Customs tax status of item.length=20
hazardousGoodsItems: type: array description: Hazardous goods. items: $ref: '#/components/schemas/LISExpHazardousGoodsItem20DTO' description: The consignment item data to be sent to a partner system LISTrackingEventExternalTargetDateDTO: type: object properties: eventIdentCode: type: string description: The identCode of the event. targetDate: $ref: '#/components/schemas/LISDateAndZoneDTO' description: DTO containing the event code of a milestone and new target date for this milestone. LISExpStatus20DTO: type: object properties: id: type: integer description: ID number of the statuslength=10
format: int32 identCode: type: string description: Ident code of the statuslength=10
shortName: type: array description: The short name of the status in the requested languages.length=50 (text)
items: $ref: '#/components/schemas/TextInLanguageDTO' name: type: array description: The name of the status in the requested languages.length=250 (text)
items: $ref: '#/components/schemas/TextInLanguageDTO' description: DTO to export status data LISOFSTransport20DTO: type: object properties: transportType: $ref: '#/components/schemas/LISTransportTypeDTO' despatchType: $ref: '#/components/schemas/LISDespatchTypeDTO' serviceType: $ref: '#/components/schemas/LISServiceTypeDTO' startLoc: $ref: '#/components/schemas/LISLocationDTO' endLoc: $ref: '#/components/schemas/LISLocationDTO' forwarder: $ref: '#/components/schemas/LISPartyShortDTO' description: DTO containing the data for an order fulfillment step of type transport LISExpHandlingUnit20DTO: type: object properties: trackingInfo: $ref: '#/components/schemas/LISExpTrackingInfo20DTO' documents: type: array description: The documents of the handling unit items: $ref: '#/components/schemas/LISExpMODocument20DTO' events: type: array description: The events of the handling unit items: $ref: '#/components/schemas/LISExpTrackingEvent20DTO' documentMetadata: type: array description: The meta data of the documents of the handling unit items: $ref: '#/components/schemas/LISExpDocumentMetadata20DTO' handlingUnitNumberFrom: type: string description: The number of the handling unit given by the supplier. RFF-Segment below PAC segment.length=40
handlingUnitNumberTo: type: string description: The number of the handling unit given by the supplier. RFF-Segment below PAC segment.length=40
quantity: type: integer description: Number of handling units. Segment PAC, Element 7224.length=10
format: int32 handlingUnitType: $ref: '#/components/schemas/LISEquipmentTypeDTO' isOutmostHandlingUnit: type: boolean description: True if the handling unit is an outmost handling unit, not packed into another handling unit. The calculation of the number of handling units for the consignment regards only the outmost handlung units. netWeight: $ref: '#/components/schemas/LISQuantityDTO' grossWeight: $ref: '#/components/schemas/LISQuantityDTO' volume: $ref: '#/components/schemas/LISQuantityDTO' masterWayBillNumber: type: string description: The master waybill number of the handling unit SG13/RFF Segment, Element 1154length=40
note: type: string description: The note of the handling unit.length=950
serialShippingContainerCode: type: string description: The serial shipping container code of the handling unitlength=40
sealNumber: type: string description: The seal of the handling unit.length=40
globalUnitNumber: type: string description: Unique number to identify a handlingunit Without this number no hu tracking is possiblelength=100
chargeableWeight: $ref: '#/components/schemas/LISQuantityDTO' deliveryNoteNumber: type: string description: The delivery note number.length=40
equipmentNumber: type: string description: The number of the equipment.length=40
packedInGlobalUnitNumber: type: string description: The global unique number of the handling unit which contains this handling unit.length=100
invoiceNumber: type: string description: The invoice number.length=40
dimensions: $ref: '#/components/schemas/LISDimensionsDTO' hazardGoodsType: type: string description: Type of hazardous goods contained in the handling unit. hazardousGoodsData: $ref: '#/components/schemas/LISExpHandlingUnitHazardousGoodsData20DTO' toFilterCriteria: type: string description: Additional filter criteria. Free definable text that can be used as an additional filter criteria for the search in filters.length=100
description: The handling unit data to be sent to a partner system LISTrackingObjectFilterOrderDTO: type: object properties: orderTypeIdentCode: type: string description: identCode for the order type priority: type: string description: priority for the filter toFilterCriteria: type: string description: additional filter criteria description: DTO for CTOFOrder LISMaterialDTO: type: object properties: identCode: type: string description: 'Identcode of the material. > `length=40`' identCodeGTIN: type: string description: 'EAN Code of the material. > `length=40`' identCodeBuyer: type: string description: 'Identcode of the buyer of the material. > `length=40`' identCodeSupplier: type: string description: 'Identcode of the supplier of the material. > `length=40`' productGroup1Buyer: type: string description: '`length=40`' productGroup2Buyer: type: string description: '`length=40`' productGroup3Buyer: type: string description: '`length=40`' productGroup1Supplier: type: string description: '`length=40`' productGroup2Supplier: type: string description: '`length=40`' productGroup3Supplier: type: string description: '`length=40`' shortDescription: type: string description: 'Short description of the material. > `length=50`' description: type: string description: 'Name/Description of the material. > `length=250`' catalogueNumber: type: string description: 'The catalogue number of the material. > `length=40`' countryISOCode: type: string description: The country of origin ISO-Code of the material. > `length=2` discount: $ref: '#/components/schemas/LISAmountOfMoneyDTO' commodityCode: type: string description: 'The commodity code of the material. > `length=40`' season: type: string description: 'The season of the material. > `length=50`' size: type: string description: 'The size of the material. > `length=50`' colour: type: string description: 'The colour of the material. > `length=50`' description: DTO which references a material LISTrackingObjectReferenceField20DTO: type: object properties: referenceField: type: string description: ReferenceField, possible values arelength=950
expectedShippingDate: $ref: '#/components/schemas/LISDateAndZoneDTO' actualShippingDate: $ref: '#/components/schemas/LISDateAndZoneDTO' salesNetPrice: $ref: '#/components/schemas/LISAmountOfMoneyDTO' purchaseNetPrice: $ref: '#/components/schemas/LISAmountOfMoneyDTO' cataloguePrice: $ref: '#/components/schemas/LISAmountOfMoneyDTO' dimensions: $ref: '#/components/schemas/LISDimensionsDTO' callNumber: type: string description: The call number of the item.length=40
despatchType: $ref: '#/components/schemas/LISDespatchTypeDTO' earliestDeliveryDate: $ref: '#/components/schemas/LISDateAndZoneDTO' latestDeliveryDate: $ref: '#/components/schemas/LISDateAndZoneDTO' earliestShippingDate: $ref: '#/components/schemas/LISDateAndZoneDTO' latestShippingDate: $ref: '#/components/schemas/LISDateAndZoneDTO' handoverLoc: $ref: '#/components/schemas/LISLocationDTO' unloadingLoc: $ref: '#/components/schemas/LISLocationDTO' volume: $ref: '#/components/schemas/LISQuantityDTO' unitVolume: $ref: '#/components/schemas/LISQuantityDTO' grossWeight: $ref: '#/components/schemas/LISQuantityDTO' unitGrossWeight: $ref: '#/components/schemas/LISQuantityDTO' netWeight: $ref: '#/components/schemas/LISQuantityDTO' unitNetWeight: $ref: '#/components/schemas/LISQuantityDTO' orderFulfillmentPlanningCriteria: type: string description: 'Order fulfillment planning criteria. Can be used define additional criteria for the detection of an order fulfillment plan for the order item. By default buyer, supplier addresses, handover and unloading locations and the order type are used for plan detection. > `length=100`' supplier: $ref: '#/components/schemas/LISPartyDTO' buyer: $ref: '#/components/schemas/LISPartyDTO' seller: $ref: '#/components/schemas/LISPartyDTO' intermediateConsignee: $ref: '#/components/schemas/LISPartyDTO' additionalFields: type: array description: Additional fields of the order item items: $ref: '#/components/schemas/LISAdditionalFieldDTO' externalTargetDates: type: array description: The external target dates for specific tracking events. items: $ref: '#/components/schemas/LISTrackingEventExternalTargetDateDTO' toFilterCriteria: type: string description: 'Additional filter criteria for the order. > `length=100`' isReferenceItem: type: boolean description: 'Indication that this item is the reference item for the head order. This flag is ignored if the flag `isWithoutReferenceItem` in the order head is set to `TRUE`.' isNotDeliveryRelevant: type: boolean description: Indication whether the OrderItem is relevant for delivery orderType: type: string description: 'One of a list of constants for the type of orders used in the order item. The order type will influence the status list and event chain. If empty value from the order is used. > `length=20`' genericIdentifier: type: array description: 'The generic Identifiers (Strings) that can be used to identify this order item generically. > `length=80`' items: type: string description: 'The generic Identifiers (Strings) that can be used to identify this order item generically. > `length=80`' description: An item of an order. LISFileSystemDocumentDTO: type: object properties: name: type: string description: 'the name of the document e.g. a file name with extension > `length=500`' mimetype: type: string description: 'the mimetype of the stored document e.g. application/pdf or image/jpeg Note: The content of this field will be stored in the description of the document. > `length=250`' byteSize: type: integer description: 'the byte size of the stored document. > `length=10`' format: int32 documentKey: type: string description: 'The key of the document. This corresponds to the sub-folder where the document is stored. > `length=500`' settingsReference: $ref: '#/components/schemas/LISFileSystemSettingsReferenceDTO' roles: type: array description: the roles for the binary to be displayed in the application items: $ref: '#/components/schemas/LISBinaryRoleDTO' documentCategories: type: array description: the documentCategories for the binary to be displayed in the application items: $ref: '#/components/schemas/LISMODocumentCategoryDTO' languageIsoCodes: type: array description: the languages for the binary to be displayed in the application items: type: string description: the languages for the binary to be displayed in the application additionalFields: type: array description: Additional fields of the document items: $ref: '#/components/schemas/LISAdditionalFieldDTO' description: DTO for document data which has already been stored in the file system LISEventCodeListEntryDTO: type: object properties: hostCode: type: string description: The host code of the entry. This is the code a forwarder or someone else sends from an external system. trackingObjectType: type: string description: The type of the tracking object the event code list entry is for. enum: - ORDER - TRANSLEG - CONS - HUTRANSLEG eventDefinitionIdentCode: type: string description: The ident code of the event definiton the host code is mapped to. description: This DTO describes a eventCodeList entry. LISQuantityDTO: type: object properties: value: type: number description: 'The amount, denoted in units of the field quantityUnit. > `length=20`, `scale=6`' quantityUnit: type: string description: 'The quantity unit of the value. > `length=10`' statValue: type: number description: 'The amount, denoted in units of the field statQuantityUnit. This is for statistics and therefore for the same materials the statQuantityUnit should always be the same. > `length=20`, `scale=6`' statQuantityUnit: type: string description: 'The statistical quantity unit of the statValue. > `length=10`' description: DTO denoting a quantity LISTrackingEventReference20DTO: type: object properties: trackingObjectType: type: string description: 'The type of the tracking event of the message in the supply chain. This information decides which kind of tracking objects in the VCP database will be effected by this event. This information will be used to get the matching EventLoader. > Possible values are `ORDER`, `ORDERITEM`, `CONS`, `TRANSLEG`, `HUTRANSLEG`, `HANDUNIT`, `PHYSTRANS`.' enum: - ORDER - ORDERITEM - CONS - TRANSLEG - HUTRANSLEG - HANDUNIT - PHYSTRANS referenceFields: type: array description: Reference fields to find the tracking object. items: $ref: '#/components/schemas/LISTrackingEventReferenceField20DTO' updateFields: type: array description: Fields to update in the tracking object. items: $ref: '#/components/schemas/LISTrackingEventUpdateField20DTO' description: DTO for reference numbers. Every DTO should have all informations to find one or more TrackingObjects of a certain class. To find the matching tracking object the referenceFields will be concatenated with `AND` TargetTimeCalculationRequestDTO: 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"]' returnDiagnosisLog: type: boolean description: 'When `true`, the diagnosis log is included in the response (for each plan). The log describes the calculation steps conducted to determine the shipping date. Default is `false`.' plans: type: array description: The plans to be calculated. items: $ref: '#/components/schemas/TargetTimeCalculationPlanDTO' description: Request for target time calculation of multiple plans. LISWarehouseDTO: type: object properties: city: type: string description: 'City of the address. > `length=40`' countryISOCode: type: string description: 'Country of address. > `length=2`' postcodeStreet: type: string description: 'Postcode of the street address. > `length=10`' stateRegion: type: string description: 'State or region of the address. > `length=40`' timezone: type: string description: 'Valid Java Timezone string. > `length=50`' globLocationNo: type: string description: 'Global location number of the address. > `length=20`' identCode: type: string description: 'Reference number of the party from the viewpoint of the stock Owner. > `length=40`' name: type: string description: 'Address name line 1. > `length=40`' description: DTO denoting a particular warehouse LISTrackingObjectFilterOrderItemDTO: type: object properties: orderTypeIdentCode: type: string description: identCode for the order type despatchType: $ref: '#/components/schemas/LISDespatchTypeDTO' supplier: $ref: '#/components/schemas/LISPartyDTO' buyer: $ref: '#/components/schemas/LISPartyDTO' consignee: $ref: '#/components/schemas/LISPartyDTO' interimConsignee: $ref: '#/components/schemas/LISPartyDTO' ofPlanCriteria: type: string description: Order fulfillment plan criteria for the filter handOverLocation: $ref: '#/components/schemas/LISLocationDTO' unloadingLocation: $ref: '#/components/schemas/LISLocationDTO' toFilterCriteria: type: string description: additional filter criteria description: DTO for CTOFOrderItem LISAreaDependScheduleHeadDTO: type: object properties: identCode: type: string description: 'Short form of the area depend schedule. > `length=20`' description: type: string description: Description of the area depend schedule scheduleFiltersOrder: type: array description: All order schedule filters connected to the schedule. Should only be filled if `trackingObjectType` is `ORDER`. items: $ref: '#/components/schemas/LISAreaDependScheduleFilterOrderDTO' scheduleFiltersConsignment: type: array description: All consignment schedule filters connected to the schedule. Should only be filled if `trackingObjectType` is `CONS`. items: $ref: '#/components/schemas/LISAreaDependScheduleFilterConsignmentDTO' scheduleFiltersTransport: type: array description: All transport schedule filters connected to the schedule. Should only be filled if `trackingObjectType` is `TRANSLEG`. items: $ref: '#/components/schemas/LISAreaDependScheduleFilterTransportDTO' scheduleFiltersStorage: type: array description: All storage schedule filters connected to the schedule. Should only be filled if `trackingObjectType` is `STORAGE`. items: $ref: '#/components/schemas/LISAreaDependScheduleFilterLCStorageDTO' scheduleFiltersHandling: type: array description: All handling schedule filters connected to the schedule. Should only be filled if `trackingObjectType` is `HANDLING`. items: $ref: '#/components/schemas/LISAreaDependScheduleFilterLCHandlingDTO' scheduleFiltersOrderItem: type: array description: All order item schedule filters connected to the schedule. Should only be filled if `trackingObjectType` is `ORDERITEM`. items: $ref: '#/components/schemas/LISAreaDependScheduleFilterOrderItemDTO' scheduleFiltersHandlingUnit: type: array description: All order item schedule filters connected to the schedule. Should only be filled if `trackingObjectType` is `HANDUNIT`. items: $ref: '#/components/schemas/LISAreaDependScheduleFilterHandlingUnitDTO' description: DTO for main data of TTCSAreaDependSchedule. LISExpOrderHead20DTO: type: object properties: orderType: type: string description: One of a list of constants for the type of orders.length=20
orderNumberBuyer: type: string description: The order number of the buyer.length=40
orderDateBuyer: $ref: '#/components/schemas/LISDateAndZoneDTO' orderNumberSupplier: type: string description: The order number of the supplier.length=40
orderDateSupplier: $ref: '#/components/schemas/LISDateAndZoneDTO' latestDeliveryDate: $ref: '#/components/schemas/LISDateAndZoneDTO' earliestDeliveryDate: $ref: '#/components/schemas/LISDateAndZoneDTO' expectedDeliveryDate: $ref: '#/components/schemas/LISDateAndZoneDTO' actualDeliveryDate: $ref: '#/components/schemas/LISDateAndZoneDTO' orderACKDate: $ref: '#/components/schemas/LISDateAndZoneDTO' consignee: $ref: '#/components/schemas/LISPartyLongDTO' buyer: $ref: '#/components/schemas/LISPartyDTO' orderer: $ref: '#/components/schemas/LISPartyDTO' supplier: $ref: '#/components/schemas/LISPartyDTO' org1: $ref: '#/components/schemas/LISPartyShortDTO' fromWarehouse: $ref: '#/components/schemas/LISWarehouseDTO' toWarehouse: $ref: '#/components/schemas/LISWarehouseDTO' note: type: string description: The note of the order.length=950
priority: type: string description: The priority of the order.length=40
despatchType: $ref: '#/components/schemas/LISDespatchTypeDTO' description: The head of a order. Information in the head applies to all items, unless corresponding item fiels are not null, i.e. explicitly different from the head. LISPartyDTO: type: object properties: globalLocationNumber: type: string description: 'Global Reference number of the party. > `length=20`' partyNumberBuyer: type: string description: 'Reference number of the party from the viewpoint of the buyers IT. > `length=40`' partyNumberSupplier: type: string description: 'Reference number of the party from the viewpoint of the suppliers IT. > `length=40`' partyNumberForwarder: type: string description: 'Reference number of the party from the viewpoint of the forwarders IT. > `length=40`' name: type: string description: 'Address name line 1. > `length=40`' name2: type: string description: 'Address name line 2 > `length=40`' name3: type: string description: 'Address name line 3 > `length=40`' street: type: string description: 'Street of the address. > `length=40`' street2: type: string description: 'Street of the address. Line 2. > `length=40`' postcodeStreet: type: string description: 'Postcode of the street address. > `length=10`' city: type: string description: 'City of the address. > `length=40`' countryISOCode: type: string description: 'Country of address. > `length=2`' poBox: type: string description: 'PO-Box. > `length=10`' postcodePoBox: type: string description: 'Postcode of the poBox address. > `length=10`' stateRegion: type: string description: 'State or region of the address. > `length=40`' timezone: type: string description: 'Valid Java Timezone string. > `length=50`' emailAddress: type: string description: 'Email address of the party. Multiple mail adressess can be provided by separating them with `;`. > `length=1000`' description: Data transfer object to denote parties, e.g. buyer, seller, with full address data. LISEventDefinition20DTO: type: object properties: identCode: type: string description: The identcode of the event definition.length=20
shortName: type: string description: The short name of the event definition. Will be filled dependent on the language in the request.length=50
name: type: string description: The full name of the event definition. Will be filled dependent on the language in the request.length=250
eventType: type: string description: The event type of the event definition.length=50
description: Event Definition data LISOrderFulfillmentStep20DTO: type: object properties: stepType: type: string description: The type of the order fulfillment process step. Momentarily only the value "TRANSPORT" is allowed (may be more in the future).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. LISExpDocumentMetadata20DTO: type: object properties: key: type: string description: A key to uniquely identify the document within the system. filename: type: string description: the name of the binary e.g. a file name with extensionlength=400
description: type: string description: The description of the documentlength=250
uploadDate: type: string description: The upload date of the document in the format "yyyy-MM-dd HH:mm:ss"length=19
size: type: integer description: The size of the document in bytes.length=10
format: int32 documentCategories: type: array description: The categories of the document items: $ref: '#/components/schemas/LISExpMODocumentCategoryIdentifierDTO' description: DTO to provide the meta data of documents that are connected to the higher level structure. LISMessageMetaDataDTO: required: - messageReferenceNumber - receiverClient - receiverRole - sendDate - senderID - senderRole - updateMode type: object properties: senderID: maxLength: 20 type: string description: 'The identification of the message sender. This should be a string that uniquely identifies the system from which the message was sent and is the same for all messages sent from the system. > `length=20`' receiverClient: type: string description: 'The identCode of the client which will get the message. > `length=10`' receiverRole: type: string description: 'The role of the receiver of the message in the supply chain.This will affect how the reference numbers (e.g. orderNumber, materialNumber) will be treated when inserting into the database. > possible values: `BUYER`, `SUPPLIER` or `FORWARDER`.' enum: - BUYER - SUPPLIER - FORWARDER senderRole: type: string description: 'The role of the sender of the message in the supply chain. This will affect how fields of existing objects will be updated by allowing overwrite or not. > possible values: `BUYER`, `SUPPLIER` or `FORWARDER`.' enum: - BUYER - SUPPLIER - FORWARDER sendDate: $ref: '#/components/schemas/LISDateAndZoneDTO' messageReferenceNumber: type: string description: 'Unique number of the message given by the sender. > `length=50`' messageType: type: string description: 'Can be any text. Used to search and filter messages. > `length=100`' updateMode: type: string description: There are several possibilities how the content of the message should be inserted into the system. Update the old contents, delete some contents and so forth. enum: - STANDARD - STRUCTURE - NOUPDATE - DELETE default: STANDARD idRefScheme: type: string description: 'The scheme of the ID and reference number calculation. This will affect how the id and reference fields (e.g. `consignmentID`, `orderItemID`) will be calculated from the DTOs. Depending on the selected calculation scheme different fields in the DTOs will be used to calculate the unique reference numbers of the objects. These fields will become mandatory when needed in the scheme. This field can be left empty, then the calculation scheme `SUPPLIER` will be used. > possible values: `BUYER`, `SUPPLIER` or `IDREFFIELDS`. > `length=20`' enum: - DEFAULT - BUYER - SUPPLIER - IDREFFIELDS default: DEFAULT description: Meta data of a message LISExpMODocument20DTO: type: object properties: content: type: string description: actual binary content of the document format: byte filename: type: string description: the name of the binary e.g. a file name with extensionlength=500
description: type: string description: The description of the documentlength=250
hasError: type: boolean description: Indicates if the the binary content of the document could not be determined. documentCategories: type: array description: The categories of the document items: $ref: '#/components/schemas/LISExpMODocumentCategoryIdentifierDTO' languageIsoCodes: type: array description: the languages for the binary to be displayed in the application items: type: string description: the languages for the binary to be displayed in the application description: DTO to export document data to partner systems like the Message Engine Logistics. @see LISBinaryDTO LISTrackingObjectFilterTransportDTO: type: object properties: transportLegTypeIdentCode: type: string description: identCode for the transport type despatchType: $ref: '#/components/schemas/LISDespatchTypeDTO' serviceType: $ref: '#/components/schemas/LISServiceTypeDTO' forwarder: $ref: '#/components/schemas/LISPartyShortDTO' expectedDepartureDateFrom: $ref: '#/components/schemas/LISDateAndZoneDTO' expectedDepartureDateTo: $ref: '#/components/schemas/LISDateAndZoneDTO' areaStartLocIdentCode: type: string description: identCode of the start location area areaEndLocIdentCode: type: string description: identCode of the end location area priority: type: string description: The priority for the filter. incotermCode: type: string description: The incoterm code. (3 Letters) Segment TOD, Element 4053length=3
toFilterCriteria: type: string description: additional filter criteria description: DTO for CTOFTransportLeg LISTrackingEventHead20DTO: type: object properties: identCode: type: string description: 'Status identCode of the event. > `length=20`' reason: type: string description: 'The code of the reason for the event. > `length=20`' actualDate: $ref: '#/components/schemas/LISDateAndZoneDTO' actualLocation: $ref: '#/components/schemas/LISLocationDTO' actualSender: $ref: '#/components/schemas/LISPartyDTO' info: type: string description: 'Additional information about the event. > `length=1000`' newExpectedDate: $ref: '#/components/schemas/LISDateAndZoneDTO' newPlannedDate: $ref: '#/components/schemas/LISDateAndZoneDTO' identCodeForNewDates: type: string description: 'IdentCode of the event which should be updated. Where planned and expected dates will be updated. Which should be canceled. > `length=20`' cancelTargetEvent: type: boolean description: Flag that indicates if the event in the `identCodeForNewDates` should be canceled. description: DTO for main tracking event data LISAdditionalFieldDTO: type: object properties: fieldName: type: string description: 'The name of the additional field. The target system has to know the name and a way to handle that particular field For example: `REF_NUMBER_1`' fieldValue: type: string description: 'The value of the field. For example: `1X4711`' description: DTO to implement additional fields not found in the standard DTOs The fields can have any name or value, but the target system must know how to handle these fields. LISConsignmentReferenceWithClientDTO: type: object properties: consignmentNumber: type: string description: The consignmentNumber of the LISConsignment supplierGlobalLocationNumber: type: string description: The globalLocationNumber of the supplier of the LISConsignment receiverClient: type: string description: 'The client of the LISConsignment. > `length=10`' description: Reference fields for identifying a LISConsignment. LISOrderFulfillmentRequest20DTO: type: object properties: clientIdentCode: type: string description: The identCode of the client owning the order item for the request. orderNumber: type: string description: The order number of the order item whose plan is requested. Can be a sales order or a purchase order number. orderItemNumber: type: string description: The order item number of the order item whose plan is requested Can be a sales order or a purchase order item number. partnerGLN: type: string description: The partner global location number to identify the order item (together with the order/order item number).length=40
shipperReference: type: string description: Reference number for the forwarder given by the shipper.length=40
masterWayBillNumber: type: string description: The master waybill number of the transport given by the forwarder.length=40
plannedDepartureDate: $ref: '#/components/schemas/LISDateAndZoneDTO' plannedArrivalDate: $ref: '#/components/schemas/LISDateAndZoneDTO' actualDepartureDate: $ref: '#/components/schemas/LISDateAndZoneDTO' actualArrivalDate: $ref: '#/components/schemas/LISDateAndZoneDTO' serviceType: $ref: '#/components/schemas/LISServiceTypeDTO' goodsValue: $ref: '#/components/schemas/LISAmountOfMoneyDTO' freightCh: $ref: '#/components/schemas/LISAmountOfMoneyDTO' freightChPartner: $ref: '#/components/schemas/LISAmountOfMoneyDTO' numberOfHandlingUnits: type: integer description: Number of handling units.length=10
format: int32 netWeightKG: $ref: '#/components/schemas/LISQuantityDTO' grossWeightKG: $ref: '#/components/schemas/LISQuantityDTO' volumenM3: $ref: '#/components/schemas/LISQuantityDTO' loadingMetre: type: number description: Loading metres.length=15, scale=3
transportLegType: $ref: '#/components/schemas/LISTransportTypeDTO' meansOfTransport: $ref: '#/components/schemas/LISMeansOfTransportDTO' startLoc: $ref: '#/components/schemas/LISLocationDTO' endLoc: $ref: '#/components/schemas/LISLocationDTO' forwarder: $ref: '#/components/schemas/LISPartyDTO' forwarderReference: type: string description: The forwarder reference of the transport leg. supplier: $ref: '#/components/schemas/LISPartyDTO' globalTransactionNumber: type: string description: Global unique number to identity the transport clearly.length=40
totalNumberOfTransportLegs: type: integer description: The total number of transport legs of the corresponding transport.length=10
format: int32 sequenceNumber: type: integer description: The sequence number of this tansport leg in the corresponding transport.length=10
format: int32 chargeableWeightKG: $ref: '#/components/schemas/LISQuantityDTO' distanceKM: type: number description: The distance of the transport in KM.length=10, scale=3
palletFootprint: type: number description: Pallet footprint of the transport. shippingPoint: $ref: '#/components/schemas/LISPartyLongDTO' consignee: $ref: '#/components/schemas/LISPartyLongDTO' buyer: $ref: '#/components/schemas/LISPartyDTO' org1: $ref: '#/components/schemas/LISPartyShortDTO' costCenter: $ref: '#/components/schemas/LISPartyShortDTO' despatchType: $ref: '#/components/schemas/LISDespatchTypeDTO' termsOfDelivery: $ref: '#/components/schemas/LISTermsOfDeliveryDTO' note: type: string description: The note of the transport.length=950
expectedDepartureDate: $ref: '#/components/schemas/LISDateAndZoneDTO' expectedArrivalDate: $ref: '#/components/schemas/LISDateAndZoneDTO' houseAirwayBillNumber: type: string description: House airway bill number.length=40
priority: type: string description: The priority of the transport.length=40
carrier: $ref: '#/components/schemas/LISPartyDTO' podSignatureName: type: string description: POD signature name of the transport.length=20
toFilterCriteria: type: string description: Additional filter criteria. Free definable text that can be used as an additional filter criteria for the search in filters.length=100
description: DTO to export transport data to partner systems like the Message Engine Logistics. LISAreaDependScheduleFilterHandlingUnitDTO: type: object properties: sortNumber: type: integer description: sortNumber of the schedule filter format: int32 areaPreviousEventIdentCode: type: string description: identCode of the area (previous event) of the schedule filter areaActualEventIdentCode: type: string description: identCode of the area (actual event) of the schedule filter dayTypeSchedules: type: array description: dayTypeSchedules of the schedule filter items: $ref: '#/components/schemas/LISDayTypeScheduleDTO' periodicStartSchedules: type: array description: periodicStartSchedules of the schedule filter items: $ref: '#/components/schemas/LISPeriodicStartScheduleDTO' usesPeriodicStartSchedule: type: boolean description: uses Departure Schedule of the schedule filter trackingObjectFilter: $ref: '#/components/schemas/LISTrackingObjectFilterHandlingUnitDTO' description: DTO for handling unit AreaDependScheduleFilters LISExpConsItemInHandlingUnit20DTO: type: object properties: consignmentItemNumber: type: string description: 'The number of the item within the consignment. > `length=40`' handlingUnitGlobalUnitNumber: type: string description: 'The global unit number of the handling unit. > `length=100`' quantityPacked: $ref: '#/components/schemas/LISQuantityDTO' description: DTO to export consigment item in handling units data to partner systems like the Message Engine Logistics. LISTrackingObjectFilterLCHandlingDTO: type: object properties: handlingTypeIdentCode: type: string description: identCode of the handlingType to filter location: $ref: '#/components/schemas/LISLocationDTO' description: 'DTO for TOFLCHandling.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 to syncConsignments.
length=20
isComplete: type: boolean description:True, if the synchronization is complete. False if not.
Because a maximum of 100 consignments is returned with one call of syncConsignments, the result may be incomplete.
The resulting consignments. A maximum number of 100 shipments is transmitted per call.
To get ALL shipments make repeated calls of syncConsignments , always passing the last returned LISConsignmentSyncResponseDTO.syncId.
length=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) 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/LISQuantityDTO' hazardNetQuantity: $ref: '#/components/schemas/LISQuantityDTO' netExplosiveWeight: $ref: '#/components/schemas/LISQuantityDTO' numberOfPackages: type: integer description: Number of packages -->do we really want to keept this fieldlength=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
isSpecialProvisionRequired: type: boolean description: Indicates if the special provision has to be marked. emergencyContact: $ref: '#/components/schemas/ContactDTO' 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
isPackingInstructionRequired: type: boolean description: Indicates if the packing instruction has to be marked. 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.
additionalFields:
type: array
description: Additional fields of the hazardous goods item
items:
$ref: '#/components/schemas/LISAdditionalFieldDTO'
description: This DTO describes a hazardous goods item.
LISExpTrackingInfo20DTO:
type: object
properties:
statusList:
type: array
description: The list of possible status sorted by their place in the status chain.
The status are listed with their name in session language.
length of a single entry = 50
items: type: string description: The list of possible status sorted by their place in the status chain.length of a single entry = 50
currentStatus: type: string description: The current status of the tracking object, returned in form of the status name in session language.length=50
actProblemLevel: type: string description: 'The actual problem level of the tracking object. Can be one of the values:length=20
' delayInHours: type: integer description: The delay hours of the tracking object. format: int32 statusListFull: type: array description: The list of possible status sorted by their place in the status chain.length=500
description: type: string description: The description of the documentlength=250
hasError: type: boolean description: Indicates if the the binary content of the document could not be determined. documentCategories: type: array description: The categories of the document items: $ref: '#/components/schemas/LISExpMODocumentCategoryIdentifierDTO' languageIsoCodes: type: array description: the languages for the binary to be displayed in the application items: type: string description: the languages for the binary to be displayed in the application key: maxLength: 50 minLength: 20 type: string description: A key to uniquely identify the document within the system. size: type: integer description: The size of the document in bytes.length=10
format: int32 uploadDate: type: string description: The upload date of the document in the format "yyyy-MM-dd HH:mm:ss"length=19
description: Data transfer object for a document. ContactDTO: 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: Contains data for contacting a person. LISAreaDependScheduleDTO: type: object properties: metaData: $ref: '#/components/schemas/LISMessageMetaDataDTO' head: $ref: '#/components/schemas/LISAreaDependScheduleHeadDTO' trackingObjectType: type: string description: 'The type of the tracking object the area depend schedule is for. Depending on the tracking object type only one of the schedule filter arrays in LISAreaDependScheduleHeadDTO will be used. The others should be null as they won''t be used in the loader.' enum: - ORDER - ORDERITEM - CONS - TRANSLEG - HANDUNIT - STORAGE - HANDLING description: DTO for TTCSAreaDependSchedule. LISConsignmentRequest20DTO: required: - dateField - dateFrom - dateTo type: object properties: identificationDTO: $ref: '#/components/schemas/LISRequestIdentification20DTO' dateFrom: type: string description: 'Date filter for the search, only consignments from this date on will be included in the search result. > format: `yyyy-MM-dd`, `length=10`' format: date dateTo: type: string description: 'Date filter for the search, only consignments up to this date will be included in the search result. If the field is empty, the actual date is assumed. > format: `yyyy-MM-dd`, `length=10`' format: date dateField: type: string description: The date field of the consignment, the date filter will be applied to. enum: - EXPECTED_SHIPPING_DATE - PLANNED_SHIPPING_DATE - EXPECTED_DELIVERY_DATE - PLANNED_DELIVERY_DATE sortField: type: string description: The field used to sort the result consignment list. "CONSIGNMENT_NUMBER" is the default, when no value is specified. enum: - CONSIGNMENT_NUMBER - EXPECTED_SHIPPING_DATE sortDirection: type: string description: The direction the consignments are sorted by their sortField. enum: - ASC - DESC problemLevelFilter: type: array description: Problem level filter. When left empty, all found consignments will be returned, otherwise only the consignments with the specified problem levels will be returned. items: type: string description: Problem level filter. When left empty, all found consignments will be returned, otherwise only the consignments with the specified problem levels will be returned. enum: - INFO - ERROR - FATERROR - WARNING - CANCELED enum: - INFO - ERROR - FATERROR - WARNING - CANCELED consigneeNameFilter: type: string description: Consignee filter. When filled, only consignments with the specified consignee name will be returned. forwarderDeliveryNameFilter: type: string description: Forwarder filter. When filled, only consignments with the specified name for the delivering forwarder will be returned. maxNumberOfCons: type: integer description: Specifies the maximal number of consignments the result list can include. Should prevent, that the result list will bee too large. Therefore a default of 50 will be assumed, when no value is specified. An error will be returned if the given number is greater than 50. format: int32 description: DTO with parameters to request a list of consignments LISDespatchTypeDTO: type: object properties: identCode: type: string description: 'Short form of the despatch type. > `length=20`' description: type: string description: 'Description of the despatch type. > `length=50`' description: DTO for the despatch type. LISMaterialMasterFileDTO: type: object properties: metaData: $ref: '#/components/schemas/LISMessageMetaDataDTO' head: $ref: '#/components/schemas/LISMaterialMasterFileHeadDTO' description: DTO for the master file materials. securitySchemes: SWAGGER_AUTH_KEY: type: apiKey name: X-XNSG_WEB_TOKEN in: header BASIC_AUTH: type: http scheme: basic x-proxy-enabled: false