Orders

The Orders section provides users with essential functionalities for seamless management of their logistics operations. Customers gain the capability to send new orders or update existing ones.

Orders Object

This object represents how to create a new order, providing its ID and code, in addition to some detailed descriptions like order planning, stops, and suitable vehicles for this order.

{
	"orderID": "string",
	"orderCode": "string",
	"orderDescription": "string",
	"customer": {
		"id": "string",
		"name": "string",
		"type": "string"
	},
	"creationDate": "2023-12-07T11:42:31.671Z",
	"lastModifiedDate": "2023-12-07T11:42:31.671Z",
	"operationalStatus": {
		"statusName": "string",
		"statusColorInHexa": "string"
	},
	"planningStatus": 0,
	"planningGroup": {
		"name": "string"
	},
	"details": [
		{
			"key": "string",
			"value": "string"
		}
	],
	"orderTasks": [
		{
			"name": "string",
			"reference": "string",
			"orderTaskType": 0,
			"node": {
				"id": "string",
				"name": "string",
				"address": {
					"street": "string",
					"number": "string",
					"zip": "string",
					"city": "string",
					"country": "string",
					"zone": "string"
				},
				"nodeType": 0,
				"location": {
					"longitude": 0,
					"latitude": 0
				},
				"openingHours": {
					"constraint": {
						"timeWindows": [
							{
								"dayOfWeek": 0,
								"timeSlots": [
									{
										"startTime": 0,
										"endTime": 0
									}
								]
							}
						]
					},
					"constraintType": 0
				},
				"allowedVehicleTypes": {
					"constraint": [
						{
							"id": "string",
							"name": "string",
							"code": "string",
							"capacity": {
								"weight": 0,
								"volume": 0
							},
							"costDollarPerKm": 0,
							"maximumTripTimeInHours": 0,
							"compartmentStatus": 0,
							"transportModeTypeEnum": 0,
							"compartments": [
								{
									"code": "string",
									"percentage": 0,
									"minimumCompartmentVolumePercentage": 0,
									"maximumCompartmentVolumePercentage": 0
								}
							],
							"dimension": {
								"width": 0,
								"length": 0,
								"height": 0
							},
							"pallets": [
								{
									"palletType": "string",
									"count": 0,
									"stackable": true
								}
							]
						}
					],
					"constraintType": 0
				},
				"allowedVehicles": {
					"constraint": [
						{
							"id": "string",
							"code": "string",
							"plateNumber": "string",
							"maxAllowedTripTime": 0,
							"maxAllowedTripDistance": 0,
							"cost": 0,
							"defaultDriverID": "string",
							"vehicleType": {
								"id": "string",
								"name": "string",
								"code": "string",
								"capacity": {
									"weight": 0,
									"volume": 0
								},
								"costDollarPerKm": 0,
								"maximumTripTimeInHours": 0,
								"compartmentStatus": 0,
								"transportModeTypeEnum": 0,
								"compartments": [
									{
										"code": "string",
										"percentage": 0,
										"minimumCompartmentVolumePercentage": 0,
										"maximumCompartmentVolumePercentage": 0
									}
								],
								"dimension": {
									"width": 0,
									"length": 0,
									"height": 0
								},
								"pallets": [
									{
										"palletType": "string",
										"count": 0,
										"stackable": true
									}
								]
							},
							"home": {
								"id": "string",
								"name": "string",
								"address": {
									"street": "string",
									"number": "string",
									"zip": "string",
									"city": "string",
									"country": "string",
									"zone": "string"
								},
								"nodeType": 0,
								"location": {
									"longitude": 0,
									"latitude": 0
								},
								"openingHours": {
									"timeWindows": [
										{
											"dayOfWeek": 0,
											"timeSlots": [
												{
													"startTime": 0,
													"endTime": 0
												}
											]
										}
									]
								},
								"isDefault": true
							},
							"depot": {
								"id": "string",
								"name": "string",
								"address": {
									"street": "string",
									"number": "string",
									"zip": "string",
									"city": "string",
									"country": "string",
									"zone": "string"
								},
								"nodeType": 0,
								"location": {
									"longitude": 0,
									"latitude": 0
								},
								"openingHours": {
									"timeWindows": [
										{
											"dayOfWeek": 0,
											"timeSlots": [
												{
													"startTime": 0,
													"endTime": 0
												}
											]
										}
									]
								},
								"isDefault": true
							},
							"planningGroup": {
								"name": "string"
							},
							"vehicleCharacteristics": {
								"hasCooler": true,
								"hasForkLift": true
							},
							"availability": {
								"timeWindows": [
									{
										"date": "2023-12-07T11:42:31.672Z",
										"timeSlots": [
											{
												"startTime": 0,
												"endTime": 0
											}
										]
									}
								]
							}
						}
					],
					"constraintType": 0
				},
				"vehicleCharacteristics": {
					"constraint": {
						"hasCooler": true,
						"hasForkLift": true
					},
					"constraintType": 0
				},
				"trailerCharacteristics": {
					"constraint": {
						"hasCooler": true
					},
					"constraintType": 0
				},
				"isDefault": true,
				"waitingTimeInMinutes": 0
			},
			"scheduleInfo": {
				"constraint": {
					"timeWindows": [
						{
							"date": "2023-12-07T11:42:31.672Z",
							"timeSlots": [
								{
									"startTime": 0,
									"endTime": 0
								}
							]
						}
					]
				},
				"constraintType": 0
			},
			"sequence": 0,
			"alertPriority": 0,
			"clusteringTimeConstraint": 0,
			"clusteringDistanceConstraint": 0,
			"serviceTimeInMinutes": 0,
			"SuggestedAppointment": {
				"constraint": {
					"date": "2023-12-07T11:42:31.672Z",
					"timeSlots": [
						{
							"startTime": 0,
							"endTime": 0
						}
					]
				},
				"constraintType": 0
			},
			"BookedAppointment": {
				"constraint": {
					"date": "2023-12-07T11:42:31.672Z",
					"timeSlots": [
						{
							"startTime": 0,
							"endTime": 0
						}
					]
				},
				"constraintType": 0
			}
		}
	],
	"orderGoods": [
		{
			"id": "string",
			"name": "string",
			"code": "string",
			"description": "string",
			"amount": 0,
			"capacity": {
				"weight": 0,
				"volume": 0
			},
			"dimensions": {
				"width": 0,
				"length": 0,
				"height": 0
			},
			"serviceTimeInMinutes": 0,
			"compartment": {
				"code": "string",
				"percentage": 0,
				"minimumCompartmentVolumePercentage": 0,
				"maximumCompartmentVolumePercentage": 0
			},
			"pallets": [
				{
					"palletType": "string",
					"count": 0,
					"stackable": true
				}
			]
		}
	],
	"capacity": {
		"weight": 0,
		"volume": 0
	},
	"allowedVehicleTypes": {
		"constraint": [
			{
				"id": "string",
				"name": "string",
				"code": "string",
				"capacity": {
					"weight": 0,
					"volume": 0
				},
				"costDollarPerKm": 0,
				"maximumTripTimeInHours": 0,
				"compartmentStatus": 0,
				"transportModeTypeEnum": 0,
				"compartments": [
					{
						"code": "string",
						"percentage": 0,
						"minimumCompartmentVolumePercentage": 0,
						"maximumCompartmentVolumePercentage": 0
					}
				],
				"dimension": {
					"width": 0,
					"length": 0,
					"height": 0
				},
				"pallets": [
					{
						"palletType": "string",
						"count": 0,
						"stackable": true
					}
				]
			}
		],
		"constraintType": 0
	},
	"allowedVehicles": {
		"constraint": [
			{
				"id": "string",
				"code": "string",
				"plateNumber": "string",
				"maxAllowedTripTime": 0,
				"maxAllowedTripDistance": 0,
				"cost": 0,
				"defaultDriverID": "string",
				"vehicleType": {
					"id": "string",
					"name": "string",
					"code": "string",
					"capacity": {
						"weight": 0,
						"volume": 0
					},
					"costDollarPerKm": 0,
					"maximumTripTimeInHours": 0,
					"compartmentStatus": 0,
					"transportModeTypeEnum": 0,
					"compartments": [
						{
							"code": "string",
							"percentage": 0,
							"minimumCompartmentVolumePercentage": 0,
							"maximumCompartmentVolumePercentage": 0
						}
					],
					"dimension": {
						"width": 0,
						"length": 0,
						"height": 0
					},
					"pallets": [
						{
							"palletType": "string",
							"count": 0,
							"stackable": true
						}
					]
				},
				"home": {
					"id": "string",
					"name": "string",
					"address": {
						"street": "string",
						"number": "string",
						"zip": "string",
						"city": "string",
						"country": "string",
						"zone": "string"
					},
					"nodeType": 0,
					"location": {
						"longitude": 0,
						"latitude": 0
					},
					"openingHours": {
						"timeWindows": [
							{
								"dayOfWeek": 0,
								"timeSlots": [
									{
										"startTime": 0,
										"endTime": 0
									}
								]
							}
						]
					},
					"isDefault": true
				},
				"depot": {
					"id": "string",
					"name": "string",
					"address": {
						"street": "string",
						"number": "string",
						"zip": "string",
						"city": "string",
						"country": "string",
						"zone": "string"
					},
					"nodeType": 0,
					"location": {
						"longitude": 0,
						"latitude": 0
					},
					"openingHours": {
						"timeWindows": [
							{
								"dayOfWeek": 0,
								"timeSlots": [
									{
										"startTime": 0,
										"endTime": 0
									}
								]
							}
						]
					},
					"isDefault": true
				},
				"planningGroup": {
					"name": "string"
				},
				"vehicleCharacteristics": {
					"hasCooler": true,
					"hasForkLift": true
				},
				"availability": {
					"timeWindows": [
						{
							"date": "2023-12-07T11:42:31.672Z",
							"timeSlots": [
								{
									"startTime": 0,
									"endTime": 0
								}
							]
						}
					]
				}
			}
		],
		"constraintType": 0
	},
	"driverSkills": {
		"constraint": {
			"hasFirstDegreeLicense": true,
			"canTransportDangerousGoods": true,
			"dutchSpeaker": true,
			"englishSpeaker": true,
			"adr": true,
			"forkliftLicense": true
		},
		"constraintType": 0
	},
	"vehicleCharacteristics": {
		"constraint": {
			"hasCooler": true,
			"hasForkLift": true
		},
		"constraintType": 0
	},
	"trailerCharacteristics": {
		"constraint": {
			"hasCooler": true
		},
		"constraintType": 0
	},
	"compartment": {
		"code": "string",
		"percentage": 0,
		"minimumCompartmentVolumePercentage": 0,
		"maximumCompartmentVolumePercentage": 0
	},
	"dimension": {
		"width": 0,
		"length": 0,
		"height": 0
	},
	"pallets": [
		{
			"palletType": "string",
			"count": 0,
			"stackable": true
		}
	],
	"pickupDeliveryDistance": 0,
	"extendedData": {
		"suggestedDriver": "string"
	}
}

