OE Service Schedule from VIN
OE service schedule including detailed work actions, vehicle positions, times and parts requirements, with comprehensive coverage of all major manufacturers except Porsche, Tesla and most Chinese brands.
Note - this is an asynchronous API which provides several options for receiving the data. Please read our article Working with Asynchronous API Methods before planning your integration.
Key Features
VIN Lookup
VIN lookup for multi-country compatibility
Service Intervals
Schedule of normal services including detailed breakdown.
Extra Services
Schedule of extra service items based on time or mileage (e.g. timing belt)
OE Times
OE recommended work times for accurate invoicing
Positions & Tasks
Detailed breakdown of vehicle positions and tasks for each service.
Parts Required
Detailed breakdown of required service parts, numbers, attributes
Sample Response
V2
Documentation
Introduction
OE service schedule data including detailed work actions, times and parts requirements, with comprehensive coverage.
Header
When making calls to our API, include the following header:
x-api-key:your-api-key-here
Example Request
https://api.oneautoapi.com/oneauto/oeserviceschedulefromvin?vehicle_identification_number=ABCDE123456F78910&callback_url=https://webhookexample/l235o5abcde6f/receiver&return_data_in_callback=true
Example Sandbox Request
https://sandbox.oneautoapi.com/oneauto/oeserviceschedulefromvin?vehicle_identification_number=ABCDE123456F78910&callback_url=https://webhookexample/l235o5abcde6f/receiver&return_data_in_callback=true
Request Parameters
vehicle_identification_number
mandatory, string, e.g. ABCDE123456F78910
Vehicle identification number (VIN).
callback_url
optional, string, e.g. https://webhookexample/l235o5abcde6f/receiver
The callback URL
return_data_in_callback
optional, string, e.g. true
Whether the callback should contain the data from the result.
Sample Response
{
"success": true,
"result": {
"vehicle_identification_number": "ABCDE123456F78910",
"normal_services": [
{
"service_id": "SID1001",
"service_interval_desc": "every 30000 km or 12 months",
"service_months": 12,
"service_kms": 30000,
"service_miles": 18641,
"service_description": "Engine Oil, Filter, interior air, Oil Filter, Sealing Plug, oil sump",
"service_time_hours": 1,
"service_tasks": [
{
"task_id": "TID1001",
"task_description": "Outstanding campaigns and recalls",
"task_action": "Check",
"vehicle_position": "Vehicle On Floor"
}
],
"service_parts": [
{
"part_number": "F026407231",
"part_desc": "Oil Filter",
"supplier_id": "30",
"supplier_desc": "BOSCH",
"part_grade": null,
"oe_part_number": null,
"service_id": "SID1001",
"part_attributes": [
{
"name": "Outer diameter [mm]",
"value": "91"
}
]
}
]
}
],
"extra_services": [
{
"service_id": "SID1075",
"service_interval_desc": "every 300000 km,regardless of elapsed time",
"service_months": null,
"service_kms": 300000,
"service_miles": 186412,
"service_description": "Timing Chain",
"service_time_hours": 2.9,
"service_tasks": [
{
"task_id": "TID1001",
"task_description": "Timing chain(s)",
"task_action": "Renew",
"vehicle_position": "Engine Bay Operations"
}
],
"service_parts": []
}
]
}
}Response Parameters
success
e.g. true
Whether the api call was successful
vehicle_identification_number
e.g. ABCDE123456F78910
Vehicle identification number (VIN).
service_id
e.g. SID1001
ID for the service
service_interval_desc
e.g. every 30000 km or 12 months
Service interval description
service_months
e.g. 12
Service months.
service_kms
e.g. 30000
Service interval in kilometres
service_miles
e.g. 18641
Service miles.
service_description
e.g. Engine Oil, Filter, interior air, Oil Filter, Sealing Plug, oil sump
Service description
service_time_hours
e.g. 1
The OE time for the service.
task_id
e.g. TID1001
ID for the task.
task_description
e.g. Outstanding campaigns and recalls
Task description
task_action
e.g. Check
The required action
vehicle_position
e.g. Vehicle On Floor
The position of the vehicle while carrying out the task
part_number
e.g. F026407231
Supplier part number
part_desc
e.g. Oil Filter
Part description
supplier_id
e.g. 30
ID for the supplier
supplier_desc
e.g. BOSCH
Supplier name
part_grade
The grade of the part
oe_part_number
OE part number
service_id
e.g. SID1001
ID for the service
name
e.g. Outer diameter [mm]
Name of the attribute
value
e.g. 91
Attribute value.
service_id
e.g. SID1075
ID for the service
service_interval_desc
e.g. every 300000 km,regardless of elapsed time
Service interval description
service_months
Service months.
service_kms
e.g. 300000
Service interval in kilometres
service_miles
e.g. 186412
Service miles.
service_description
e.g. Timing Chain
Service description
service_time_hours
e.g. 2.9
The OE time for the service.
task_id
e.g. TID1001
ID for the task.
task_description
e.g. Timing chain(s)
Task description
task_action
e.g. Renew
The required action
vehicle_position
e.g. Engine Bay Operations
The position of the vehicle while carrying out the task
Status Codes
200
success, chargeable
Request has been successfully received and a response has been sent.
202
accepted, non-chargeable
Request has been received and accepted for processing, but the action has not yet been completed.
204
no content, non-chargeable
Request has been successfully received but there is no content to return e.g. if an invalid VRM has been sent.
206
partial content, non-chargeable
Request has been successfully received but limited content is returned e.g. if an invalid VRM has been sent.
400
bad request, non-chargeable
Request was not received e.g. if any required parameters are missing.
403
forbidden, non-chargeable
Request was rejected e.g. if the API key is invalid or the service is not enabled.
429
too many requests, non-chargeable
API key rate limit/quota has been exceeded.
500
internal server error, non-chargeable
We are unable to process the request e.g. if the API is under extremely heavy load.
503
service unavailable, non-chargeable
Service is temporarily unavailable. Contact help@oneautoapi.com