Vignetim

Категорії транспорту (Vehicle Categories)

Отримуйте категорії та типи транспортних засобів, що використовуються при придбанні віньєток. Кожен продукт віньєтки пов'язаний з конкретною категорією транспортного засобу.

Список категорій транспорту

GET /products/vehicle-categories

Параметри запиту

НазваТипОбов'язковийОпис
includeVehiclesbooleanНіВключити деталі типів транспортних засобів у відповідь (за замовчуванням: false)
languagestringНіКод мови для локалізованих назв (наприклад, en, de, tr)

Відповідь

{
	"data": [
		{
			"id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
			"name": "Car (up to 3.5t)",
			"description": "Passenger vehicles and motorhomes up to 3.5 tonnes",
			"typeId": 1,
			"vehicles": [
				{
					"id": "a1b2c3d4-0000-1111-2222-333344445555",
					"name": "Sedan",
					"icon": "car-sedan"
				},
				{
					"id": "a1b2c3d4-0000-1111-2222-333344446666",
					"name": "SUV",
					"icon": "car-suv"
				}
			]
		},
		{
			"id": "f2e3d4c5-b6a7-8901-bcde-f12345678901",
			"name": "Motorcycle",
			"description": "Two-wheeled motor vehicles",
			"typeId": 2,
			"vehicles": []
		},
		{
			"id": "f3e4d5c6-b7a8-9012-cdef-123456789012",
			"name": "Trailer (up to 3.5t)",
			"description": "Trailers with a maximum weight of 3.5 tonnes",
			"typeId": 3,
			"vehicles": []
		}
	]
}

Масив vehicles заповнюється лише коли includeVehicles=true.

Отримати категорії транспорту за типом

GET /products/vehicle-categories/by-type/:typeId

Параметри шляху

НазваТипОбов'язковийОпис
typeIdintegerТакID типу транспортного засобу

Відповідь

Повертає категорії транспортних засобів, відфільтровані за зазначеним ID типу, з тією ж структурою відповіді, що й ендпоінт списку.

{
	"data": [
		{
			"id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
			"name": "Car (up to 3.5t)",
			"description": "Passenger vehicles and motorhomes up to 3.5 tonnes",
			"typeId": 1,
			"vehicles": []
		}
	]
}