Attributes Description

Order Object

Attribute	Data Type	Required	Description
orderID	String	Required	Unique identifier for the order.
orderCode	String	-	Code associated with the order.
orderDescription	String	-	Description of the order.
customer	Object	-	Information about the customer.
creationDate	String	-	Date and time when the order was created.
lastModifiedDate	String	-	Date and time when the order was last modified.
operationalStatus	Object	-	Operational status information.
planningStatus	Number	-	Planning status of the order.
planningGroup	Object	-	Planning group associated with the order.
details	List of key value	-	List of key-value pairs providing additional details.
orderTasks	List of tasks	-	List of tasks associated with the order.
orderGoods	List of goods	-	List of goods associated with the order.
capacity	Object	-	Capacity information for the order.
allowedVehicleTypes	Object	-	Allowed vehicle types for the order.
allowedVehicles	Object	-	Allowed vehicles for the order.
driverSkills	Object	-	Driver skills required for the order.
vehicleCharacteristics	Object	-	Vehicle characteristics required for the order.
trailerCharacteristics	Object	-	Trailer characteristics required for the order.
compartment	Object	-	Compartment details for the order.
dimension	Object	-	Dimension details for the order.
pallets	List of pallets	-	List of pallet details for the order.
pickupDeliveryDistance	Number	-	Distance for pickup and delivery.
extendedData	Object	-	Extended data providing additional information for the order.

