Send Manual Plan

The "Send Manual Plan" method empowers customers to create and dispatch their logistics plans for monitoring within our system. Through this method, customers can accurately design routes, assign vehicles and drivers, and schedule stops and tasks.

Send Manual Plan Object

This object presents a full representation of manual planning data within a logistics system. It details planned tours, information about assigned vehicles, drivers, routes, trailers, and stops. For each stop, the structure includes specifics about the location, associated orders, expected and actual distances, as well as tasks and events.

{
  "manualPlan": {
    "tours": [
      {
        "id": "string",
        "vehicle": {
          "id": "string",
          "plateNumber": "string",
          "code": "string",
          "vehicleType": {
            "name": "string",
            "weight": 0,
            "volume": 0
          },
          "home": {
            "id": "string",
            "name": "string",
            "address": {
              "street": "string",
              "number": "string",
              "zip": "string",
              "city": "string",
              "country": "string",
              "zone": "string"
            },
            "nodeType": 0,
            "timeWindows": [
              {
                "date": "2023-12-18T08:27:02.985Z",
                "timeSlots": [
                  {
                    "startTime": 0,
                    "endTime": 0
                  }
                ]
              }
            ],
            "location": {
              "longitude": 0,
              "latitude": 0
            },
            "nodeDetails": [
              {
                "key": "string",
                "value": "string"
              }
            ]
          },
          "depot": {
            "id": "string",
            "name": "string",
            "address": {
              "street": "string",
              "number": "string",
              "zip": "string",
              "city": "string",
              "country": "string",
              "zone": "string"
            },
            "nodeType": 0,
            "timeWindows": [
              {
                "date": "2023-12-18T08:27:02.985Z",
                "timeSlots": [
                  {
                    "startTime": 0,
                    "endTime": 0
                  }
                ]
              }
            ],
            "location": {
              "longitude": 0,
              "latitude": 0
            },
            "nodeDetails": [
              {
                "key": "string",
                "value": "string"
              }
            ]
          },
          "cost": 0,
          "maxAllowedTripTime": 0,
          "maxAllowedTripDistance": 0,
          "planningGroup": {
            "name": "string"
          },
          "vehicleDetails": [
            {
              "key": "string",
              "value": "string"
            }
          ]
        },
        "driver": {
          "id": "string",
          "code": "string",
          "name": "string",
          "phone": "string",
          "remainingDrivingHours": {
            "eventTime": "2023-12-18T08:27:02.985Z",
            "cardID": "string",
            "isCo": true,
            "coCardID": "string",
            "cardStatus": true,
            "activity": 0,
            "duration": 0,
            "startDay": "2023-12-18T08:27:02.985Z",
            "driveBreak": 0,
            "continuousDrive": 0,
            "continuousDriveAlarm": 0,
            "dayDrive": 0,
            "dayDriveAlarm": 0,
            "dayDriveDisposable": 0,
            "dayDriveDisposableAlarm": 0,
            "dayRest": 0,
            "weekDrive": 0,
            "weekDriveAlarm": 0,
            "weekDriveDisposable": 0,
            "weekDriveDisposableAlarm": 0,
            "twoWeekDriveDisposable": 0,
            "weekLabour": 0,
            "weekLabourAlarm": 0,
            "extendedDriving": 0,
            "extendedDrivingAlarm": 0,
            "reducedDayRests": 0,
            "reducedDayRestsAlarm": 0,
            "dayDriveMaxAllowed": 0,
            "weekDriveMaxAllowed": 0,
            "twoWeekDriveMaxAllowed": 0,
            "remainingDrivingPauseTime": 0
          }
        },
        "routeMdode": 0,
        "trailers": [
          {
            "id": "string",
            "plateNumber": "string",
            "trailerDetails": [
              {
                "key": "string",
                "value": "string"
              }
            ],
            "trailerType": {
              "name": "string"
            }
          }
        ],
        "creationDate": "2023-12-18T08:27:02.985Z",
        "lastModifiedDate": "2023-12-18T08:27:02.985Z",
        "stops": [
          {
            "node": {
              "id": "string",
              "name": "string",
              "address": {
                "street": "string",
                "number": "string",
                "zip": "string",
                "city": "string",
                "country": "string",
                "zone": "string"
              },
              "nodeType": 0,
              "timeWindows": [
                {
                  "date": "2023-12-18T08:27:02.985Z",
                  "timeSlots": [
                    {
                      "startTime": 0,
                      "endTime": 0
                    }
                  ]
                }
              ],
              "location": {
                "longitude": 0,
                "latitude": 0
              },
              "nodeDetails": [
                {
                  "key": "string",
                  "value": "string"
                }
              ]
            },
            "orders": [
              {
                "orderID": "string",
                "orderDescription": "string",
                "customer": {
                  "id": "string",
                  "name": "string"
                },
                "creationDate": "2023-12-18T08:27:02.985Z",
                "lastModifiedDate": "2023-12-18T08:27:02.985Z",
                "orderStatus": 0,
                "planningGroup": {
                  "name": "string"
                },
                "orderDetails": [
                  {
                    "key": "string",
                    "value": "string"
                  }
                ],
                "orderTasks": [
                  {
                    "id": "string",
                    "name": "string",
                    "requestedTaskDueDate": "2023-12-18T08:27:02.985Z",
                    "requestedTimeSlot": {
                      "startTime": 0,
                      "endTime": 0
                    },
                    "orderTaskType": 0,
                    "alertPriority": 0,
                    "reference": "string",
                    "dispatched": true,
                    "trailer": {
                      "id": "string",
                      "plateNumber": "string",
                      "trailerDetails": [
                        {
                          "key": "string",
                          "value": "string"
                        }
                      ],
                      "trailerType": {
                        "name": "string"
                      }
                    },
                    "expectedStartTime": "2023-12-18T08:27:02.985Z",
                    "expectedEndTime": "2023-12-18T08:27:02.985Z",
                    "actualStartTime": "2023-12-18T08:27:02.985Z",
                    "actualEndTime": "2023-12-18T08:27:02.985Z",
                    "driver": {
                      "id": "string",
                      "code": "string",
                      "name": "string",
                      "phone": "string",
                      "remainingDrivingHours": {
                        "eventTime": "2023-12-18T08:27:02.985Z",
                        "cardID": "string",
                        "isCo": true,
                        "coCardID": "string",
                        "cardStatus": true,
                        "activity": 0,
                        "duration": 0,
                        "startDay": "2023-12-18T08:27:02.985Z",
                        "driveBreak": 0,
                        "continuousDrive": 0,
                        "continuousDriveAlarm": 0,
                        "dayDrive": 0,
                        "dayDriveAlarm": 0,
                        "dayDriveDisposable": 0,
                        "dayDriveDisposableAlarm": 0,
                        "dayRest": 0,
                        "weekDrive": 0,
                        "weekDriveAlarm": 0,
                        "weekDriveDisposable": 0,
                        "weekDriveDisposableAlarm": 0,
                        "twoWeekDriveDisposable": 0,
                        "weekLabour": 0,
                        "weekLabourAlarm": 0,
                        "extendedDriving": 0,
                        "extendedDrivingAlarm": 0,
                        "reducedDayRests": 0,
                        "reducedDayRestsAlarm": 0,
                        "dayDriveMaxAllowed": 0,
                        "weekDriveMaxAllowed": 0,
                        "twoWeekDriveMaxAllowed": 0,
                        "remainingDrivingPauseTime": 0
                      }
                    }
                  }
                ],
                "totalWeight": 0,
                "totalVolume": 0
              }
            ],
            "expectedDistance": 0,
            "actualDistance": 0,
            "stopTasks": [
              {
                "id": "string",
                "name": "string",
                "trailer": {
                  "id": "string",
                  "plateNumber": "string",
                  "trailerDetails": [
                    {
                      "key": "string",
                      "value": "string"
                    }
                  ],
                  "trailerType": {
                    "name": "string"
                  }
                },
                "stopTaskType": 0,
                "expectedStartTime": "2023-12-18T08:27:02.985Z",
                "expectedEndTime": "2023-12-18T08:27:02.985Z",
                "actualStartTime": "2023-12-18T08:27:02.985Z",
                "actualEndTime": "2023-12-18T08:27:02.985Z",
                "driver": {
                  "id": "string",
                  "code": "string",
                  "name": "string",
                  "phone": "string",
                  "remainingDrivingHours": {
                    "eventTime": "2023-12-18T08:27:02.985Z",
                    "cardID": "string",
                    "isCo": true,
                    "coCardID": "string",
                    "cardStatus": true,
                    "activity": 0,
                    "duration": 0,
                    "startDay": "2023-12-18T08:27:02.986Z",
                    "driveBreak": 0,
                    "continuousDrive": 0,
                    "continuousDriveAlarm": 0,
                    "dayDrive": 0,
                    "dayDriveAlarm": 0,
                    "dayDriveDisposable": 0,
                    "dayDriveDisposableAlarm": 0,
                    "dayRest": 0,
                    "weekDrive": 0,
                    "weekDriveAlarm": 0,
                    "weekDriveDisposable": 0,
                    "weekDriveDisposableAlarm": 0,
                    "twoWeekDriveDisposable": 0,
                    "weekLabour": 0,
                    "weekLabourAlarm": 0,
                    "extendedDriving": 0,
                    "extendedDrivingAlarm": 0,
                    "reducedDayRests": 0,
                    "reducedDayRestsAlarm": 0,
                    "dayDriveMaxAllowed": 0,
                    "weekDriveMaxAllowed": 0,
                    "twoWeekDriveMaxAllowed": 0,
                    "remainingDrivingPauseTime": 0
                  }
                }
              }
            ],
            "stopEvents": [
              {
                "id": "string",
                "name": "string",
                "actualStartTime": "2023-12-18T08:27:02.986Z",
                "actualEndTime": "2023-12-18T08:27:02.986Z",
                "driver": {
                  "id": "string",
                  "code": "string",
                  "name": "string",
                  "phone": "string",
                  "remainingDrivingHours": {
                    "eventTime": "2023-12-18T08:27:02.986Z",
                    "cardID": "string",
                    "isCo": true,
                    "coCardID": "string",
                    "cardStatus": true,
                    "activity": 0,
                    "duration": 0,
                    "startDay": "2023-12-18T08:27:02.986Z",
                    "driveBreak": 0,
                    "continuousDrive": 0,
                    "continuousDriveAlarm": 0,
                    "dayDrive": 0,
                    "dayDriveAlarm": 0,
                    "dayDriveDisposable": 0,
                    "dayDriveDisposableAlarm": 0,
                    "dayRest": 0,
                    "weekDrive": 0,
                    "weekDriveAlarm": 0,
                    "weekDriveDisposable": 0,
                    "weekDriveDisposableAlarm": 0,
                    "twoWeekDriveDisposable": 0,
                    "weekLabour": 0,
                    "weekLabourAlarm": 0,
                    "extendedDriving": 0,
                    "extendedDrivingAlarm": 0,
                    "reducedDayRests": 0,
                    "reducedDayRestsAlarm": 0,
                    "dayDriveMaxAllowed": 0,
                    "weekDriveMaxAllowed": 0,
                    "twoWeekDriveMaxAllowed": 0,
                    "remainingDrivingPauseTime": 0
                  }
                },
                "stopEventType": 0
              }
            ],
            "stopStatus": 0
          }
        ],
        "tourStatus": 0,
        "tourTasks": [
          {
            "id": "string",
            "name": "string",
            "node": {
              "id": "string",
              "name": "string",
              "address": {
                "street": "string",
                "number": "string",
                "zip": "string",
                "city": "string",
                "country": "string",
                "zone": "string"
              },
              "nodeType": 0,
              "timeWindows": [
                {
                  "date": "2023-12-18T08:27:02.986Z",
                  "timeSlots": [
                    {
                      "startTime": 0,
                      "endTime": 0
                    }
                  ]
                }
              ],
              "location": {
                "longitude": 0,
                "latitude": 0
              },
              "nodeDetails": [
                {
                  "key": "string",
                  "value": "string"
                }
              ]
            },
            "tourTaskType": 0,
            "expectedStartTime": "2023-12-18T08:27:02.986Z",
            "expectedEndTime": "2023-12-18T08:27:02.986Z",
            "actualStartTime": "2023-12-18T08:27:02.986Z",
            "actualEndTime": "2023-12-18T08:27:02.986Z",
            "driver": {
              "id": "string",
              "code": "string",
              "name": "string",
              "phone": "string",
              "remainingDrivingHours": {
                "eventTime": "2023-12-18T08:27:02.986Z",
                "cardID": "string",
                "isCo": true,
                "coCardID": "string",
                "cardStatus": true,
                "activity": 0,
                "duration": 0,
                "startDay": "2023-12-18T08:27:02.986Z",
                "driveBreak": 0,
                "continuousDrive": 0,
                "continuousDriveAlarm": 0,
                "dayDrive": 0,
                "dayDriveAlarm": 0,
                "dayDriveDisposable": 0,
                "dayDriveDisposableAlarm": 0,
                "dayRest": 0,
                "weekDrive": 0,
                "weekDriveAlarm": 0,
                "weekDriveDisposable": 0,
                "weekDriveDisposableAlarm": 0,
                "twoWeekDriveDisposable": 0,
                "weekLabour": 0,
                "weekLabourAlarm": 0,
                "extendedDriving": 0,
                "extendedDrivingAlarm": 0,
                "reducedDayRests": 0,
                "reducedDayRestsAlarm": 0,
                "dayDriveMaxAllowed": 0,
                "weekDriveMaxAllowed": 0,
                "twoWeekDriveMaxAllowed": 0,
                "remainingDrivingPauseTime": 0
              }
            }
          }
        ],
        "tourLiveEvents": [
          {
            "id": "string",
            "name": "string",
            "actualStartTime": "2023-12-18T08:27:02.986Z",
            "actualEndTime": "2023-12-18T08:27:02.986Z",
            "driver": {
              "id": "string",
              "code": "string",
              "name": "string",
              "phone": "string",
              "remainingDrivingHours": {
                "eventTime": "2023-12-18T08:27:02.986Z",
                "cardID": "string",
                "isCo": true,
                "coCardID": "string",
                "cardStatus": true,
                "activity": 0,
                "duration": 0,
                "startDay": "2023-12-18T08:27:02.986Z",
                "driveBreak": 0,
                "continuousDrive": 0,
                "continuousDriveAlarm": 0,
                "dayDrive": 0,
                "dayDriveAlarm": 0,
                "dayDriveDisposable": 0,
                "dayDriveDisposableAlarm": 0,
                "dayRest": 0,
                "weekDrive": 0,
                "weekDriveAlarm": 0,
                "weekDriveDisposable": 0,
                "weekDriveDisposableAlarm": 0,
                "twoWeekDriveDisposable": 0,
                "weekLabour": 0,
                "weekLabourAlarm": 0,
                "extendedDriving": 0,
                "extendedDrivingAlarm": 0,
                "reducedDayRests": 0,
                "reducedDayRestsAlarm": 0,
                "dayDriveMaxAllowed": 0,
                "weekDriveMaxAllowed": 0,
                "twoWeekDriveMaxAllowed": 0,
                "remainingDrivingPauseTime": 0
              }
            },
            "tourEventType": 0,
            "location": {
              "longitude": 0,
              "latitude": 0
            }
          }
        ]
      }
    ],
    "distanceUnit": 0,
    "currency": 0
  }
}

