Skip to main content

Dealer Equipment Inventory Stock

Detailed description of API:

Interface currently available for DMS development in:
  • NAFTA

Version & Updates

VersionRevision DateRevision History
1.019th Dec 2025New Release

Overview

The Dealer Equipment Inventory Stock API supports near-real-time ingestion of dealer equipment inventory data into the Salesforce platform via DEP. The current integration scope is limited to the NAFTA region.

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
  • 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

High-level Integration

  • DMS pushes request payload to DEP-Ext team
  • Data Sharing Agreement (DSA check) validation will be implemented by DEP-Ext team before accepting data sent by DMS/Dealer
  • DEP-Ext will receive the payload and will perform data validations requested by Salesforce team
  • DEP-Ext team will respond with return response status code & message to DMS

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.

Connection Details

CNHi provides two environments:

  • CERT / UAT
  • Production
EnvironmentURLAPIRequest Type
CERT/UAThttps://{base_url}/external/services/crm/equipment/inventoryRESTPOST
Productionhttps://{base_url}/external/services/crm/equipment/inventoryRESTPOST

Request Description

NameData TypeDescription / RemarksIs Mandatory?Sample Data
Source_Created_Date_timeStringTime when change occurred in DMS. It will be in ISO 8601 UTC format like YYYY-MM-DDThh:mm:ssZYes2022-08-06T14:36:00+02:00
SAP_OG_Dealer_CodeStringCNH SAP Ownership Group NumberYes102011
Brand_CodeStringBrand CodeYesCE
Model_CodeStringModel CodeYesSR210B
Stock_NumberStringStock NumberYesK014937
Serial_NumberStringVehicle Serial NumberYes
Vehicle_NumberStringVehicle Number NumberNo12323
Parent_Stock_NumberStringParent Stock NumberNoK014937
StatusString (List)StatusYesOrdered, Inventory, Robbed, Demo, Show, Rental, Pre-Sold, Sold, Invoiced, Transferred, Consignment
ConditionStringConditionYesNew, Used
Short_DescriptionStringShort DescriptionNoSKID STEER LOADER
Dealer_Location_CodeStringDealer Location CodeNo6
Model_YearString (4)Model YearNo2023 (YYYY)
Product_Level_1StringProduct_Level_1No100
Product_Level_2StringProduct_Level_2No101
Original_CostDecimalOriginal CostNo49182.16
Adjusted_CostDecimalAdjusted CostNo-1429.02
Total_CostDecimalTotal CostNo47753.14
Advertised_Retail_PriceDecimalAdvertised Retail PriceNo573047.00
Sold_Retail_PriceDecimalSold Retail PriceNo573047.00
Currency_CodeStringCurrency CodeYesUSD / CAD
Engine_HoursDecimalEngine HoursNo2491
Separator_HoursDecimalSeparator HoursNo2491
BalesDecimalBalesNo8.0
AcresDecimalAcresNo14.00
SpecificationsArrayThe structure of the 'Specifications' attribute may contain sub-attributes like Code, Description, Price, etc which are yet To Be Decided (TBD)NoSee Sample Payload

Sample Request Payload

{
"Source_Created_Date_time": "2022-08-06T14:36:00+02:00",
"SAP_OG_Dealer_Code": "102011",
"Brand_Code": "CE",
"Model_Code": "SR210B",
"Stock_Number": "K014937",
"Serial_Number": "SERXXXXXX",
"Vehicle_Number": "12323",
"Parent_Stock_Number": "K014937",
"Status": "Inventory",
"Condition": "New",
"Short_Description": "SKID STEER LOADER",
"Dealer_Location_Code": "6",
"Model_Year": "2023",
"Product_Level_1": "100",
"Product_Level_2": "101",
"Original_Cost": 49182.16,
"Adjusted_Cost": -1429.02,
"Total_Cost": 47753.14,
"Advertised_Retail_Price": 573047.00,
"Sold_Retail_Price": 573047.00,
"Currency_Code": "USD",
"Engine_Hours": 2491,
"Separator_Hours": 2491,
"Bales": 8.0,
"Acres": 14.00,
"Specifications": [
{
"Attribute1": "",
"Attribute2": "",
"AttributeN": ""
}
]
}

Note: The API request payload should be less than 900 KB in size

Response Codes

Status CodeMessage
200Equipment inventory payload uploaded successfully
400- Not null validation failed for the following attributes: Source_Created_Date_time, SAP_OG_Dealer_Code, Brand_Code, Model_Code, Stock_Number, Serial_Number, Status_Code, Condition, and Currency_Code
- Data validation (list check) failed for the following attributes: Status_code, Condition, and Currency_Code
401Access denied due to invalid credentials or missing/invalid subscription key
404Resource not found
429Rate limit is exceeded - You can make up to 500 requests per minute. Please wait before retrying.
500Internal Server Error - An unexpected issue occurred while processing the request, possibly due to backend services, dependencies, or infrastructure.
504Gateway Time-out