Work Order

Detailed description of API:

Version & Updates

View Previous Revisions

Version	Revision Date	Revision History
1.0	December 2022	New Release
1.1	February 2023	Updated the Work Order Attributes
1.2	February 2023	Updated the Work Order Attributes with all required fields
1.3	February 2023	Updated the Work Order Attributes with the inspection information
1.4	February 2023	Added Work Order Historical Upload Section
1.5	February 2023	Updated workorder attribute hierarchy
1.6	04 April 2023	Uploaded prod samples, updated authentication and pre-requites
1.7	31st Aug 2023	Updated the Prod URLs, Pictorial representation of the data flow, Pre-requisites to access the API, Response Codes, API, Request Types. Moved Authentication Section to API and Connection Details, Sample Request and Response files to Sample Request and Responses section. Renamed Connection Details to API and Connection Details. Corrected Navigation Headings, WO Sample Request XML file.
1.8	13th Oct 2023	Added CNHi WO Validation rules
1.9	13th Mar 2025	Updated attributes file, JSON payload
1.10	19th Aug 2025	Removed existing filter from Work Order attributes sheet
1.11	23rd Sep 2025	Enhanced Work Order attributes sheet in the new format (No Data type or Attribute change, provided more details for better readability)
1.12	22nd Dec 2025	Updated the Work Order historical upload section with additional details, including STFP and Azure Event Hub approaches

Version	Revision Date	Revision History
1.13	21st Jan 2026	Updated both the methods of Historical data upload with more details

Overview

Workorder API is structured to capture the information about the critical attributes used in the work order at the time of creation in any DMS systems. Whereas this API, along with the vehicle parameters details collected from CNHI, will also include the additional details that are captured exclusively by the DMS in the Workorder like the details of the repair, technician, payment, and customer etc.

Please refer to diagram below for information on the data flow of this interface.

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
User within Ownership Group has accepted CNH's Data Acknowledgement (if located in NAFTA)

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

Work Order Validation

CNHi has 3 different pieces of validation to ensure DMS are configured to send corresponding details about the Dealer performing the repair.

UserID Matching within Work Order
a. The UserID that is used to authorize with & the UserID provided in the header of the Work Order payload, have to match

b. CNHi will not accept Work Orders that do not have corresponding UserIDs
DocumentID (i.e. Work Order ID) must have a unique value
a. This is a mandatory field, every work order needs to have a unique DocumentID because it is a primary key of Work Order

b. We are expecting this to be an alphanumeric value, i.e. something like 115070287
UserID & Corresponding Ownership Group Validation
a. Dealer Code's Ownership Group must match with the associated submitted UserID’s Ownership Group in the header of the Work Order payload

b. The provided Dealer Code (SAP Primary) and submitting UserID should belong to the same Ownership Group (OG)

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 DMSs who are building this interface are recommended to the use the REST API for greater simplicity.

Connection Details

Endpoints

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

Request Body

Although the Work Order API supports both JSON and XML, CNHi preferred format is JSON.

Sample JSON Payload

Download Workorder JSON Payload / Body

Sample XML Payload

Download Workorder XML Payload / Body

Work/Repair Order Attributes

Please refer to Tab 1 "Work Order Attributes List" to get all the work order attribute information. Tab 2, 3 and 4 provides attributes structure in tree format for better readability.

Download Work Order Attributes

Response Codes

Status Code	Message
200	Work Order uploaded successfully!
400	Please Provide DMS Name and Dealer Code
500	Internal Server Error
401	Access denied due to invalid UserID or Password.
403	Forbidden

Work Order Historical Upload

Note

Historical data should NOT be sent via Work Order API.
Only Closed Work Orders are expected to be sent to CNH as part of Historical Data.
Work Order Historical upload is only applicable for NAFTA region.

DMS/Dealer should send historical Workorder data to CNH DEP using any of the two following methods.

Method 1: 17 Files in CSV format

a. DMS/Dealer needs to send Work Order data segregated in the 17 CSV files.
i. Structure and format of 17 CSV files.
ii. 17 CSV files Sample Data.

b. To efficiently manage workorder data processing, DMS can segment work order records into periodic batches; such as quarterly (3 months) or semiannually (6 months) intervals and same work order data related information need to be available in 17 CSV files. Please ensure that no data is lost across any of the 17 files.

c. Attributes highlighted in the Green color font in each tab of "17 CSV" files are composite primary keys for the respective file/table. Those attributes are mandatory and should not be NULL.

d. Please follow the file nomenclature as shown in the information box below

File Nomenclature

WO_<DMSName><DealerName><primarySAPNumber><DataFromDate>to<DataToDate><File Transfer DateTime>.zip

Note: The <primarySAPNumber> field is optional if the DMS/Dealer is sending the data at the OG level by combining all locations data in a single file.

e. For a detailed breakdown of each data field and its attributes, please refer to the attributes sheet.

f. Please contact CNH support team by providing DMS Name, Dealer name and SAP Ownershipgroup number to setup SFTP.

Method 2: JSON Method

a. DMS can send the historical work orders in JSON format through azure EventHub.

b. Payload structure remains same as the API request payload structure. Sample JSON Workorder Payload

c. DMS has to set the partition key for each Event/Work Order Payload. Partition key should be "<dealercode><workordernumber>".
Please refer the sample C# code below for your reference. However DMS can choose the any other langauge as per their convenience.

Sample C# code to send Work Orders to Event Hub
  var producerClient = new EventHubProducerClient("CONNECTION_STRING", "EVENTHUB_NAME");

  var batchOptions = new CreateBatchOptions
  {
      PartitionKey = "<dealercode><workordernumber>"
  };

  using EventDataBatch eventBatch = await producerClient.CreateBatchAsync(batchOptions);
  var payloadjson = "Work Order Json";
  var data = new EventData(Encoding.UTF8.GetBytes(payloadjson));
  data.Properties.Add("EventType", "WorkOrder");

  var response = eventBatch.TryAdd(data);
  if(response == true) // Payload size is less than 1 MB
  {
   await producerClient.SendAsync(eventBatch);
  }
  else // Payload size is greater than 1 MB
  {
      //Add to ZIP file to post through SFTP later.
  }

d. If the size of the payload exceeds 1 MB, the "TryAdd" method as shown in the above code snippet will give "FALSE" response. DMS/Dealer must store the failed payload in the JSON file format, ZIP all such JSON payload files together and transfer them via SFTP.

e. Please follow the file nomenclature as shown in the information box below for posting the files via SFTP.

File Nomenclature

f. For a detailed breakdown of each data field and its attributes, please refer to the attributes sheet.

g. Please contact CNH support team for EventHub and SFTP connection details.

Version & Updates​

Overview​

Work Order Validation​

API Format​

Connection Details​

Endpoints​

Request Body​

Sample JSON Payload​

Sample XML Payload​

Work/Repair Order Attributes​

Response Codes​

Work Order Historical Upload​