Attributes Description

Manual Plan

The "manualPlan" object shows the full plan for handling tours, including intricate details related to vehicles, drivers, stops, and associated events.

Object AttributeData TypeRequiredDescription

manualPlan

Object

Required

The main object representing a manual plan.

manualPlan.tours

List of tours

Required

A list of tours within the manual plan.

manualPlan.distanceUnit

Integer

Required

The unit of distance used in the plan.

manualPlan.currency

Integer

Required

The currency used in the plan.

Tour

This object represents a logistical route plan, about a sequence of tours each associated with specific details. A tour, identified by a unique ID, contains crucial information such as the assigned vehicle and driver, the creation and modification dates, the route's creation date, and its last modification date.

Object AttributeData TypeRequiredDescription

id

String

Required

The ID of the tour.

vehicle

Object

Required

Details about the vehicle associated with the tour.

driver

Object

Required

Details about the driver associated with the tour.

routeMode

Integer

-

The route mode for the tour.

trailers

List of trailers

-

A list of trailers associated with the tour.

creationDate

String (Date)

-

The date and time when the tour was created.

lastModifiedDate

String (Date)

-

The date and time when the tour was last modified.

Vehicle

This object shows that each vehicle is uniquely identified by an ID and is associated with essential attributes such as its plate number, a distinct code, and its vehicle type, specifying characteristics like name, weight, and volume.