Customer Object

Customer-specific information.

Attribute	Data Type	Required	Description
id	String	-	Customer identifier.
name	String	-	Customer name.
type	String	-	Type of the customer.

Planning Group

Represents the planning group name.

Attribute	Data Type	Required	Description
name	String	-	Name of the planning group.

Details

Order's extra details.

Attribute	Data Type	Required	Description
key	String	-	Key for the detail.
value	String	-	Value associated with the key.

Capacity

Order's capacity.

Attribute	Data Type	Required	Description
weight	Number	-	Weight capacity.
volume	Number	-	Volume capacity.

Order Task

Order Task explains the task applied to the order, whether it's a pickup, delivery, or both. It represents the task number, stops, and scheduling time.

Attribute	Data Type	Required	Description
name	String	-	Name of the task.
reference	String	-	Reference associated with the task.
orderTaskType	Number	-	enum takes values: Loading, UnLoading
node	Object	-	Node information associated with the task.
scheduleInfo	Object	-	Schedule information for the task.
sequence	Number	-	Sequence of the task.
alertPriority	Number	-	Priority of the alert for the task.
clusteringTimeConstraint	Number	-	Time constraint for clustering tasks.
clusteringDistanceConstraint	Number	-	Distance constraint for clustering tasks.
serviceTimeInMinutes	Number	-	Service time required for the task in minutes.
SuggestedAppointment	Object	-	Suggested appointment constraints for the order task.
BookedAppointment	Object	-	Booked time constraint for the task.

