Skip to main content

SRT

Detailed description of API:

Version & Updates

VersionRevision DateRevision History
1.016th April 2026New Release

Overview

SRT API is intended to expose details related to a SRT code, its description, timesheet, model, product line, region etc. This enables the DMS providers to have information on the rates, work units at the time of creating a flat rate work order repair/quote. A DMS provider can query the SRT data on a real time basis by providing the Vehicle Identification Number (VIN) or the Model Number. The API provides information that are available in Smart basket application today for the given equipment or model after filtering information that might not be useful for the dealers. All the SRT and its relevant data are extracted from the Smart Basket system of CNHi. Please refer to diagram below for information on the data flow of this interface.

1 working unit = 6 minutes

image.png

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.

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. New development for this interface are always recommended to the build to REST API for greater simplicity.

Connection Details

For SRT there's 3 API types offered:

  • Parts APIs
  • VIN APIs
  • VIN & Parts APIs

CNHi provides two environments for its APIs:

  • Cert/UAT
  • Production

The environments are identical, requiring only that you change out your connection string and authorization endpoint to connect to any of the environments.

Parts API

Endpoints

EnvironmentAPI URLAPIRequest Type
UAT / Staginghttps://{base_url}/latamexternal/srtpartsservice/part/{partnumber}RESTGET
Productionhttps://{base_url}/latamexternal/srtpartsservice/part/{partnumber}RESTGET

Request Parameters

NameParams TypeTypeIs RequiredDefault ValueComments
partNumberTemplateStringTrue-Part identification number
LangQueryStringFalseenLanguage – default value will be English
responseFormatQueryStringFalsejsonResponse Format [xml or json] – default will be json

Response Description

NameTypeDescription
pnCodeStringPart number code
pnDescStringPart number description
operationGp.group.GpdGrStringGroup ID
operationGp.group.descStringGroup description
operationGp.group.grCodeStringGroup Code
operationGp.group.subGroup.sGrStringSub group ID
operationGp.group.subGroup.descStringSub group description
operationGp.group.subGroup.sGrCodeStringSub group code
operationGp.group.subGroup.defect.sSGrStringSub sub group code
operationGp.group.subGroup.defect.descStringSub sub group description
operationGp.group.subGroup.defect.sSGrCodeStringSub sub group code
operationGp.group.subGroup.defect.operation.opIDStringOperation ID
operationGp.group.subGroup.defect.operation.descStringOperation description
operationGp.group.subGroup.defect.operation.codeStringOperation code
operationGp.group.subGroup.defect.operation.rankStringRank

Sample Parts API Response

Download Sample Parts API Reponse

VIN APIs

VIN APIs can be summarized in 4 parts: Group, Subgroup, Subsubgroup and Operation. Because of that, CNHi offers 4 APIs:

  • Group API
  • Subgroup API
  • Sub Subgroup API
  • Operation API

Group API

Endpoints

EnvironmentAPI URLAPIRequest Type
UAT / Staginghttps://{base_url}/latamexternal/srtvinservice/vin/{vinnumber}RESTGET
Productionhttps://{base_url}/latamexternal/srtvinsservice/vin/{vinnumber}RESTGET

Request Parameters

NameParams TypeTypeIs RequiredDefault ValueComments
vinNumberTemplateStringTrue-Serial/Vehicle Identification number of the equipment
LangQueryStringFalseenLanguage – default value will be English
responseFormatQueryStringFalsejsonResponse Format [xml or json] – default will be JSON

Response Description

NameTypeDescription
response.product.BrandStringBrand Name
response.product.brandIdStringBrand ID
response.product.TypeStringType
response.product.TypeidStringType ID
response.product.ProductnameStringProductname
response.product.ProductidStringProductid
response.product.SeriesStringSeries
response.product.seriesIDStringseriesID
response.product.ModelStringModel
response.product.DescStringDesc
response.product.technicalTypeCodeStringTechnicalTypeCode
response.product.serialnumbercodeStringSerial Number or Vehicle Number
response.product.group.dGrStringGroup ID
response.product.group.descStringGroup Description
response.product.group.grCodeStringGroup Code