Object AttributeData TypeRequiredDescription

id

String

Required

The ID of the vehicle.

plateNumber

String

Required

The plate number of the vehicle.

code

String

Required

The code associated with the vehicle.

vehicleType

Object

Required

Details about the type of vehicle.

home

Object

Required

Details about the home location of the vehicle.

depot

Object

Required

Details about the depot location of the vehicle.

Vehicle Type

It defines the characteristics and specifications of a particular type of vehicle within the system.

Object AttributeData TypeRequiredDescription

name

String

-

The name of the vehicle type.

weight

Number

-

The weight capacity of the vehicle type.

volume

Number

-

The volume capacity of the vehicle type.

Home

It represents a chosen location that serves as the base or starting point for a vehicle in the logistics system.

Object AttributeData TypeRequiredDescription

id

String

Required

The ID of the home location.

name

String

Required

The name of the home location.

address

Object

Required

Details about the address of the home location.

nodeType

Integer

Required

This property should take one of 6 values: Depot, Warehouse, Customer Location, Store, Home, Any

timeWindows

List of time windows

Required

A list of time windows for the home location.

location

Object

Required

Details about the geographical location of the home.

Address

Represents the details pertaining to a geographical location within the logistics system.

Object AttributeData TypeRequiredDescription

street

String

Required

The street of the address.

number

String

Required

The street number of the address.

zip

String

-

The ZIP code of the address.

city

String

-

The city of the address.

country

String

-

The country of the address.

zone

String

-

The zone of the address.

Time Window

It plays a crucial role in scheduling and time management within the logistics system.

Object AttributeData TypeRequiredDescription

date

String (Date)

Required

The date of the time window.

timeSlots

List of time slots

Required

A list of time slots within the time window.

Location

It represents the geographical coordinates of a node within the logistics system.

Object AttributeData TypeRequiredDescription

longitude

Number

Required

The longitude of the location.

latitude

Number

Required

The latitude of the location.

Node Details

Each entry in this object consists of a key and a corresponding value, allowing for the inclusion of custom information relevant to a particular node.

Object AttributeData TypeRequiredDescription

key

String

Required

The key of the node detail.

value

String

Required

The value of the node detail.

Depot

Shows the details about a logistics depot, serving as a pivotal node within the supply chain.

Object AttributeData TypeRequiredDescription

id

String

Required

The ID of the depot location.

name

String

Required

The name of the depot location.

address

Object

Required

Details about the address of the depot location.

nodeType

Integer

Required

This property should take one of 6 values: Depot, Warehouse, Customer Location, Store, Home, Any

timeWindows