Suggested Appointment Time Constraint

Delivering and receiving time constraints suggestion.

Attribute	Data Type	Required	Description
SuggestedAppointment	Object	-	Information about the suggested time constraint.
SuggestedAppointment.constraint	Object	-	Constraints associated with the suggested time.
SuggestedAppointment.constraint.date	String	-	Date for the suggested time constraint.
SuggestedAppointment.constraint.timeSlots	List of time slots	-	List of time slots associated with the suggested time.
SuggestedAppointment.constraint.timeSlots.startTime	Number	-	Start time for the suggested time slot.
SuggestedAppointment.constraint.timeSlots.endTime	Number	-	End time for the suggested time slot.

Booked Appointment Time Constraint

Delivering and receiving booked time.

Attribute	Data Type	Required	Description
BookedAppointment	Object	-	Information about the booked time constraint.
BookedAppointment.constraint	Object	-	Constraints associated with the booked time.
BookedAppointment.constraint.date	String	-	Date for the booked time constraint.
BookedAppointment.constraint.timeSlots	List of time slots	-	List of time slots associated with the booked time.
BookedAppointment.constraint.timeSlots.startTime	Number	-	Start time for the booked time slot.
BookedAppointment.constraint.timeSlots.endTime	Number	-	End time for the booked time slot.
BookedAppointment.constraintType	Number	-	Type of constraint associated with the booked time.

Order Goods

Goods Details.

Attribute	Data Type	Required	Description
id	String	-	Unique identifier for the goods.
name	String	-	Name of the goods.
code	String	-	Code associated with the goods.
description	String	-	Description of the goods.
amount	Number	-	Amount of the goods.
capacity	Object	-	Capacity information for the goods.
dimensions	Object	-	Dimensions information for the goods.
serviceTimeInMinutes	Number	-	Service time required for handling the goods in minutes.
compartment	Object	-	Compartment details for handling the goods.
pallets	List of pallets	-	List of pallet details for handling the goods.

Allowed Vehicle Types

Vehicle types constrains.

Attribute	Data Type	Required	Description
constraint	List of allowed vehicles	-	List of allowed vehicle types and associated details.
constraintType	Number	-	Type of constraint.

Allowed Vehicles

Vehicle constraints

Attribute	Data Type	Required	Description
constraint	List of allowed vehicles	-	List of allowed vehicles and associated details.
constraintType	Number	-	Type of constraint.

Vehicle Characteristics

Vehicles features.

Attribute	Data Type	Required	Description
constraint	Object	-	Vehicle characteristics constraint and associated details.
constraintType	Number	-	Type of constraint.

Trailer Characteristics

Trailer features.

Attribute	Data Type	Required	Description
constraint	Object	-	Trailer characteristics constraint and associated details.
constraintType	Number	-	Type of constraint.

