DQR Inspections
Detailed description of API:
Version & Updates
View Previous Revisions
| Version | Revision Date | Revision History |
|---|---|---|
| 1.0 | 20th Dec 2024 | New Release |
| 2.0 | 10th Jun 2025 | Moved to bundle 3 APIs |
| 3.0 | 25th Jun 2025 | Updated request body and sample request with new changes |
| Version | Revision Date | Revision History |
|---|---|---|
| 4.0 | 5th Dec 2025 | Added invoiceDate, warrantyDate, and region to the response, provided descriptions for checklistType, checklistStatus, brandIceCode, and region, and updated the sample response structure |
Overview
DQR Inspections API will allow the dealer the opportunity to retrieve the DQR (Delivery Quality Report) checklist summary (id, type, etc.) within the dealer management system. The scope of the first step is to provide the dealer with the list of inspection checklists belonging to the vehicles and a link to jump into eTIM.
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 (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 implemented for greater simplicity.
Connection Details
CNHi provides two environments:
- CERT / UAT
- Production
CNHi will preform a null or empty check for dmsName & dealerCode from request body header section.
| Environment | URL | API | Request Type |
|---|---|---|---|
| CERT/UAT | https://{base_url}/external/services/dms/dqr | REST | POST |
| Production | https://{base_url}/external/services/dms/dqr | REST | POST |
DQR Inspections API
Request Body
GDD is only the mandatory parameter for the DQR API request. All other filters are optional and can be either set to null or left empty.
Expected Behavior:
- If no additional filters are provided (i.e., they are null or empty), the response should return the complete dataset for the specified GDD.
- If any optional filters are provided, the dataset should be filtered accordingly—first by GDD, then by the specified filter values.
| Name | Type | Description |
|---|---|---|
| dealershipInfo.GDDCode | String | GDD Code |
| filters.SAPDealerNumber | String | Primary SAP Number |
| filters.brandICECode | String | Brand ICE Code 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 |
| filters.region | Int | Dealer Region 1 : NAFTA 2 : LATAM 3 : WE 4 : APAC 5 : MEA 6 : ANZ |
| filters.checklistStatus | Int | Checklist Status 1 : Active 2 : Archived 3: Cancelled 4 : Deleted If not provided, all checklists are retrieved |
| filters.checklistType | String | Checklist Type TAI : Transport Arrival Inspection DAR : Dealer Arrival Report PDI : Predelivery Inspection TDR : Technical Delivery Report MTN : Maintenance Check WCK : Winter Check |
| filters.minDate | Date Time | Minimum Date |
| filters.maxDate | Date Time | Maximum Date |
| filters.pin | String | PIN/VIN (17 digit) |
| filters.pin9 | String | PIN/VIN (9 digit) |
| orderBy.parameter | Int | Paramter |
| orderBy.sort | String | Sort type (asc/dsc) |
| pagination.limit | Int | Page limit |
| pagination.skip | Int | Skip count |
JSON Request Body Sample
Download DQR JSON Sample BodyResponse Description
| Name | Type | Description |
|---|---|---|
| results.checklistId | Int | Checklist ID |
| results.checklistType | String | Checklist Type TAI : Transport Arrival Inspection DAR : Dealer Arrival Report PDI : Predelivery Inspection TDR : Technical Delivery Report MTN : Maintenance Check WCK : Winter Check |
| results.checklistStatus | Int | Checklist Status 1 : Active 2 : Archived 3: Cancelled 4 : Deleted |
| results.checklistLanguage | String | Checklist Language |
| results.checklistDirectUrl | String | Checklist Direct URL |
| results.score | Int | Score |
| results.qualityScore | Int | Quality Score |
| results.numberOfFault | Int | Number of Fault |
| results.brandIceCode | String | Brand ICE Code 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 |
| results.gddCode | String | GDD Code |
| results.checklistDate.OpeningDate | Date Time | Checklist Opening Date |
| results.checklistDate.lastStatusUpdate | Date Time | Checklist Last Status Update |
| results.sapDealerNumber | String | SAP Dealer Number |
| results.region | Int | Dealer Region 1 : NAFTA 2 : LATAM 3 : WE 4 : APAC 5 : MEA 6 : ANZ |
| results.vehicleInfo.productLine | String | Vehicle Product Line |
| results.vehicleInfo.model | String | Vehicle Model |
| results.vehicleInfo.pin | String | Vehicle PIN/VIN |
| results.vehicleInfo.pin9 | String | Vehicle PIN9/VIN9 |
| results.vehicleInfo.invoiceDate | Date Time | Vehicle InvoiceDate |
| results.vehicleInfo.warrantyDate | Date Time | Vehicle WarrantyDate |
| results.vehicleInfo.pin9 | String | Vehicle PIN9/VIN9 |
| totalCount | Int | Checklist Counter Total Count |
DQR Sample Response
Download DQR Sample ResponseResponse Codes
| Title | Reason | Status Code |
|---|---|---|
| Success Response | Success | 200 |
| Failure Response | - Bad Request | 400 |
| - Invalid JSON payload provided | 400 | |
| - Required request body missing error! | 400 | |
| - Validation failed - Validation failed | 400 | |
| - errors.message: "must have reqired property 'GDDCode'" | 400 | |
| - Validation failed - errors.message: "must be equal to one of the allowed values" (For invalid brandICECode) | 400 | |
| - Validation failed - erros.message: "must NOT have fewer than 1 characters" (For empty PIN/PIN9) | 400 | |
| Unauthorized Response | Access denied due to invalid credentials! | 401 |
| Forbidden | Forbidden | 403 |
| Internal Server Error | Internal service error | 500 |