---
updatedAt: 2026-02-12T14:06:18.000Z
agentTools:
  projectIndex: https://transport-freight-management.docs.developers.aeb.com/llms.txt
---

# synchronizeLoadingOrders

Can be used to synchronize loading orders with another system by returning all loading orders that have been changed since the last synchronization.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Visibility & Collaboration Platform HTTP API",
    "description": "Thank you for using our HTTP API documentation. Please do not use Microsoft Edge on this page. Microsoft Edge will not return responses properly when you try them out.",
    "version": "4.0"
  },
  "servers": [
    {
      "url": "https://rz3.aeb.de/demo1ma/rest"
    }
  ],
  "security": [
    {
      "SWAGGER_AUTH_KEY": []
    },
    {
      "BASIC_AUTH": []
    }
  ],
  "tags": [
    {
      "name": "TSMBFBean",
      "description": "Business Facade for TSM"
    }
  ],
  "paths": {
    "/TSMBFBean/synchronizeLoadingOrders": {
      "post": {
        "tags": [
          "TSMBFBean"
        ],
        "summary": "synchronizeLoadingOrders",
        "description": "Can be used to synchronize loading orders with another system by returning all loading orders that have been changed since the last synchronization.",
        "operationId": "synchronizeLoadingOrders",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TSMSynchronizeLoadingOrdersRequestDTO"
              }
            }
          }
        },
        "responses": {
          "default": {
            "description": "default response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TSMSynchronizeLoadingOrdersResponseDTO"
                }
              }
            }
          }
        },
        "security": [
          {
            "BASIC_AUTH": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "LISArchiveDocumentDTO": {
        "type": "object",
        "properties": {
          "documentName": {
            "type": "string",
            "description": "the name of the document e.g. a file name with extension.\n> `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.\n> `length=50`"
          },
          "roles": {
            "type": "array",
            "description": "the roles for the binary to be displayed in the application",
            "items": {
              "$ref": "#/components/schemas/LISBinaryRoleDTO"
            }
          }
        },
        "description": "DTO for document data that has been stored in an archive system e.g. Assist4ContentStorage and shall be accessed via VCP"
      },
      "LISBinaryDTO": {
        "type": "object",
        "properties": {
          "content": {
            "type": "array",
            "description": "binary content e.g. a pdf document or an image.",
            "items": {
              "type": "string",
              "description": "binary content e.g. a pdf document or an image.",
              "format": "byte"
            }
          },
          "name": {
            "type": "string",
            "description": "the name of the binary e.g. a file name with extension\n> `length=500`"
          },
          "mimetype": {
            "type": "string",
            "description": "the mimetype of the binary e.g. application/pdf or image/jpeg.\nNote: This field fills the `description` of the document object\n> `length=250`"
          },
          "roles": {
            "type": "array",
            "description": "the roles for the binary to be displayed in the application",
            "items": {
              "$ref": "#/components/schemas/LISBinaryRoleDTO"
            }
          }
        },
        "description": "DTO for binaries e.g. document, images."
      },
      "LISBinaryRoleDTO": {
        "type": "object",
        "properties": {
          "identCode": {
            "type": "string",
            "description": "The ident code of the role for the binary. Please see product documentation or an admin for possible roles.\n> `length=100`"
          }
        },
        "description": "A single binary role."
      },
      "LISDimensionsDTO": {
        "type": "object",
        "properties": {
          "quantityUnit": {
            "type": "string",
            "description": "Quantity unit.\n> `length=10`"
          },
          "width": {
            "type": "number",
            "description": "Width.\n> `length=20`, `scale=6`"
          },
          "length": {
            "type": "number",
            "description": "Length.\n> `length=20`, `scale=6`"
          },
          "height": {
            "type": "number",
            "description": "Height.\n> `length=20`, `scale=6`"
          }
        },
        "description": "DTO for Dimensions length, width, height and a quantity unit."
      },
      "TSMHostReferenceDTO": {
        "type": "object",
        "properties": {
          "referenceNumber": {
            "type": "string",
            "description": "Host system reference number.\n> `length=50`"
          }
        },
        "description": "DTO that corresponds to the host reference number of a loading order."
      },
      "TSMLoadingLocationDTO": {
        "type": "object",
        "properties": {
          "identCode": {
            "type": "string",
            "description": "<p> The ident code of the location </p> <p> length=30 </p>"
          },
          "address": {
            "$ref": "#/components/schemas/TSMPartyDTO"
          }
        },
        "description": "DTO containing the data of a loading location"
      },
      "TSMLoadingOrderDTO": {
        "required": [
          "loadingType"
        ],
        "type": "object",
        "properties": {
          "referenceNumber": {
            "type": "string",
            "description": "Order reference number\n> `length=50`"
          },
          "loadingType": {
            "type": "string",
            "description": "Loading type of the loading order.",
            "enum": [
              "LOADING",
              "UNLOADING",
              "LOADINGANDUNLOADING"
            ]
          },
          "forwarderReference": {
            "type": "string",
            "description": "Forwarder reference number\n> `length=50`"
          },
          "forwarder": {
            "$ref": "#/components/schemas/TSMPartyDTO"
          },
          "bookingAgent": {
            "$ref": "#/components/schemas/TSMPartyDTO"
          },
          "forwarderNote": {
            "type": "string",
            "description": "Note concerning the forwarder, special handling or hints for the forwarder.\n> `length=1000`"
          },
          "vehicleLicenseNumber": {
            "type": "string",
            "description": "License number of the vehicle fulfilling the order.\n> `length=50`"
          },
          "vehicleDriver": {
            "$ref": "#/components/schemas/TSMPersonDTO"
          },
          "vehicleDriverLicenseNumber": {
            "type": "string",
            "description": "Number of the driver's license of the driver.\n> `length=50`"
          },
          "shippers": {
            "type": "array",
            "description": "Shipper(s) of the loading order",
            "items": {
              "$ref": "#/components/schemas/TSMLoadingOrderPartyDTO"
            }
          },
          "consignees": {
            "type": "array",
            "description": "Consignee(s) of the loading order.",
            "items": {
              "$ref": "#/components/schemas/TSMLoadingOrderPartyDTO"
            }
          },
          "note": {
            "type": "string",
            "description": "Note for the loading order.\n> `length=1000`"
          },
          "isFinished": {
            "type": "boolean",
            "description": "Determines if the loading order is finished."
          },
          "timeSlotRequirements": {
            "$ref": "#/components/schemas/TSMLoadingOrderTimeSlotRequirementsDTO"
          },
          "transportType": {
            "type": "string",
            "description": "The transport type of the loading order. Corresponds to the ident code of the master data.\n> `length=30`"
          }
        },
        "description": "Contains the data of a loading order"
      },
      "TSMLoadingOrderExportDTO": {
        "type": "object",
        "properties": {
          "orderNumber": {
            "type": "string",
            "description": "<p> Order number. </p> <p> length=50 </p>"
          },
          "orderData": {
            "$ref": "#/components/schemas/TSMLoadingOrderDTO"
          },
          "orderItems": {
            "type": "array",
            "description": "<p> The items of the loading order </p>",
            "items": {
              "$ref": "#/components/schemas/TSMLoadingOrderItemDTO"
            }
          },
          "timeSlot": {
            "$ref": "#/components/schemas/TSMTimeSlotDTO"
          },
          "hostReferences": {
            "type": "array",
            "description": "<p> Reference numbers from the host system for the loading order </p>",
            "items": {
              "$ref": "#/components/schemas/TSMHostReferenceDTO"
            }
          },
          "properties": {
            "type": "array",
            "description": "<p> Loading properties of the loading order </p>",
            "items": {
              "$ref": "#/components/schemas/TSMLoadingOrderPropertyDTO"
            }
          },
          "documents": {
            "type": "array",
            "description": "<p> Uploaded documents of the loading order </p>",
            "items": {
              "$ref": "#/components/schemas/LISBinaryDTO"
            }
          },
          "archivedDocuments": {
            "type": "array",
            "description": "The storage data of the archived documents of the order",
            "items": {
              "$ref": "#/components/schemas/LISArchiveDocumentDTO"
            }
          }
        },
        "description": "DTO to export a loading order with order items"
      },
      "TSMLoadingOrderItemDTO": {
        "type": "object",
        "properties": {
          "weight": {
            "$ref": "#/components/schemas/TSMQuantityDTO"
          },
          "count": {
            "type": "integer",
            "description": "Actual count of the contents contained in this item.\n> `length=4`",
            "format": "int32"
          },
          "contentDescription": {
            "type": "string",
            "description": "Description of the contents contained in this item.\n> `length=1000`"
          },
          "equipmentType": {
            "type": "string",
            "description": "Type of equipment used in this order item. The contents of this field should correspond to the equipment type in the master data.\n> `length=30`"
          },
          "dimensions": {
            "$ref": "#/components/schemas/LISDimensionsDTO"
          }
        },
        "description": "Contains data of a loading order item"
      },
      "TSMLoadingOrderPartyDTO": {
        "type": "object",
        "properties": {
          "address": {
            "$ref": "#/components/schemas/TSMPartyDTO"
          },
          "note": {
            "type": "string",
            "description": "Note for the party.\n> `length=1000`"
          }
        },
        "description": "Contains data of a loading order party"
      },
      "TSMLoadingOrderPropertyDTO": {
        "type": "object",
        "properties": {
          "identCode": {
            "type": "string",
            "description": "The ident code of the loading property. Should correspond to the ident code of the property master data to work properly.\n> `length=30`"
          }
        },
        "description": "Represents a loading order property"
      },
      "TSMLoadingOrderTimeSlotRequirementsDTO": {
        "type": "object",
        "properties": {
          "loadingLocation": {
            "type": "string",
            "description": "The location where the time slot should be executed. This corresponds to the ident code of the location in the master data.\n> `length=30`"
          },
          "loadingRamp": {
            "type": "string",
            "description": "The loading ramp where the time slot should be executed. This corresponds to the ident code of the ramp in the master data.\n> `length=30`"
          },
          "earliestBeginDate": {
            "type": "string",
            "description": "The earliest date when the time slot of the loading order should begin.\nformat: `yyyy-MM-dd HH:mm`\n> `length=16`"
          },
          "latestEndDate": {
            "type": "string",
            "description": "The latest date when the time slot of the loading order should have ended.\n> format: `yyyy-MM-dd HH:mm`\n> `length=16`"
          },
          "timeSlotLengthMinutes": {
            "type": "integer",
            "description": "The duration of the time slot in minutes.\n> `length=3`",
            "format": "int32"
          }
        },
        "description": "Contains data of a loading order that are required for time slot booking"
      },
      "TSMLoadingRampDTO": {
        "type": "object",
        "properties": {
          "identCode": {
            "type": "string",
            "description": "<p> The ident code of the loading ramp </p> <p> length=30 </p>"
          },
          "location": {
            "$ref": "#/components/schemas/TSMLoadingLocationDTO"
          }
        },
        "description": "Contains information of a loading ramp"
      },
      "TSMPartyDTO": {
        "type": "object",
        "properties": {
          "contact": {
            "$ref": "#/components/schemas/TSMPersonDTO"
          },
          "name1": {
            "type": "string",
            "description": "Name field 1. Contains the name of the address.\n> `length=40`"
          },
          "name2": {
            "type": "string",
            "description": "Name field 2. Contains additional name information.\n> `length=40`"
          },
          "name3": {
            "type": "string",
            "description": "Name field 3. Contains additional name information.\n> `length=40`"
          },
          "name4": {
            "type": "string",
            "description": "Name field 4. Contains additional name information.\n> `length=40`"
          },
          "street1": {
            "type": "string",
            "description": "Street address 1. The street of the address.\n> `length=40`"
          },
          "city": {
            "type": "string",
            "description": "City of the address.\n> `length=40`"
          },
          "disctrict": {
            "type": "string",
            "description": "District of the address.\n> `length=40`"
          },
          "county": {
            "type": "string",
            "description": "County information.\n> `length=40`"
          },
          "postcode": {
            "type": "string",
            "description": "Post code of the address.\n> `length=10`"
          },
          "countryIsoCode": {
            "type": "string",
            "description": "ISO code of the country of the address.\n> `length=2`"
          },
          "companyNumber": {
            "type": "string",
            "description": "A number for the company of the address.\n> `length=20`"
          },
          "timezone": {
            "type": "string",
            "description": "Time zone where this address lies.\n> `length=50`"
          }
        },
        "description": "Contains address data of a party"
      },
      "TSMPersonDTO": {
        "type": "object",
        "properties": {
          "surname": {
            "type": "string",
            "description": "Last name of the person\n> `length=30`"
          },
          "forename": {
            "type": "string",
            "description": "Given or first name of the person\n> `length=20`"
          },
          "title": {
            "type": "string",
            "description": "Title of the person",
            "enum": [
              "MR",
              "MRS",
              "MS",
              "MISS"
            ]
          },
          "phoneNumber": {
            "type": "string",
            "description": "Phone number of the person\n> `length=30`"
          },
          "email": {
            "type": "string",
            "description": "Email address of the person\n> `length=250`"
          },
          "language": {
            "type": "string",
            "description": "Iso code of the language of the person\n> `length=2`"
          }
        },
        "description": "Contains the information of a contact/person"
      },
      "TSMPreparationTimeDTO": {
        "type": "object",
        "properties": {
          "plannedBeginDate": {
            "type": "string",
            "description": "<p> The date when the preparation time is scheduled to start. This is the string representation of the date. The following format should be used: <b>yyyy-MM-dd HH:mm</b> </p> <p> length=16 </p> <p> format=yyyy-MM-dd HH:mm </p>"
          },
          "plannedEndDate": {
            "type": "string",
            "description": "<p> The date when the preparation time is scheduled to end. This is the string representation of the date. The following format should be used: <b>yyyy-MM-dd HH:mm</b> </p> <p> length=16 </p> <p> format=yyyy-MM-dd HH:mm </p>"
          }
        },
        "description": "DTO containing the data of a preparation time"
      },
      "TSMQuantityDTO": {
        "type": "object",
        "properties": {
          "value": {
            "type": "number",
            "description": "Exact value of the quantity.\n> `length=15`, `scale=3`"
          },
          "quantityUnit": {
            "type": "string",
            "description": "Unit of measurement\n> `length=10`"
          },
          "factor": {
            "type": "number",
            "description": "Factor for conversions (may be null).\n> `length=36`, `scale=18`"
          }
        },
        "description": "Contains information of a specific quantity along with its unit of measurement"
      },
      "TSMSynchronizeLoadingOrdersResponseDTO": {
        "type": "object",
        "properties": {
          "syncId": {
            "type": "number",
            "description": "<p> Sync id of the last transfered loading order </p> <p> Use this syncId in subsequent calls to <code>getLoadingOrders(...)</code> to return the next loading orders </p> <p> length=20 </p>"
          },
          "isComplete": {
            "type": "boolean",
            "description": "<p> True, if the synchronization is complete. False if not. </p> <p> Because a maximum of 100 loading are returned with one call of <code>getLoadingOrders(...)</code>, the result may be incomplete. </p>"
          },
          "loadingOrders": {
            "type": "array",
            "description": "The resulting loading orders, matching the search parameters. A maximum number of 100 loading orders are transmitted per call. To get ALL loading orders make repeated calls of <code>getLoadingOrders(...)</code>, always passing the last returned TSMSynchronizeLoadingOrdersResponseDTO.syncId in the next call with TSMSynchronizeLoadingOrdersRequestDTO.syncId.",
            "items": {
              "$ref": "#/components/schemas/TSMLoadingOrderExportDTO"
            }
          }
        },
        "description": "Response containing loading orders for the parameters in the request to return loading orders see TSMSynchronizeLoadingOrdersRequestDTO"
      },
      "TSMTimeSlotDTO": {
        "type": "object",
        "properties": {
          "loadingRamp": {
            "$ref": "#/components/schemas/TSMLoadingRampDTO"
          },
          "preparationTime": {
            "$ref": "#/components/schemas/TSMPreparationTimeDTO"
          },
          "plannedBeginDate": {
            "type": "string",
            "description": "<p> The date when the time slot is scheduled to start. This is the string representation of the date. The following format should be used: <b>yyyy-MM-dd HH:mm</b> </p> <p> length=16 </p> <p> format=yyyy-MM-dd HH:mm </p>"
          },
          "plannedEndDate": {
            "type": "string",
            "description": "<p> The date when the time slot is scheduled to end. This is the string representation of the date. The following format should be used: <b>yyyy-MM-dd HH:mm</b> </p> <p> length=16 </p> <p> format=yyyy-MM-dd HH:mm </p>"
          },
          "plannedArrivalDate": {
            "type": "string",
            "description": "<p> The date when the vehicle is scheduled to arrive at the location. This is the string representation of the date. The following format should be used: <b>yyyy-MM-dd HH:mm</b> </p> <p> length=16 </p> <p> format=yyyy-MM-dd HH:mm </p>"
          },
          "plannedDepartureDate": {
            "type": "string",
            "description": "<p> The date when the vehicle is scheduled to depart the location. This is the string representation of the date. The following format should be used: <b>yyyy-MM-dd HH:mm</b> </p> <p> length=16 </p> <p> format=yyyy-MM-dd HH:mm </p>"
          },
          "actualBeginDate": {
            "type": "string",
            "description": "<p> The date when the time slot actually started. This is the string representation of the date. The following format should be used: <b>yyyy-MM-dd HH:mm</b> </p> <p> length=16 </p> <p> format=yyyy-MM-dd HH:mm </p>"
          },
          "actualEndDate": {
            "type": "string",
            "description": "<p> The date when the time slot actually ended. This is the string representation of the date. The following format should be used: <b>yyyy-MM-dd HH:mm</b> </p> <p> length=16 </p> <p> format=yyyy-MM-dd HH:mm </p>"
          },
          "actualArrivalDate": {
            "type": "string",
            "description": "<p> The date when the vehicle actually arrived at the location. This is the string representation of the date. The following format should be used: <b>yyyy-MM-dd HH:mm</b> </p> <p> length=16 </p> <p> format=yyyy-MM-dd HH:mm </p>"
          },
          "actualDepartureDate": {
            "type": "string",
            "description": "<p> The date when the vehicle actually departed the location. This is the string representation of the date. The following format should be used: <b>yyyy-MM-dd HH:mm</b> </p> <p> length=16 </p> <p> format=yyyy-MM-dd HH:mm </p>"
          },
          "isApprovalNecessary": {
            "type": "boolean",
            "description": "<p> Flag if the time slot has to be approved </p>"
          },
          "isApproved": {
            "type": "boolean",
            "description": "<p> Flag if the time slot has been approved </p>"
          },
          "approvedByUserName": {
            "type": "string",
            "description": "<p> User name of the user who approved the time slot </p> <p> length=20 </p>"
          },
          "approvedDate": {
            "type": "string",
            "description": "<p> The date when the time slot was approved. This is the string representation of the date. The following format should be used: <b>yyyy-MM-dd HH:mm</b> </p> <p> length=16 </p> <p> format=yyyy-MM-dd HH:mm </p>"
          }
        },
        "description": "DTO that contains the data of a time slot"
      },
      "TSMRequestDataDTO": {
        "required": [
          "clientIdentCode"
        ],
        "type": "object",
        "properties": {
          "clientIdentCode": {
            "type": "string",
            "description": "The code of the client in the time slot management server (engine)."
          },
          "installationIdHost": {
            "type": "string",
            "description": "The installation ID of the host system to be able to separate loading order data to different host systems."
          }
        },
        "description": "DTO that contains all the necessary data for a request to the TSM interface"
      },
      "TSMSynchronizeLoadingOrdersRequestDTO": {
        "type": "object",
        "properties": {
          "requestData": {
            "$ref": "#/components/schemas/TSMRequestDataDTO"
          },
          "syncId": {
            "type": "number",
            "description": "To be used to get all loading orders that have been created since this syncId. Pass this field with the value returned in TSMSynchronizeLoadingOrdersResponseDTO.syncId with the last call to getLoadingOrders(...).\nCan only be used when `orderReferences == null`\n> `length=20`"
          }
        },
        "description": "DTO that contains the request parameters to synchronize loading orders with another system, see TSMSynchronizeLoadingOrdersResponseDTO"
      }
    },
    "securitySchemes": {
      "SWAGGER_AUTH_KEY": {
        "type": "apiKey",
        "name": "X-XNSG_WEB_TOKEN",
        "in": "header"
      },
      "BASIC_AUTH": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "x-proxy-enabled": false,
  "x-readme": {
    "explorer-enabled": true
  }
}
```