Website logo
Docs
API Reference
Postman Collection
Release Notes
Navigate through spaces
⌘K
Overview
API Reference Overview
How to use the API 'Try It' feature
Authentication And Authorization (AAA) Service
Role Management
User Management
Authentication
Connection Management
Group Management
Participant Service
Tenant
Participant Type
Participant Type - Custom Code Config
Participant Type - Attributes Config
Participant Type - State Machine
Participant
Templates
Participant State
Participant - Batch Processing
Container Service
Container Type
Container Type - Custom Code Config
Container Type - Attributes Config
Container Type - State Machine Config
Container
Container State
Container Group
Container - Batch Processing
Dispatch Service
Job Type
Job Workflow
Job
Job - Config
Dispatch Type
Dispatch
Mobile APIs
Dispatch - Config
Ledger
Ledger in batch
Custom Code Config
Workflow Service
Execution Task
Changelog
Execution Macro
Execution Workflow
Execution Workflow Instance
Health Check
SDS Service
App
Vault
Data
File Management Service
Folders
Files
State Machine Service
State Machine Config
Entity
Events
Reasons
Instance State
Movement Tracking Service
Trace Data
Missing Sequence Numbers
Snapped Distance
IOT Device
Geofence
MTS Subscription
Entity Service
Entity Type
State Machine Config
Entity Instance
Entity Type - Custom Code Config
Entity Instance State
Templates
Entity - Batch Processing
Notification Service
App Notification
Filter
Event
Change Log
Location Service
Location
Country
State
City
Search
Order Service
Order Config
Order State Machine Configuration
Order State Machine Transition
Work Order State Machine Configuration
Work Order State Transition
Order
Batch Order
Custom Code Config
Plugin Callback
External Reference APIs
Work Order Config
Work Order Status
Plugins
PluginWorkflow
Address Service
Address Config
Address
User FPA
Users
Facility FPA
Facilities
Vehicle FPA
Vehicles
LogisticsOrder API
Order
Batch Order
AAA - External Authorizer
Authorization
Orchestrator
Plugins
PluginWorkflow
Rules
Get Entity Status
DLQ Service
Query & Listing
Default Plugins
Job Manager
Work Order Manager
Container Manager
Workflow Manager
Cancellation Manager
Scheduler Service
Scheduler Service
Docs powered by Archbee
Vehicle FPA
Vehicles

Create a Vehicle.

1min
POST
HEADER PARAMETERS
X-Solutions-Callback-Secret
string
base64 encoded hmac secret
BODY PARAMETERS
body
CreateVehicleRequest
Create Vehicle Request
referenceNumber
string
*
ownerName
string
vehicleCategory
string
vehicleSubCategory
string
modelName
string
*
vehicleMode
string<Land | Air | Sea>
Mode of the vehicle
vehicleStructure
string
Structure of the vehicle
fuelType
string<Petrol | Diesel | CNG | EV | NA | Gasoline>
fuel types allowed for the vehicle
modelYear
number
year of the vehicle model
registrationYear
number
the registration year of the vehicle
reportingCenter
string
reporting facility of the vehicle
operator
string
operator user of the vehicle
numberOfJobs
number
number of jobs a vehicle can handle
totalDistance
number
total distance a vehicle can cover
totalTravelTime
number
total travel time of a vehicle
totalLateTime
number
total late time of a vehicle
payload
number
Max weight allowed in a vehicle
payloadVolumetric
number
max payload in litres for a vehicle
teams
string[]
Example:
team ids for which a vehicle belongs
vehicleType
string
The category of vehicle
containerDimensions
string
The dimensions of the container
costPerMonth
number
Fixed cost per month
numberOfDays
number
Operating Days
ratePerHr
number
Extra Rate per Hour
ratePerKm
number
Extra Rate per km
registrationNumber
string
*
the registration number of the vehicle
ownershipType
string<Tenant | Individual | 3P/Leased>
*
type of owner of the vehicle
callback
object
Example: [object Object]
RESPONSES
200
Default Error Response
CreatedResponse
error
Error
Error Information
request
Request
data
Data
default
Default Error Response
DefaultResponse
error
Error
Error Information
request
Request
data
object
Example: [object Object]




Updated 03 Aug 2023
Did this page help you?
PREVIOUS
Update state of Facility by id or external ref
NEXT
Get a list of Vehicles.
Docs powered by Archbee