Sample Group API Response

Download Sample Group API Reponse

Subgroup API

Endpoints

EnvironmentAPI URLAPIRequest Type
UAT / Staginghttps://{base_url}/latamexternal/srtvinservice/vin/{vinnumber}/{groupId}RESTGET
Productionhttps://{base_url}/latamexternal/srtvinservice/vin/{vinnumber}/{groupId}RESTGET

Request Parameters

NameParams TypeTypeIs RequiredDefault ValueComments
vinNumberTemplateStringTrue-Serial/Vehicle Identification number of the equipment
groupIdTemplateIntegerTrue-Group ID
LangQueryStringFalseenLanguage – default value will be English
responseFormatQueryStringFalsejsonResponse Format [xml or Json] – default will be JSON

Response Description

NameTypeDescription
response.subGroup.sGrStringGroup ID
response.subGroup.descStringGroup Description
response.subGroup.sgrCodeStringSubGroup Code

Sample Subgroup API Response

Download Sample Subgroup API Response

Subsubgroup API

Endpoints

EnvironmentAPI URLAPIRequest Type
UAT / Staginghttps://{base_url}/latamexternal/srtvinservice/vin/{vinnumber}/{groupId}/{subGroupId}RESTGET
Productionhttps://{base_url}/latamexternal/srtvinservice/vin/{vinnumber}/{groupId}/{subGroupId}RESTGET

Request Parameters

NameParams TypeTypeIs RequiredDefault ValueComments
vinNumberTemplateStringTrue-Serial/Vehicle Identification number of the equipment
groupIdTemplateIntegerTrue-Group ID
subgroupIdTemplateIntegerTrue-Sub Group ID
LangQueryStringFalseenLanguage – default value will be English
responseFormatQueryStringFalsejsonResponse Format [xml or Json] – default will be JSON

Response Description

NameTypeDescription
response.defect.SSGrStringSub Subgroup ID
response.defect.DescStringSub Subgroup Description
response.defect.SSGrCodeStringSub Subgroup Code

Sample API Response

Download Sample Subsubgroup API Response

Operations API

Endpoints

EnvironmentAPI URLAPIRequest Type
UAT / Staginghttps://{base_url}/latamexternal/srtvinservice/vin/{vinnumber}/{groupId}/{subGroupId}/{SubSubGroupId}RESTGET
Productionhttps://{base_url}/latamexternal/srtvinservice/vin/{vinnumber}/{groupId}/{subGroupId}/{SubSubGroupId}RESTGET

Request Parameters

NameParams TypeTypeIs RequiredDefault ValueComments
vinNumberTemplateStringTrue-Serial/Vehicle Identification number of the equipment
groupIdTemplateIntegerTrue-Group Id
subgroupIdTemplateIntegerTrue-Sub Group Id
subsubgroupIdTemplateIntegerTrue-Subsub Group Id
LangQueryStringFalseenLanguage – default value will be English
responseFormatQueryStringFalsejsonResponse Format [xml or Json] – default will be Json

Response Description

NameTypeDescription
response.operation.opIDStringOperation ID
response.operation.descStringOperation Description
response.operation.codeStringOperation Code
response.operation.typeStringType
response.operation.addDescStringAdd Desc
response.operation.timeStringTime taken for the operation
response.operation.additionalInfo.rollupList.rolUp_idStringRoll Up ID
response.operation.additionalInfo.rollupList.rollup_orderStringRoll Up Order
response.operation.additionalInfo.rollupList.rolUp_descStringRoll Up Description
response.operation.additionalInfo.Included.opIDStringIncluded Operation ID
response.operation.additionalInfo.Included.descStringIncluded Operation Description
response.operation.additionalInfo.Excluded.opIDStringExcluded Operation ID
response.operation.additionalInfo.Excluded.descStringExcluded Operation Description

Sample API Response

Download Sample Operations API Response

VIN & Parts API

Endpoints