Compartment

Compartment information.

Attribute	Data Type	Required	Description
code	String	-	Code associated with the compartment.
percentage	Number	-	Percentage of compartment usage.
minimumCompartmentVolumePercentage	Number	-	Minimum percentage of compartment volume.
maximumCompartmentVolumePercentage	Number	-	Maximum percentage of compartment volume.

Dimension

Object dimensions.

Attribute	Data Type	Required	Description
width	Number	-	Width dimension.
length	Number	-	Length dimension.
height	Number	-	Height dimension.

Pallets

Pallets information.

Attribute	Data Type	Required	Description
palletType	String	-	Type of pallet.
count	Number	-	Count of pallets.
stackable	Boolean	-	Stackability of pallets.

Driver Skills

Driver skills information.

Attribute	Data Type	Required	Description
driverSkills	Object	-	Information related to the driver's skills.
driverSkills.constraint	Object	-	The constraints associated with driver skills.
driverSkills.constraint.hasFirstDegreeLicense	Boolean	-	Indicates if the driver has a first-degree license.
driverSkills.constraint.canTransportDangerousGoods	Boolean	-	Indicates if the driver can transport dangerous goods.
driverSkills.constraint.dutchSpeaker	Boolean	-	Indicates if the driver is a Dutch speaker.
driverSkills.constraint.englishSpeaker	Boolean	-	Indicates if the driver is an English speaker.
driverSkills.constraint.adr	Boolean	-	Indicates if the driver has an ADR
driverSkills.constraint.forkliftLicense	Boolean	-	Indicates if the driver has a forklift license.
driverSkills.constraintType	Number	-	The type of constraint associated with driver skills.

Creation Date

Order creation date

Attribute	Data Type	Required	Description
creationDate	String	-	The date and time when the order was created>

Last Modified Date

order last modification date

Attribute	Data Type	Required	Description
lastModifiedDate	String	-	The date and time when the order was last modified.

Operational Status

Order's operational staus information

Attribute	Data Type	Required	Description
operationalStatus	Object	-	The operational status of the order.
operationalStatus.statusName	String	-	The name of the operational status.
operationalStatus.statusColorInHexa	String	-	The color code in hexadecimal format associated with the operational status.

Node Type

Node type information

Attribute	Data Type	Required	Description
nodeType	Number	-	This property should take one of 6 values: Depot, Warehouse, Customer Location, Store, Home, Any.

Location

Node location

Attribute	Data Type	Required	Description
location	Object	Required	The geographical coordinates of the node.
location.longitude	Number	-	The longitude coordinate of the node's location.
location.latitude	Number	-	The latitude coordinate of the node's location.

Schedule Info

Schedule constraints information

Attribute	Data Type	Required	Description
scheduleInfo	Object	-	Information related to the schedule constraints.
scheduleInfo.constraint	Object	-	The constraints associated with the schedule.
scheduleInfo.constraint.timeWindows	List of time windows	-	List of time windows for scheduling.
scheduleInfo.constraint.timeWindows.date	String	-	The date for the time window in "YYYY-MM-DDTHH:mm:ss.sssZ" format.
scheduleInfo.constraint.timeWindows.timeSlots	List of time slots	-	List of time slots within the time window.
scheduleInfo.constraint.timeWindows.timeSlots.startTime	Number	-	The start time of the time slot.
scheduleInfo.constraint.timeWindows.timeSlots.endTime	Number	-	The end time of the time slot.

Time Slot

Slot ending and receiving times

Attribute	Data Type	Required	Description
StartTime	Time	-	Start time of the time slot
EndTime	Time	-	End time of the time slot

Opening Hours

The opening hours object indicates the opening time slots for each day of the week

Attribute	Data Type	Required	Description
TimeWindows	List of time windows object	-	List of time windows
DayOfWeek	String	-	Day of week
TimeSlot	List of time slot object	-	Start and end time slots

Address

The address details of the pickup or delivery node are represented here.

Attribute	Data Type	Required	Description
Street	String	-	The street name of the address.
Number	String	-	The street number of the address.
Zip	String	-	The postal code of the address.
City	String	-	The city of the address.
Country	String	-	The country of the address.
Zone	String	-	The zone or region of the address.

Location

Location requires the longitude and latitude of the node.

Attribute	Data Type	Required	Description
Longitude	Number	Required	The longitude coordinate of the location.
Latitude	Number	Required	The latitude coordinate of the location.

Constraint Generic Object

Generic object to specify constraint type (hard/soft) that is used to warp another object

Attribute	Data Type	Required	Description
Constraint	List of allowed vehicle type information	Required	List of allowed vehicle type information objects.
ConstraintType	Number	Required	Type of this constraint 0:Soft 1:Hard

Operational Status

Order's operational status

Attribute	Data Type	Required	Description
operationalStatus	Object	-	The operational status of the order.
operationalStatus.statusName	String	-	The name of the operational status.
operationalStatus.statusColorInHexa	String	-	The color code in hexadecimal format associated with the operational status.

Pickup/Delivery Distance

Distance between the pickup and the delivery points

Attribute	Data Type	Required	Description
pickupDeliveryDistance	Number	-	Distance for pickup

Extended Data

Customized extra information.

Attribute	Data Type	Required	Description
extendedData	Object	-	Extended data associated with the order.
extendedData.suggestedDriver	String	-	Suggested driver for the order.

Descriptive Response Object

This object typically includes key-value pairs, with fields such as "status" indicating the overall success or failure.

Attribute	Data Type	Required	Description
Value	String	Yes	The response message.
IsErrorState	Boolean	Yes	Indicates if an error occurred.
ErrorMessage	String	-	The error message (if IsErrorState is true).
ErrorCode	String	-	The error code (if IsErrorState is true).

Available Endpoints

Send Order

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

This endpoint will add a new order if its ID doesn’t exist and will update it if it already exists.

Headers

Name	Type	Description
authentication *	String	Bearer token acquired after authentication

Request Body

Name	Type	Description
Order*	Object	Order Object

200: OK Message Received Successfully

400: Bad Request Text message or code error

Descriptive Response

401: Unauthorized Invalid token

Example

In this example, an invalid order ID was used, so the user got an error response from the system.

