---
updatedAt: 2025-12-18T11:46:29.000Z
agentTools:
  projectIndex: https://route-stripe.readme.io/llms.txt
---

# Get Vehicle

Get Vehicle. One of next options:
* by `id`
* by `external_id`
* by `plate`


# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "RouteStripe API",
    "version": "1.0.0",
    "description": "Unified API specification for managing routing, plans, visits, vehicles, warehouses, members, attachments, and companies in a logistics system.\nSchemas, parameters, request bodies, and responses are consolidated to eliminate duplication.\n"
  },
  "servers": [
    {
      "url": "https://api.routestripe.com",
      "description": "Production"
    },
    {
      "url": "https://test-api.routestripe.com",
      "description": "Test"
    },
    {
      "url": "http://routestripe.local:81",
      "description": "Development"
    }
  ],
  "tags": [
    {
      "name": "Vehicles"
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "api-key"
      }
    },
    "parameters": {
      "IdQueryParam": {
        "name": "id",
        "in": "query",
        "schema": {
          "type": "integer"
        },
        "description": "The identifier of the resource."
      },
      "ExternalIdQueryParam": {
        "name": "external_id",
        "in": "query",
        "schema": {
          "type": "integer"
        },
        "description": "The external identifier of the resource."
      }
    },
    "schemas": {
      "ApiResponse": {
        "type": "object",
        "required": [
          "status",
          "data"
        ],
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "success",
              "fail"
            ]
          },
          "data": {
            "type": "object",
            "items": {}
          }
        },
        "additionalProperties": false
      },
      "BaseItem": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "LocationLatType": {
        "type": "number",
        "format": "float",
        "description": "Latitude",
        "example": 50.043529
      },
      "LocationLngType": {
        "type": "number",
        "format": "float",
        "description": "Longitude",
        "example": 30.516586
      },
      "LocationAddressType": {
        "type": "string",
        "description": "Address",
        "example": "Khreschatyk St, 15, Kyiv, Ukraine, 02000",
        "default": ""
      },
      "ItemStatus": {
        "type": "number",
        "enum": [
          1,
          0
        ],
        "description": "1 - active; 0 - inactive",
        "example": 1,
        "default": 1
      },
      "ExternalIdType": {
        "type": "string",
        "description": "External Id for entity.",
        "default": null
      },
      "VehicleBase": {
        "type": "object",
        "required": [
          "plate",
          "company_id"
        ],
        "properties": {
          "external_id": {
            "$ref": "#/components/schemas/ExternalIdType"
          },
          "title": {
            "type": "string",
            "example": "Vehicle 1"
          },
          "company_id": {
            "type": "integer",
            "example": 85
          },
          "capacity": {
            "type": "number",
            "example": 100,
            "description": "Weight in m3"
          },
          "max_load": {
            "type": "number",
            "example": 2000,
            "description": "Weight in kilograms"
          },
          "max_quantity": {
            "type": "number",
            "example": 1000,
            "description": "Visits max, each"
          },
          "max_package_quantity": {
            "type": "number",
            "example": 1000,
            "description": "Packages max, each"
          },
          "warehouse_id": {
            "type": "integer",
            "example": 0
          },
          "driver_id": {
            "type": "integer",
            "example": 0
          },
          "plate": {
            "type": "string",
            "example": "HA332A"
          },
          "status": {
            "$ref": "#/components/schemas/ItemStatus"
          },
          "type": {
            "type": "string",
            "enum": [
              "auto",
              "truck"
            ],
            "example": "auto",
            "default": "auto"
          },
          "width": {
            "type": "number",
            "format": "float",
            "example": 0,
            "description": "Width of vehicle in meters"
          },
          "height": {
            "type": "number",
            "format": "float",
            "example": 0,
            "description": "Height of vehicle in meters"
          },
          "weight": {
            "type": "number",
            "format": "float",
            "example": 0,
            "description": "Weight of vehicle in tons"
          },
          "work_hour_start": {
            "type": "string",
            "example": "08:00"
          },
          "work_hour_end": {
            "type": "string",
            "example": "18:00"
          },
          "max_distance": {
            "type": "number",
            "example": 0,
            "description": "Max distance in kilometers"
          },
          "overtime": {
            "type": "number",
            "example": 0,
            "description": "Overtime in minutes"
          },
          "speed_factor": {
            "type": "number",
            "format": "float",
            "example": 1,
            "description": "Speed factor from 0.5-1.5"
          },
          "break_start": {
            "type": "string",
            "example": "",
            "description": "Break start. Example: 12:00"
          },
          "break_end": {
            "type": "string",
            "example": "",
            "description": "Break End. Example:  13:00"
          },
          "break_duration": {
            "type": "number",
            "example": 0,
            "description": "Break in minutes"
          },
          "park_location_address": {
            "$ref": "#/components/schemas/LocationAddressType"
          },
          "park_location_lat": {
            "$ref": "#/components/schemas/LocationLatType"
          },
          "park_location_lng": {
            "$ref": "#/components/schemas/LocationLngType"
          }
        }
      },
      "Vehicle": {
        "allOf": [
          {
            "$ref": "#/components/schemas/BaseItem"
          },
          {
            "$ref": "#/components/schemas/VehicleBase"
          }
        ]
      }
    },
    "responses": {
      "ItemVehicle": {
        "description": "Vehicle data.",
        "content": {
          "application/json": {
            "schema": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/ApiResponse"
                },
                {
                  "type": "object",
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/Vehicle"
                    }
                  }
                }
              ]
            }
          }
        }
      },
      "NotFound": {
        "description": "Resource not found.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ApiResponse"
            },
            "examples": {
              "notFound": {
                "value": {
                  "data": "Not found",
                  "status": "fail"
                }
              }
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Unauthorized.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ApiResponse"
            },
            "examples": {
              "Unauthorized": {
                "value": {
                  "data": "Invalid API key provided. Please check and try again.",
                  "status": "fail"
                }
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "paths": {
    "/vehicle/item": {
      "get": {
        "tags": [
          "Vehicles"
        ],
        "description": "Get Vehicle. One of next options:\n* by `id`\n* by `external_id`\n* by `plate`\n",
        "parameters": [
          {
            "$ref": "#/components/parameters/IdQueryParam"
          },
          {
            "$ref": "#/components/parameters/ExternalIdQueryParam"
          },
          {
            "name": "plate",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "033FV11",
            "description": "Filter by plate."
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/ItemVehicle"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          }
        }
      }
    }
  }
}
```