EnvironmentAPI URLAPIRequest Type
UAT / Staginghttps://{base_url}/latamexternal/srtvinandpartsservice/vin/{vinNumber}/part/{partNumber}RESTGET
Productionhttps://{base_url}/latamexternal/srtvinandpartsservice/vin/{vinNumber}/part/{partNumber}RESTGET

Request Parameters

NameParameter TypeTypeIs RequiredDefault ValueComments
VIN NumberTemplateStringTrue-Serial/Vehicle Identification number of the equipment
partNumberTemplateStringTrue-Parts Identification number
LangQueryStringFalseenLanguage – default value will be English
responseFormatQueryStringFalsejsonResponse Format [xml or json] – default will be json

Response Description

NameTypeDescription
response.product.brandStringBrand Name
response.product.brandidStringBrand ID
response.product.typeStringProduct Type
response.product.typeidStringProduct Type ID
response.product.productNameStringProduct Name
response.product.productIDStringProduct ID
response.product.seriesStringProduct Series
response.product.seriesIDStringProduct Series
response.product.modelStringProduct Model
response.product.descStringProduct Description
response.product.technicalTypeCodeStringIt's TT Code for VIN
response.product.SerialnumbercodeStringSerial Number or Vehicle Number
response.product.pnCodeStringPart number code
response.product.timesheet.timesheetcodeStringTimesheet Code
response.product.timesheet.columncodeStringTimesheet Column Code
response.product.timesheet.columndescriptionStringTimesheet Column Description
response.product.timesheet.Opgroup.dGrstringGroup ID
response.product.timesheet.Opgroup.descStringGroup Description
response.product.timesheet.Opgroup.grCodeStringGroup Code
response.product.timesheet.Opgroup.subGroup.sGrStringSub group ID
response.product.timesheet.Opgroup.subGroup.descStringSub Group description
response.product.timesheet.Opgroup.subGroup.sGrCodeStringSub Group code
response.product.timesheet.Opgroup.subGroup.defect.sSGrStringSub Sub Group code
response.product.timesheet.Opgroup.subGroup.defect.descStringSub Sub Group description
response.product.timesheet.Opgroup.subGroup.defect.sSGrCodeStringSub Sub Group code
response.product.timesheet.Opgroup.subGroup.defect.operation.opIDstringOperation ID
response.product.timesheet.Opgroup.subGroup.defect.operation.descstringOperation description
response.product.timesheet.Opgroup.subGroup.defect.operation.codestringOperation Code
response.product.timesheet.Opgroup.subGroup.defect.operation.timestringTime taken for the operation
response.product.timesheet.Opgroup.subGroup.defect.operation.rankstringThis is the rank for Part Number and Operation ID combination
response.product.timesheet.Opgroup.subGroup.defect.operation.addDescstringOperation Additional Description
response.product.timesheet.Opgroup.subGroup.defect.operation.typeStringOperation Type
response.product.timesheet.Opgroup.subGroup.defect.operation.additionalInfo.rollupList.rolUp_idstringOperation Additional Rollup ID
response.product.timesheet.Opgroup.subGroup.defect.operation.additionalInfo.rollupList.rollup_orderstringOperation Additional Rollup Order
response.product.timesheet.Opgroup.subGroup.defect.operation.additionalInfo.rollupList.rolUp_descStringRoll Up Description
response.product.timesheet.Opgroup.subGroup.defect.operation.additionalInfo.Included.opIDStringIncluded Operation ID
response.product.timesheet.Opgroup.subGroup.defect.operation.additionalInfo.Included.descStringIncluded Operation Description
response.product.timesheet.Opgroup.subGroup.defect.operation.additionalInfo.Excluded.opIDStringExcluded Operation ID
response.product.timesheet.Opgroup.subGroup.defect.operation.additionalInfo.Excluded.descStringExcluded Operation Description

Sample API Response

Download Sample VIN & Parts API Response

Response Codes

TitleReasonCode
REST SRT success responseSuccess200
REST SRT failure responseBad Request: Request query params are invalid400
REST SRT failure responsePart Number Invalid200
REST SRT failure responseNo records found / Resource Not Found404
REST SRT failure responseInternal Server Error500