{
  "orderID": "123456",
  "orderCode": "ORD123",
  "orderDescription": "Delivery of goods",
  "customer": {
    "id": "CUST789",
    "name": "ABC Company",
    "type": "Business"
  },
  "creationDate": "2023-12-07T11:42:31.671Z",
  "lastModifiedDate": "2023-12-07T11:42:31.671Z",
  "operationalStatus": {
    "statusName": "Active",
    "statusColorInHexa": "#00FF00"
  },
  "planningStatus": 0,
  "planningGroup": {
    "name": "Logistics"
  },
  "details": [
    {
      "key": "Priority",
      "value": "High"
    },
    {
      "key": "Temperature Control",
      "value": "Required"
    }
  ],
  "orderTasks": [
    {
      "name": "Task 1",
      "reference": "REF123",
      "orderTaskType": 0,
      "node": {
        "id": "NODE001",
        "name": "Warehouse A",
        "address": {
          "street": "123 Main St",
          "number": "1A",
          "zip": "12345",
          "city": "Cityville",
          "country": "Countryland",
          "zone": "Zone1"
        },
        "nodeType": 0,
        "location": {
          "longitude": 45.6789,
          "latitude": -12.3456
        },
        "openingHours": {
          "constraint": {
            "timeWindows": [
              {
                "dayOfWeek": 1,
                "timeSlots": [
                  {
                    "startTime": 8,
                    "endTime": 17
                  }
                ]
              }
            ]
          },
          "constraintType": 0
        },
        "allowedVehicleTypes": {
          "constraint": [
            {
              "id": "VTYPE001",
              "name": "Refrigerated Truck",
              "code": "RT001",
              "capacity": {
                "weight": 5000,
                "volume": 50
              },
              "costDollarPerKm": 2.5,
              "maximumTripTimeInHours": 8,
              "compartmentStatus": 1,
              "transportModeTypeEnum": 0,
              "compartments": [
                {
                  "code": "CPT001",
                  "percentage": 80,
                  "minimumCompartmentVolumePercentage": 20,
                  "maximumCompartmentVolumePercentage": 100
                }
              ],
              "dimension": {
                "width": 2.5,
                "length": 6.0,
                "height": 2.8
              },
              "pallets": [
                {
                  "palletType": "Standard",
                  "count": 10,
                  "stackable": true
                }
              ]
            }
          ],
          "constraintType": 0
        },
        "allowedVehicles": {
          "constraint": [
            {
              "id": "VEH001",
              "code": "TRK001",
              "plateNumber": "ABC123",
              "maxAllowedTripTime": 6,
              "maxAllowedTripDistance": 200,
              "cost": 50,
              "defaultDriverID": "DRIVER001",
              "vehicleType": {
                "id": "VTYPE001",
                "name": "Refrigerated Truck",
                "code": "RT001",
                "capacity": {
                  "weight": 5000,
                  "volume": 50
                },
                "costDollarPerKm": 2.5,
                "maximumTripTimeInHours": 8,
                "compartmentStatus": 1,
                "transportModeTypeEnum": 0,
                "compartments": [
                  {
                    "code": "CPT001",
                    "percentage": 80,
                    "minimumCompartmentVolumePercentage": 20,
                    "maximumCompartmentVolumePercentage": 100
                  }
                ],
                "dimension": {
                  "width": 2.5,
                  "length": 6.0,
                  "height": 2.8
                },
                "pallets": [
                  {
                    "palletType": "Standard",
                    "count": 10,
                    "stackable": true
                  }
                ]
              },
              "home": {
                "id": "NODE001",
                "name": "Warehouse A",
                "address": {
                  "street": "123 Main St",
                  "number": "1A",
                  "zip": "12345",
                  "city": "Cityville",
                  "country": "Countryland",
                  "zone": "Zone1"
                },
                "nodeType": 0,
                "location": {
                  "longitude": 45.6789,
                  "latitude": -12.3456
                },
                "openingHours": {
                  "timeWindows": [
                    {
                      "dayOfWeek": 1,
                      "timeSlots": [
                        {
                          "startTime": 8,
                          "endTime": 17
                        }
                      ]
                    }
                  ]
                },
                "isDefault": true
              },
              "depot": {
                "id": "NODE002",
                "name": "Depot B",
                "address": {
                  "street": "456 Depot St",
                  "number": "2B",
                  "zip": "56789",
                  "city": "Depotville",
                  "country": "Countryland",
                  "zone": "Zone2"
                },
                "nodeType": 0,
                "location": {
                  "longitude": 56.7890,
                  "latitude": -23.4567
                },
                "openingHours": {
                  "timeWindows": [
                    {
                      "dayOfWeek": 2,
                      "timeSlots": [
                        {
                          "startTime": 9,
                          "endTime": 16
                        }
                      ]
                    }
                  ]
                },
                "isDefault": true
              },
              "planningGroup": {
                "name": "Logistics"
              },
              "vehicleCharacteristics": {
                "hasCooler": true,
                "hasForkLift": true
              },
              "availability": {
                "timeWindows": [
                  {
                    "date": "2023-12-07T11:42:31.672Z",
                    "timeSlots": [
                      {
                        "startTime": 8,
                        "endTime": 17
                      }
                    ]
                  }
                ]
              }
            }
          ],
          "constraintType": 0
        },
        "vehicleCharacteristics": {
          "constraint": {
            "hasCooler": true,
            "hasForkLift": true
          },
          "constraintType": 0
        },
        "trailerCharacteristics": {
          "constraint": {
            "hasCooler": true
          },
          "constraintType": 0
        },
        "isDefault":

Response Error

{
  "Value": "Error",
  "IsErrorState": true,
  "ErrorMessage": "Invalid Order ID",
  "ErrorCode": "ERR001"
}

Delete Order

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

Endpoint for deleting orders.

Headers

Name	Type	Description
authentication *	String	Bearer token acquired after authentication

Request Body

Name	Type	Description
ID*	String	Order ID
Code*	String	Order Code

200: OK Message Received Successfully

400: Bad Request Text message or code error

Descriptive Response

401: Unauthorized Invalid token

{
  "OrderID": "order_id",
}

Update Order Status

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

This endpoint is for order status updates.

Headers

Name	Type	Description
authentication *	String	Bearer token acquired after authentication

Request Body

Name	Type	Description
OrderID*	String	Unique identifier for the order
OrderStatusWithColor*	String	Unique identifier for the order
StatusName*	String	Name of the order status
StatusColorInHexa	String	Color code of the order status in hexadecimal format

200: OK Message Received Successfully

400: Bad Request Text message or code error

Descriptive Response

401: Unauthorized Invalid token

{
  "orderID": "string",
  "orderStatusWithColor": {
    "statusName": "string",
    "statusColorInHexa": "string"
  }
}

Acknowledge Order Dispatch

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

Acknowledge the order dispatching in a working set.

Headers

Name	Type	Description
authentication *	String	Bearer token acquired after authentication

Request Body

Name	Type	Description
WorkingsetID*	String	Unique identifier for the working set
TourID*	String	Unique identifier for the tour
StopID*	String	Unique identifier for the stop
OrderID*	String	Unique identifier for the order
OrderTaskID*	String	Unique identifier for the order task

200: OK Message Received Successfully

400: Bad Request Text message or code error

Descriptive Response

{
  "workingsetId": "string",
  "tourId": "string",
  "stopId": "string",
  "orderID": "string",
  "orderTaskID": "string"
}

Acknowledge Order Un-Dispatch

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

Un-dispatching order acknowledgement in a working set

Headers

Name	Type	Description
authentication *	String	Bearer token acquired after authentication

Request Body

Name	Type	Description
OrderID*	String	Unique identifier for the order
StopID*	String	Unique identifier for the stop
TourID*	String	Unique identifier for the tour
WorkingsetID*	String	Unique identifier for the working set
OrderTaskID*	String	Unique identifier for the order task

200: OK Message Received Successfully

400: Bad Request Text message or code error

Descriptive Response

401: Unauthorized Invalid token

{
  "workingsetId": "string",
  "tourId": "string",
  "stopId": "string",
  "orderID": "string",
  "orderTaskID": "string"
}

Update Order Planning Status

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

Update the user with the planning status of the order.

Headers

Name	Type	Description
authentication *	String	Bearer token acquired after authentication

Request Body

Name	Type	Description
OrderID*	String	Unique identifier for the order
PlanningStatusEnum*	Number	Planning status of order Values (New, Planned, Dispatched, OnProcess, Executed, Cancelled)

200: OK Message Received Successfully

400: Bad Request Text message or code error

Descriptive Response

401: Unauthorized Invalid token

{
  "orderID": "string",
  "planningStatusEnum": 0
}

Update Trailer For Order Task

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

Update the user with order task of the trailer

Headers

Name	Type	Description
authentication *	String	Bearer token acquired after authentication

Request Body

Name	Type	Description
WorkingsetId*	String	Identifier for the work set
TourId*	String	Identifier for the tour
StopId*	String	Identifier for the stop
OrderID*	String	Identifier for the order
OrderTaskID*	String	Identifier for the task
Id*	String	Identifier for the trail
PlateNumber*	String	Plate number of the trailer
Code*	String	Specific code for the trailer
TrailerType*	Object	Details about the trailer type
Capacity*	Object	Weight and volume capacity of the trailer
TrailerCharacteristics	Object	Characteristics of the trailer

200: OK Message Received Successfully

400: Bad Request Text message or code error

Descriptive Response

401: Unauthorized Invalid token

{
  "workingsetId": "string",
  "tourId": "string",
  "stopId": "string",
  "orderID": "string",
  "orderTaskID": "string",
  "orderTaskTrailer": {
    "id": "string",
    "plateNumber": "string",
    "code": "string",
    "trailerType": {
      "id": "string",
      "name": "string",
      "code": "string",
      "capacity": {
        "weight": 0,
        "volume": 0
      },
      "dimension": {
        "width": 0,
        "length": 0,
        "height": 0
      },
      "pallets": [
        {
          "palletType": "string",
          "count": 0,
          "stackable": true
        }
      ]
    },
    "trailerCharacteristics": {
      "hasCooler": true
    },
    "availability": {
      "timeWindows": [
        {
          "date": "2023-12-07T12:18:09.974Z",
          "timeSlots": [
            {
              "startTime": 0,
              "endTime": 0
            }
          ]
        }
      ]
    }
  }