Shipment DTO incl. field description

{
  // Required: Identifies the shipment (must be unique for the company)
  "shipmentId": "string",
  // Optional: Internal dripNumber of the plant where the shipment is assigned
  "plant": 0,
  // Optional: License plate of the truck
  "truckLicensePlate": "string",
  // Optional: Vehicle type, relevant for ETA calculation. Allowed values:
  // "van", "car", "truck11_99t", "truck7_49t", "truck40t" (default), "trailertruck"
  "vehicleProfile": "string",
  // Optional: License plate of the trailer
  "trailerLicensePlate": "string",
  // Optional: DripNumber of the carrier
  "carrierDripNumber": "string",
  // Optional: VAT ID of the carrier
  "carrierVatNumber": "string",
  "additionalProperties": {
    // Optional: Shipment starts immediately after binding a vehicle
    "finishFirstStopWhenVehicleAssigned": true,
    // Optional: Shipment remains in status "in_progress" as long as the
    // scan_document task is open or until the shipment is archived
    "openScanDocumentTasksShouldPreventShipmentFinish": true
  },
  // Optional (default = true): Stops are visited sequentially
  "stopOrderCorrect": true,
  // Required: List of shipment stops and waypoints
  "stops": [
    {
      // Required: Either "stop" or "waypoint".
      // A waypoint has no effect on shipment start.
      "$type": "stop",
      "address": {
        // Optional: If omitted, coordinates must be provided instead
        // Required fields if address is used:
        "country": "string",
        // Country code (ISO2)
        "zip": "string",
        // Postal code
        "city": "string",
        // City name
        "street": "string",
        // Street name (may include house number)
        "houseNumber": "string"
        // Optional: House number
      },
      "coordinates": {
        // Optional: If address is omitted, coordinates are required
        "latitude": 0,
        // Required if coordinates are used
        "longitude": 0
        // Required if coordinates are used
      },
      // Optional: Driver-relevant info, displayed in D4D app
      "stopInfo": "string",
      // Required: Name of the stop (e.g., company name)
      "name": "string",
      // Optional: Identifier to match stop with a 3rd-party system.
      // Must be unique across all stops of this shipment.
      "referenceText": "string",
      "timeWindow": {
        // Required: Start and end of loading/unloading activity (ISO8601 format)
        "start": "2023-04-01T12:00:00.000Z",
        "end": "2023-04-01T12:00:00.000Z"
      },
      // Optional: Average duration of activity (loading/unloading).
      // Considered in ETA calculation.
      "duration": 0,
      // Optional: Tasks to be performed at this stop
      "tasks": [
        {
          // Required: Type of task. Allowed values:
          // "load", "unload", "scan_document", "change_truck"
          "type": "load",
          // Optional: Preset document type (for document upload in D4D app)
          "documentType": "string",
          // Optional: Identifies load/unload task for a consignment
          "consignmentId": "string",
          // Optional: Required if type = "change_truck". Identifies new truck.
          "licencePlate": "string",
          // Required: Start time of activity (ISO8601 format)
          "start": "2023-04-01T12:00:00.000Z",
          // Required: End time of activity (ISO8601 format)
          "end": "2023-04-01T12:00:00.000Z"
        }
      ]
    },
    {
      // Example waypoint (no shipment start triggered)
      "$type": "waypoint",
      "address": {
        "country": "string",
        "zip": "string",
        "city": "string",
        "street": "string",
        "houseNumber": "string"
      },
      "coordinates": {
        "latitude": 0,
        "longitude": 0
      }
    }
  ],
  // Optional: List of dispatcher abbreviations or dispatcher groups
  "dispatchers": [
    "string"
  ],
  // Optional: List of consignments assigned to this shipment
  "consignments": [
    {
      // Required: Unique identifier for the consignment
      "consignmentId": "string",
      // Optional: Shipper/customer reference
      "customerReferenceText": "string",
      "load": {
        // Required: Description of consignment
        "name": "string",
        // Required: Amount of colli (packages)
        "amount": 0,
        // Required: Type of colli (e.g., pallet, box)
        "posArt": "string",
        // Required: Weight of all colli (packages)
        "weight": 0
      },
      "sender": {
        // Required: Sender company (does not need to match loading stop address)
        "name": "string",
        // Company or sender name
        "address": {
          // Optional sender address fields
          "country": "string",
          "zip": "string",
          "city": "string",
          "street": "string",
          "houseNumber": "string"
        },
        // Optional: Customer ID (relevant for customer portal)
        "matchCode": "string"
      },
      "receiver": {
        // Required: Receiver company (does not need to match unloading stop address)
        "name": "string",
        // Company or receiver name
        "address": {
          // Optional receiver address fields
          "country": "string",
          "zip": "string",
          "city": "string",
          "street": "string",
          "houseNumber": "string"
        },
        // Optional: Customer ID
        "matchCode": "string"
      },
      // Optional: Visibility provider configuration (RTV = Real-Time Visibility)
      "realtimeVisibilityProviders": [
        {
          // Required: Provider name (e.g., "shippeo", "sixfold", "fourkites", "project44")
          "providerName": "string",
          // Required: Reference to identify order in RTV platform
          "reference": "string",
          // Optional: Only required for Lear
          "orderNumber": "string",
          // Optional: Identifier for account handling
          "accountReference": "string"
        }
      ],
      // Optional: Client customer ID (needed for RTV mapping)
      "payer": "string",
      // Optional: Company that owns the consignment
      "consignmentOwner": "string",
      // Optional: If 3rd party delivery services are used, the status of the consignment can be requested
      "trackers": [
        {
          // Required, provides the 3rd party delivery service (e.g. post)
          "type": "string",
          // Optional, is required for retriveving post status updates (identCode)
          "customerId": "string",
          // Required, represents the trackingnumber of the 3rd party delivery service
          "trackingNumber": "string"
        }
      ]
    }
  ],
  // Optional: Shipment-level RTV configuration
  "realtimeVisibilityProviders": [
    {
      // Required: Provider name (e.g., "shippeo", "sixfold", "fourkites", "project44")
      "providerName": "string",
      // Required: Reference to identify order in RTV platform
      "reference": "string",
      // Optional: Only required for Lear
      "orderNumber": "string",
      // Optional: Identifier for account handling
      "accountReference": "string"
    }
  ],
  // Optional: Free text field, often used for cost center identification
  "customerField1": "string",
  // Optional: Start date of shipment (ISO8601). Used to determine upcoming shipment (e.g., morning vs afternoon).
  "startDate": "2023-04-01T12:00:00.000Z",
  // Optional: End date of shipment (ISO8601). Used to determine upcoming shipment (e.g., morning vs afternoon).
  "endDate": "2023-04-01T12:00:00.000Z"
}