List of time windows

Required

A list of time windows for the depot location.

location

Object

Required

Details about the geographical location of the depot.

Vehicle Details

This Object offers specific insights into the attributes of a vehicle.

Object AttributeData TypeRequiredDescription

key

String

-

The key of the vehicle detail.

value

String

-

The value of the vehicle detail.

Driver

This object in the manual plan structure summarizes essential information about the personnel responsible for operating the assigned vehicle.

Object AttributeData TypeRequiredDescription

id

String

Required

The ID of the driver.

code

String

Required

The code associated with the driver.

name

String

Required

The name of the driver.

phone

String

Required

The phone number of the driver.

remainingDrivingHours

Object

Required

Details about the remaining driving hours for the driver.

Remaining Driving Hours

It offers the detailed overview of the driver's remaining driving hours.

AttributeData TypeRequiredDescription

eventTime

String

-

Timestamp of the latest event related to the driver's hours.

cardID

String

-

ID associated with the driver's card.

isCo

Boolean

-

Indicates whether the driver is a co-driver.

coCardID

String

-

ID associated with the co-driver's card, if applicable.

cardStatus

Boolean

-

Status of the driver's card.

activity

Integer

-

Current activity status of the driver.

duration

Integer

-

Duration of the driver's activity.

startDay

String

