Locus Vehicle API

openapi: 3.2.0
info:
  title: Locus HomebaseMaster Vehicle API
  description: Manage your deliveries with the Locus API
  version: 1.0.0
servers:
- url: https://oms.locus-api.com/v1
tags:
- name: Vehicle
paths:
  /client/{clientId}/vehicle/{vehicleId}:
    parameters:
    - $ref: '#/components/parameters/ClientIdParam'
    - $ref: '#/components/parameters/VehicleIdParam'
    get:
      summary: Get a vehicle by id
      operationId: getVehicle
      parameters:
      - name: include
        in: query
        description: Comma separated list of extra fields that should be returned. Supported values are SHIFTS, TRANSPORTER, RIDER, VEHICLE_MODEL.
        required: false
        schema:
          type: string
      tags:
      - Vehicle
      responses:
        '200':
          description: Desired vehicle
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Vehicle'
      security:
      - locusauth: []
    put:
      summary: Create a new vehicle
      operationId: createVehicle
      parameters:
      - $ref: '#/components/parameters/OverwriteParam'
      tags:
      - Vehicle
      responses:
        '200':
          description: Created vehicle
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Vehicle'
      security:
      - locusauth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVehicleRequest'
        description: Vehicle create request
        required: true
  /client/{clientId}/vehicle/{vehicleId}/disable:
    parameters:
    - $ref: '#/components/parameters/ClientIdParam'
    - $ref: '#/components/parameters/VehicleIdParam'
    post:
      description: Disable a specific vehicle
      operationId: disableVehicle
      tags:
      - Vehicle
      responses:
        '200':
          description: Updated vehicle
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Vehicle'
      security:
      - locusauth: []
components:
  schemas:
    LDate:
      type: object
    Transporter:
      $ref: https://swagger.locus-api.com/common-entities.yaml#/definitions/Transporter
    VehicleModel:
      $ref: https://swagger.locus-api.com/common-entities.yaml#/definitions/VehicleModel
    Shift:
      $ref: https://swagger.locus-api.com/common-entities.yaml#/definitions/Shift
    TransporterId:
      type: object
    CreateVehicleRequest:
      description: Wrapper for vehicle create request
      allOf:
      - $ref: '#/components/schemas/Vehicle'
      - type: object
    FleetType:
      $ref: https://swagger.locus-api.com/common-entities.yaml#/definitions/FleetType
    EntityDefinition:
      type: object
    Rider:
      $ref: https://swagger.locus-api.com/common-entities.yaml#/definitions/Rider
    Vehicle:
      description: Details of a vehicle entity
      allOf:
      - $ref: '#/components/schemas/EntityDefinition'
      - type: object
        required:
        - id
        - vehicleModelId
        properties:
          vehicleModelId:
            $ref: '#/components/schemas/VehicleModelId'
          vehicleModel:
            description: Read-only field. Refer to VehicleModel Apis to update
            $ref: '#/components/schemas/VehicleModel'
          transporterId:
            $ref: '#/components/schemas/TransporterId'
          transporter:
            description: Read-only field. Refer to Transporter Apis to update
            $ref: '#/components/schemas/Transporter'
          riderId:
            $ref: '#/components/schemas/RiderId'
          rider:
            description: Read-only field. Refer to Rider Apis to update
            $ref: '#/components/schemas/Rider'
          vehicleCostModel:
            $ref: '#/components/schemas/VehicleCostModel'
          teams:
            description: List of teams who use the vehicle
            type: array
            items:
              $ref: '#/components/schemas/TeamId'
          skills:
            description: List of skill ids vehicle possesses
            type: array
            items:
              $ref: '#/components/schemas/SkillId'
          shiftIds:
            description: List of working shifts
            type: array
            items:
              $ref: '#/components/schemas/ShiftId'
          shifts:
            description: Read-only field. Refer to Shift Apis to update
            type: array
            items:
              $ref: '#/components/schemas/Shift'
          resourceLimits:
            description: Limits on the resources with the vehicle
            type: array
            items:
              $ref: '#/components/schemas/ResourceLimit'
          manufacturingDate:
            description: Date of manufacture of the vehicle
            $ref: '#/components/schemas/LDate'
          isColdChain:
            type: boolean
          unladenWeight:
            description: Weight of Unloaded Vehicle in KGs
            type: integer
            format: int32
          fuelType:
            type: string
            enum:
            - PETROL
            - DIESEL
            - CNG
            - ELECTRIC
          mileage:
            description: Odometer mileage for the vehicle
            type: number
            format: double
          userCount:
            description: Number of FEs available with this vehicle. This determines the no. of deliveries vehicle can do in parallel, at the same location.
            type: integer
            format: int32
            default: 1
          documents:
            description: Official documents registered with the transporter
            type: array
            items:
              $ref: '#/components/schemas/Document'
          baseLocations:
            $ref: '#/components/schemas/BaseLocations'
          fleetType:
            $ref: '#/components/schemas/FleetType'
          registrationNumber:
            description: Registered identifier of the vehicle
            type: string
          isActive:
            description: Status Field for transporter
            type: boolean
            default: true
    ShiftId:
      $ref: https://swagger.locus-api.com/common-entities.yaml#/definitions/ShiftId
    RiderId:
      type: object
    Document:
      $ref: https://swagger.locus-api.com/common-entities.yaml#/definitions/Document
    SkillId:
      $ref: https://swagger.locus-api.com/common-entities.yaml#/definitions/SkillId
    TeamId:
      type: object
    VehicleModelId:
      type: object
    ResourceLimit:
      $ref: https://swagger.locus-api.com/common-entities.yaml#/definitions/ResourceLimit
    VehicleCostModel:
      $ref: https://swagger.locus-api.com/common-entities.yaml#/definitions/VehicleCostModel
    BaseLocations:
      $ref: https://swagger.locus-api.com/common-entities.yaml#/definitions/BaseLocations
  parameters:
    VehicleIdParam:
      name: vehicleId
      in: path
      description: Id of the vehicle
      required: true
      schema:
        type: string
    ClientIdParam:
      name: clientId
      in: path
      description: Id of the client
      required: true
      schema:
        type: string
    OverwriteParam:
      name: overwrite
      in: query
      description: Boolean flag if true, will overwrite the existing entity
      required: false
      schema:
        type: boolean
  securitySchemes:
    locusauth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization