Skip to main content

Vehicle Types

Vehicle Type​

This object describes a vehicle type. See VehicleType definition under Schemas/VehicleType in MPT OpenAPI Documentation.

Example of Vehicle Type
{
	"id": "17000",
	"weightCapacity": 20000,
	"volumeCapacity": 17000,
	"size": 99,
	"unloadedWeight": 9480,
	"availableCharacteristics": [],
	"compartConfiguration": {
		"id": "17000",
		"accessMode": "FROM_THE_REAR_OF_THE_VEHICLE",
		"compartements": [
			{
				"maximalSize": 5000,
				"minimalSize": 5000,
				"incrementSize": 0,
				"compartFillRule": "NONE"
			},
			{
				"maximalSize": 10000,
				"minimalSize": 10000,
				"incrementSize": 0,
				"compartFillRule": "NONE"
			},
			{
				"maximalSize": 2000,
				"minimalSize": 2000,
				"incrementSize": 0,
				"compartFillRule": "NONE"
			}
		],
		"maxCapacity": 17000
	},
	"othersCompartConfiguration": [],
	"maxSitesPerRoute": 99,
	"acceptCollectionsOnlyAfterDeliveries": true,
	"speedVariations": [
		{
			"minimalLoadPercentage": 90,
			"maximalLoadPercentage": 100,
			"percentVariation": 95
		}
	],
	"loadingFlows": [],
	"unloadingFlows": [
		{
			"flow": 1000,
			"idProductFamily": "RABBIT FOOD",
			"idCharacteristic": "WIND TUNNEL"
		}
	]
}
Warning

A vehicle type id must be present and unique in the vehicleTypes list in the entities message.

Info

compartConfiguration and othersCompartConfiguration properties are lists of compartments configuration

Info

speedVariations property is a list of speed adjustments

Info

loadingFlows and unloadingFlows properties are lists of vehicle flow

Compartments Configuration​

This object describes a compartment configuration.
See CompartmentsConfiguration definition under Schemas/CompartmentsConfiguration in MCDI OpenAPI Documentation.

Example of Compartments Configuration
{
	"id": "17000",
	"accessMode": "FROM_THE_REAR_OF_THE_VEHICLE",
	"compartements": [
		{
			"maximalSize": 5000,
			"minimalSize": 5000,
			"incrementSize": 0,
			"compartFillRule": "NONE"
		},
		{
			"maximalSize": 10000,
			"minimalSize": 10000,
			"incrementSize": 0,
			"compartFillRule": "NONE"
		},
		{
			"maximalSize": 2000,
			"minimalSize": 2000,
			"incrementSize": 0,
			"compartFillRule": "NONE"
		}
	],
	"maxCapacity": 17000
}
Info

compartments property is a list of Compartment

Compartment​

This object describes a compartment.
See Compartment definition under Schemas/Compartment in MCDI OpenAPI Documentation.

Example of Compartment
{
	"maximalSize": 2000,
	"minimalSize": 2000,
	"incrementSize": 0,
	"compartFillRule": "NONE",
	"restrictionAllowedPackagings": []
}

Speed Adjustments​

This object describes an adjustment of speeds according to the vehicle load.
See VariationPercentDependingLoad definition under Schemas/VariationPercentDependingLoad in MCDI OpenAPI Documentation.

Example of Speed Adjustments
{
	"minimalLoadPercentage": 90,
	"maximalLoadPercentage": 100,
	"percentVariation": 95
}

Vehicle Flow​

This object describes a flow depending on a family product or a characteristic.
See VehicleFlow definition under Schemas/VehicleFlow in MCDI OpenAPI Documentation.

Example of Vehicle Flow depending on a family product
{
	"flow": 1000,
	"idProductFamily": "RABBIT FOOD",
}
Example of Vehicle Flow depending on a characteristic
{
	"flow": 1250,
	"idCharacteristic": "WIND TUNNEL"
}