-

Timestamp indicating the start of the driver's day.

driveBreak

Integer

-

Duration of the driver's break during driving.

continuousDrive

Integer

-

Duration of continuous driving by the driver.

continuousDriveAlarm

Integer

-

Alarm related to continuous driving by the driver.

dayDrive

Integer

-

Duration of driving within a day by the driver.

dayDriveAlarm

Integer

-

Alarm related to driving within a day by the driver.

dayDriveDisposable

Integer

-

Disposable duration of driving within a day by the driver.

dayDriveDisposableAlarm

Integer

-

Alarm related to disposable duration of driving within a day by the driver.

dayRest

Integer

-

Duration of rest within a day by the driver.

weekDrive

Integer

-

Duration of driving within a week by the driver.

weekDriveAlarm

Integer

-

Alarm related to driving within a week by the driver.

weekDriveDisposable

Integer

-

Disposable duration of driving within a week by the driver.

weekDriveDisposableAlarm

Integer

-

Alarm related to disposable duration of driving within a week by the driver.

twoWeekDriveDisposable

Integer

-

Disposable duration of driving within two weeks by the driver.

weekLabour

Integer

-

Duration of labor within a week by the driver.

weekLabourAlarm

Integer

-

Alarm related to labor within a week by the driver.

extendedDriving

Integer

-

Extended duration of driving by the driver.

extendedDrivingAlarm

Integer

-

Alarm related to extended duration of driving by the driver.

reducedDayRests

Integer

-

Duration of reduced rest within a day by the driver.

reducedDayRestsAlarm

Integer

-

Alarm related to reduced rest within a day by the driver.

dayDriveMaxAllowed

Integer

-

Maximum allowed duration of driving within a day by the driver.

weekDriveMaxAllowed

Integer

-

Maximum allowed duration of driving within a week by the driver.

twoWeekDriveMaxAllowed

Integer

-

Maximum allowed duration of driving within two weeks by the driver.

remainingDrivingPauseTime

Integer

-

Remaining time for the driving pause.

Trailer

Shows details about a trailer associated with a specific tour.

Object AttributeData TypeRequiredDescription

id

String

Required

The ID of the trailer.

plateNumber

String

Required

The plate number of the trailer.

trailerDetails

List trailer details

-

A list of details about the trailer.

trailerType

Object

-

Details about the type of trailer.

Trailer Details

Gives more details about a trailer associated with a specific tour.

Object AttributeData TypeRequiredDescription

key

String

-

The key of the trailer detail.

value

String

-

The value of the trailer detail.

Stops

It represents the various stopping points or locations included in a tour.

Object AttributeData TypeRequiredDescription

node

Object

Required

Details about the node associated with the stop.

orders

List of orders

Required

A list of orders associated with the stop.

expectedDistance

Number

Required

The expected distance for the stop.

actualDistance

Number

Required

The actual distance for the stop.

stopTasks

List of tasks

Required

A list of tasks associated with the stop.

stopEvents

List of events

Required

A list of events associated with the stop.

stopStatus

Integer

Required

The status of the stop.

Node

Shows information about locations within the logistics system, serving as waypoints or stops in a tour.

Object AttributeData TypeRequiredDescription

id

String

Required

The ID of the node.

name

String

Required

The name of the node.

address

Object

Required

Details about the address of the node.

nodeType

Integer

Required

This property should take one of 6 values: Depot, Warehouse, Customer Location, Store, Home, Any

timeWindows

List of time windows

Required

A list of time windows for the node.

location

Object

Required

Details about the geographical location of the node.

Customer

Each customer is uniquely identified by an id and characterized by a name. The customer object provides essential details about the recipient.

Object AttributeData TypeRequiredDescription

id

String

Required

The ID of the customer.

name

String

Required

The name of the customer.

Orders

Orders object summarizes information about individual delivery orders within the manual plan. Each order is uniquely identified by an order ID and includes details such as customer information, creation and last modification dates.

AttributeData TypeRequiredDescription

orderID

String

Yes

Unique identifier for the order.

orderDescription

String

No

Description or details related to the order.

customer

Object

Yes

Details about the customer placing the order.

creationDate

String (datetime)

Yes

Date and time when the order was created.

lastModifiedDate

String (datetime)

Yes

Date and time when the order was last modified.

orderStatus

Integer

Yes

Status of the order (e.g., processing, completed).

planningGroup

Object

Yes

Details about the planning group associated with the order.

orderDetails

List of objects

No

Additional details related to the order, provided as key-value pairs.

orderTasks

List of tasks

No

List of tasks associated with the order.

totalWeight

Number

No

Total weight of the order.

totalVolume

Number

No

Total volume of the order.

Order Tasks

This object represents the several tasks associated with fulfilling a specific order within the logistics system. Each task is uniquely identified by an id and is described by a meaningful name.

Object AttributeData TypeRequiredDescription

id

String

Required

The ID of the order task.

name

String

Required

The name of the order task.

requestedTaskDueDate

String (Date)

Required

The requested due date of the order task.

requestedTimeSlot

Object

Required

The requested time slot for the order task.

orderTaskType

Integer

Required

enum takes values: Loading, UnLoading

alertPriority

Integer

Required

The priority level of the order task.

reference

String

Required

The reference associated with the order task.

dispatched

Boolean

Required

Indicates if the order task has been dispatched.

trailer

Object

Required

Details about the trailer associated with the order task.

expectedStartTime

String (Date)

Required

The expected start time of the order task.

expectedEndTime

String (Date)

Required

The expected end time of the order task.

actualStartTime

String (Date)

Required

The actual start time of the order task.

actualEndTime

String (Date)

Required

The actual end time of the order task.

driver

Object

Required

Details about the driver associated with the order task.

Tour Tasks

This object represents the tasks associated with a logistics tour, offering a detailed view of the activities involved in executing the tour.

Object AttributeData TypeRequiredDescription

id

String

Required

The ID of the tour task.

name

String

Required

The name of the tour task.

node

Object

Required

Details about the node associated with the tour task.

tourTaskType

Integer

Required

enum takes values: Start, End

expectedStartTime

String (Date)

Required

The expected start time of the tour task.

expectedEndTime

String (Date)

Required

The expected end time of the tour task.

actualStartTime

String (Date)

Required

The actual start time of the tour task.

actualEndTime

String (Date)

Required

The actual end time of the tour task.

driver

Object

Required

Details about the driver associated with the tour task.

Tour Live Events

The object captures live events occurring during a logistics tour, providing real-time insights into the tour's progress and status.

Object AttributeData TypeRequiredDescription

id

String

Required

The ID of the tour live event.

name

String

Required

The name of the tour live event.

actualStartTime

String (Date)

Required

The actual start time of the tour live event.

actualEndTime

String (Date)

Required

The actual end time of the tour live event.

driver

Object

Required

Details about the driver associated with the tour live event.

tourEventType

Integer

Required

enum takes values: Rest, Traffic Jam, Acciednt, BreakDown, Driving, Tanking, Maintenance, Available, Damage, Empty, Cancelled

location

Object

Required

Details about the geographical location of the tour live event.

Available Endpoints

Send Manual Plan

POST https://api.normalive.ai/SendManualPlan

Send Request for manual plan

Headers

NameTypeDescription

authentication *

String

Bearer token acquired after authentication

Request Body

NameTypeDescription

Manualplan *

Object

Request manual plan

PreviousGet Norma Plan

Last updated