Fleetview

Detailed description of API:

Version & Updates

View Previous Revisions

Version	Revision Date	Revision History
1.0	10th April 2022	New Release
1.1	24th May 2023	Updated the technical design
1.2	29th June 2023	Added My Fleet by VIN API Details
1.3	4th August 2023	Added My Fleet Grouped API Details
1.4	6th December 2023	Updated 5.2.1, 5.2.2, 5.2.3 Sections by adding operatorAlertSection – CustomerFeedback field
1.5	11th April 2024	Project title change
1.5	18th August 2024	Updated case sensivity, removed unneeded reqeust body on by VIN API
1.6	30th October 2025	Updated the Grouped API by removing the unused operatorAlertSection parameter, changing the data types of latitude and longitude to float, and updating pipCode and pipType data types to String.
1.7	20th January 2026	Updated the Grouped API to accept either Dealer User Id or GDD Code

Version	Revision Date	Revision History
1.7	20th January 2026	Updated the Grouped API to accept either Dealer User Id or GDD Code

Overiew

Fleet View API is structured to capture the information about the different attributes of vehicles for the requested fleet. DMS will transfer the details of all the fleet to CNHi via DEP API, as and when it is ready to be interfaced in a REST format by invoking the API set.

Fleet View within eTim

MyFleet Overview

MyFleet by VIN (Alerts)

Pre-requisites

Pre-requisites

• Dealer must use their Dealer Portal credentials to authorize API call.
• Each DMS provider will have a subscription_key assigned by CNHi team, please reach out to dlnadmssupport@cnh.com for assistance
• Each Subscription key is unique to DMS and the environment it belongs to
• Based on the payload (XML/JSON), user to pass the content-type in the header

Authentication

Authentication

• DMS will pass Basic auth in HTTP header with username/password
• Each DMS provider will have a subscription_key assigned by CNHi team, please reach out to dlnadmssupport@cnh.com for assistance
• The UserID and Password will be set up in the Dealer Portal by the Dealer uniquely for DMS access to interfaces
• DEP API will require subscription_key in HTTP header to identify client

API Format

• REST

The DEP takes care of the format transformations (as needed) to process the request and provide a response to the DMS system. REST format is always suggested for greater simplicity.

Connection Details

For the Fleetview interface, CNHi offers two APIs depedning on the use-case:

• MyFleet Grouped

• MyFleet by VIN

MyFleet Grouped API

NAFTA Endpoints

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/services/fleet/myfleetgrouped	REST	POST
Production	https://{base_url}/external/services/fleet/myfleetgrouped	REST	POST

Request Description

Note: All Request Query Parameters are case sensitive.

Name	Params Type	Type	Is Required	Default Value
technicalAlertSection	Query	Boolean	Yes	false
maintenanaceAlertSection	Query	Boolean	Yes	false
pipSection	Query	Boolean	Yes	false

Request Body - JSON

{
  "options": {
    "user": "****",
    "userType": 0 or 1,
    "brand": "*",
    "country": "***",
    "vehicleProximity": true
  }
}

Request Description

Name	Description	Type	Is Required	Sample Data
user	Dealer UserId / GDD Code	String	Yes	Dealer UserId / GDD Code
userType	User Type	Int	Yes	0, Represents GDD Code 1, Represents Dealer UserId
brand	Brand	Char	Yes	A - Case IH
				B - NEW HOLLAND
				C - STEYR
				D - Flexi-Coil
				E - CASE CONSTRUCTION
				F - NEW HOLLAND CONSTRUCTION
				G - O & K
				H - KOBELCO
				J - FIATALLIS
				K - KOBELCO OLD
				L - LINK-BELT
				M - SNH
				N - MILLER
				O - AG-BAG
				R - RAVEN
				S - KONGSKILDE
country	Country Code	String	No	NA - North America
				EU - Europe
vehicleProximity	Vehicle Proximity	Boolean	Yes	true/false

Response Description

Name	Complex Name 1	Complex Name 2	Complex Name 3	Data Type
data				JSON Array
	pin			String
	pinAdditional			String
	latitude			Float
	longitude			Float
	model			String
	customer			String
	iceCode			String
	lastLocationDate			Date Time
	localLastLocationDate			Date Time
	duty			String
	eWarrantyName			String
	connectedStatus			String
	engineHours			Float
	machineStatus			String
	location			JSON Array (Of String)
	faultSection			JSON Object
		count		Int
	maintenanceAlertSection			JSON Object
		countLow		Int
		countMedium		Int
		countHigh		Int
	kaSection			JSON Object
		count		Int
	pipSection			JSON Object
		Count		Int
		pipList		JSON Array (of JSON Object)
			count	Int
			pipCode	String
			pipType	String
	initialQualitySection			JSON Object
		count		Int
	technicalAlertSection			JSON Object
		countLow		Int
		countMedium		Int
		countHigh		Int
status				JSON Object
	code			Int
	message			String

MyFleet Grouped Sample Response

Download MyFleet Group API Sample Response

MyFleet by VIN API

NAFTA Endpoints

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/services/fleet/myfleetbyvin/{VIN}	REST	POST
Production	https://{base_url}/external/services/fleet/myfleetbyvin/{VIN}	REST	POST

Request Description

Note: All Request Query Parameters are case sensitive.

Name	Params Type	Type	Is Required	Default Value
VIN	Template	String	Yes	NA
technicalAlertSection	Query	Boolean	Yes	true
operatorAlertSection	Query	Boolean	No	true

Response Description

Name	Complex Name 1	Complex Name 2	Complex Name 3	Complex Name 4	Data Type
Data					JSON Object
	pin				String
	pinAdditional				String
	model				String
	customer				String
	eWarrantyName				String
	connectedStatus				String
	engineHours				Float
	technicalAlertSection				JSON Array (of JSON Object)
		alertID			Int
		priority			Int
		dealerCode			String
		isSimple			Boolean
		category			String
		myFleetDealerName			String
		warrantySaving			String
		uptimeSaving			String
		subtype			String
	operatorAlertSection				JSONArray(of JSON Object)
		creationDate			Datetime
		closureDate			Datetime
		alertStatus			String
		title			String
		priority			Int
		customerFeedback			Boolean
	location				JSON Array (of String)
status					JSONObject
	code				Int
	message				String

MyFleet by VIN Sample Response

Download MyFleet by VIN API Sample Response

Response Codes

Status Code	Message
200	Ok
400	Bad Request
500	Internal Server Error
401	Unauthorized
403	Forbidden